aligned_tooltip library
Tooltips that show any widget as their content, aligned to a target widget along any axis.
- AlignedTooltip shows its content in the closest Overlay.
- AlignedTooltipEntry shows its content where an enclosing AlignedTooltipArea decides, for example under an app bar.
- AlignedTooltipController shows and hides a tooltip programmatically.
The tooltip is placed on the AlignedTooltip.preferredDirection side of its target and falls back to the opposite side when there is not enough space.
Classes
- AlignedTooltip
- A widget to display a tooltip over target widget. The tooltip can be displayed on any axis of the widget and fallback to the opposite axis if the tooltip does cannot fit its content. The tooltip can will be dismissed by waiting a specified time or again tapping on the target widger or anywhere on the screen.
- AlignedTooltipArea
- Shows the tooltips of its AlignedTooltipEntry descendants in the widget tree instead of in an Overlay.
- AlignedTooltipController
- This controller provides basic controls over the Tooltip widget. It is just a shell class that is given functionality by the StatefulWidget. This idea was copied from a FocusNode whose attach method is called to give the focusNode the context and state of its parent.
- AlignedTooltipEntry
- A Tooltip widget that delegates to creation and use of the tooltip and skrim to the outer AlignedTooltipArea. This class is useless if not nested within a AlignedTooltipArea.
- AlignedTooltipInterface
- A widget to display a tooltip over target widget. The tooltip can be displayed on any axis of the widget and fallback to the opposite axis if the tooltip does cannot fit its content. The tooltip can will be dismissed by waiting a specified time or again tapping on the target widger or anywhere on the screen.
-
AlignedTooltipState<
T> - This is almost a one to one mapping to Tooltip's state except for the fact it is setup to handle two Tooltip cases. Abstract methods are replaced with implementations that are specific to the tooltip type.
- InheritedTooltipArea
-
Makes the
AlignedTooltipAreaStateof an AlignedTooltipArea available to its descendants. Use AlignedTooltipArea.of to retrieve it.
Enums
- TooltipStatus
- Whether a tooltip is shown or hidden.
Typedefs
- ContentBuilder = Widget Function(BuildContext context, Widget content)
-
Signature of a function that wraps the
contentof a tooltip. -
HideTooltip
= Future<
void> Function({bool immediately}) - Signature of AlignedTooltipController.hideTooltip.
-
ShowTooltip
= Future<
void> Function({bool autoClose, bool immediately}) - Signature of AlignedTooltipController.showTooltip.
- TooltipBuilder = Widget Function(BuildContext context, Widget tooltip, Widget scrim)
- The interface for a tooltip builder. This is useful when the user wants to insert the tooltip into a stack rather than an overlay