flutter_anchor library
Classes
- Anchor
- A widget that displays a pop-up overlay relative to its child.
- AnchorConfig
- Configuration for anchor behavior within the widget tree.
- AnchorController
- Manages the state of an Anchor
- AnchorData
- Provides the AnchorController to the overlay's content.
- AnchorGeometry
- Contains the geometric information of the anchored overlay.
- AnchorPoints
- A set of anchor points defining how an overlay is positioned
- AnchorTriggerMode
- How the overlay is triggered and its mode-specific configuration.
- ArrowData
- Data produced by ArrowMiddleware after positioning.
- ArrowMiddleware
- A middleware that calculates the position of an arrow element.
- AutoPlacementData
- Data produced by AutoPlacementMiddleware after positioning.
- AutoPlacementMiddleware
- A middleware that automatically chooses the best placement based on available space.
- AvailableSpaces
- Represents the available space around the child widget in all four directions.
- FlipData
- Data produced by FlipMiddleware after positioning.
- FlipMiddleware
- A middleware that flips the overlay to the opposite side if it overflows the viewport in its preferred direction.
- FocusTriggerMode
- How the overlay is triggered and its mode-specific configuration. Shows the overlay when focus is gained and hides when focus is lost.
- HoverTriggerMode
- How the overlay is triggered and its mode-specific configuration. Shows the anchor's overlay on mouse enter and hides on mouse exit.
- LongPressTriggerMode
- How the overlay is triggered and its mode-specific configuration. Shows the anchor's overlay when the user performs a long press.
- ManualTriggerMode
- How the overlay is triggered and its mode-specific configuration. The overlay is controlled exclusively via an AnchorController.
- MiddlewareUtils
- Utilities for working with positioning middlewares.
- OffsetData
- Data produced by OffsetMiddleware after positioning.
- OffsetMiddleware
- A middleware that applies a positional offset to the overlay.
- OffsetValue
- Represents an offset value that can be either a static double or a callback.
- PositioningConfig
- Holds all the necessary geometric information about the child (anchor), the overlay and the viewport.
-
PositioningMiddleware<
T> - The interface for a positioning middleware.
- PositioningPipeline
- Orchestrates the entire positioning calculation.
- PositionMetadata
- Holds metadata produced by middleware during positioning.
- PositionResult
- The result of running the positioning pipeline.
- PositionState
- Represents the state of a positioning calculation as it passes through the PositioningPipeline.
- RawAnchor
- A low-level widget that displays a pop-up overlay relative to its child.
- SecondaryTapTriggerMode
- How the overlay is triggered and its mode-specific configuration. Toggles the anchor's overlay visibility on secondary tap (right-click).
- ShiftData
- Data produced by ShiftMiddleware after positioning.
- ShiftMiddleware
- A middleware that adjusts the overlay's alignment along the cross-axis to prevent it from overflowing the viewport.
- SizeData
- Data produced by SizeMiddleware after positioning.
- SizeMiddleware
- A middleware that calculates the maximum available dimensions for the overlay to prevent it from overflowing the viewport.
- TapTriggerMode
- How the overlay is triggered and its mode-specific configuration. Toggles the anchor's overlay visibility on tap.
- VirtualReference
- Represents a virtual reference point or region for positioning overlays.
- VirtualReferenceData
- Data produced by VirtualReferenceMiddleware after positioning.
- VirtualReferenceMiddleware
- A middleware that positions the overlay at an absolute position using a VirtualReference.
Enums
- AnchorScrollBehavior
- Defines how the overlay responds to scrolling of ancestor scrollable widgets.
- Placement
- Represents where the overlay should be positioned relative to the child.
Typedefs
- OffsetValueCallback = double Function(PositionState state)
- A function that computes an offset value based on the current positioning state.
- RawAnchorHideRequestedCallback = void Function(VoidCallback hideOverlay)
- Signature for the callback used by RawAnchor.onHideRequested to intercept requests to hide the overlay.
- RawAnchorShowRequestedCallback = void Function(VoidCallback showOverlay)
- Signature for the callback used by RawAnchor.onShowRequested to intercept requests to show the overlay.
- VirtualReferenceCallback = Rect Function(PositionState state)
- A function that computes a virtual reference based on the current positioning state.