FPopover class
A popover displays rich content in a portal that is aligned to a target.
See:
- https://forui.dev/docs/overlay/popover for working examples.
- FPopoverController for controlling a popover.
- FPopoverStyle for customizing a popover's appearance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FPopover
Constructors
-
FPopover({required FPopoverController? controller, required ValueWidgetBuilder<
FPopoverStyle> followerBuilder, required Widget target, FPopoverStyle? style, Offset shift(Size, FPortalTarget, FPortalFollower) = FPortalFollowerShift.flip, bool hideOnTapOutside = true, bool ignoreDirectionalPadding = true, String? semanticLabel, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool> ? onFocusChange, Alignment? followerAnchor, Alignment? targetAnchor, Key? key}) - Creates a popover that only shows the follower when the controller is manually toggled.
-
FPopover.tappable({required ValueWidgetBuilder<
FPopoverStyle> followerBuilder, required Widget target, FPopoverController? controller, FPopoverStyle? style, Offset shift(Size, FPortalTarget, FPortalFollower) = FPortalFollowerShift.flip, bool hideOnTapOutside = true, bool ignoreDirectionalPadding = true, String? semanticLabel, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool> ? onFocusChange, Alignment? followerAnchor, Alignment? targetAnchor, Key? key}) -
Creates a popover that is automatically shown when the
target
is tapped.
Properties
- autofocus → bool
-
True if the follower will be selected as the initial focus when no other node in its scope is currently focused.
final
- controller → FPopoverController?
-
The controller that shows and hides the follower. It initially hides the follower.
final
- focusNode → FocusNode?
-
An optional focus node to use as the focus node for the follower.
final
- followerAnchor → Alignment
-
The anchor of the follower to which the targetAnchor is aligned to.
final
-
followerBuilder
→ ValueWidgetBuilder<
FPopoverStyle> -
The follower builder. The child passed to followerBuilder will always be null.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideOnTapOutside → bool
-
True if the popover is hidden when tapped outside of it. Defaults to true.
final
- ignoreDirectionalPadding → bool
-
True if the follower should ignore the cross-axis padding of the anchor when aligning to it. Defaults to true.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onFocusChange
→ ValueChanged<
bool> ? -
Handler called when the focus changes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The follower's semantic label used by accessibility frameworks.
final
- shift → Offset Function(Size, FPortalTarget, FPortalFollower)
-
The shifting strategy used to shift a follower when it overflows out of the viewport. Defaults to
FPortalFollowerShift.flip.
final
- style → FPopoverStyle?
-
The popover's style.
final
- target → Widget
-
The target.
final
- targetAnchor → Alignment
-
The anchor of the target to which the followerAnchor is aligned to.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< FPopover> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited