ZwapTooltip class

Inheritance

Constructors

ZwapTooltip({required String? message, required Widget child, double decorationTranslation = 0, TextStyle? style, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 12, vertical: 7), @Deprecated("Use [tooltipAlignment] instead") TooltipPosition? position, @Deprecated("Use [offset] instead") Offset? transationOffset, Offset offset = Offset.zero, Alignment tooltipAlignment = Alignment.bottomCenter, Duration animationDuration = const Duration(milliseconds: 200), bool showTooltip = true, Duration delay = Duration.zero, Duration? disappearAfter = const Duration(seconds: 5), bool simple = false, Color? borderColor, Color? backgroundColor, double radius = 14, Key? key})
Show a customized tooltip message when user hover this widget with mouse
const
ZwapTooltip.builder({required Widget builder(BuildContext)?, required Widget child, double decorationTranslation = 0, TextStyle? style, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 12, vertical: 7), @Deprecated("Use [tooltipAlignment] instead") TooltipPosition? position, @Deprecated("Use [offset] instead") Offset? transationOffset, Offset offset = Offset.zero, Alignment tooltipAlignment = Alignment.bottomCenter, Duration animationDuration = const Duration(milliseconds: 200), bool showTooltip = true, Duration delay = Duration.zero, Duration? disappearAfter = const Duration(seconds: 5), bool simple = false, Color? borderColor, Color? backgroundColor, double radius = 14, Key? key})
Show a customized tooltip message when user hover this widget with mouse
const

Properties

animationDuration → Duration
  • left border if position is TooltipPosition.rigth
    • final
    backgroundColor → Color?
    The color of the background
    final
    borderColor → Color?
    The color of the borders
    final
    builder → (Widget Function(BuildContext)?)
    If provided the returned widget is placed inside tooltip instead of the message string
    final
    child → Widget
    final
    decorationTranslation → double
    Use this to move the arrow decoration of the tooltip.
    final
    delay → Duration
    ZwapTooltip will wait the mouse to be hovering the widget for at least this time before showing tooltip
    final
    disappearAfter → Duration?
    ZwapTooltip will use this duration as the maximum time an overlay can be showed
    final
    hashCode → int
    The hash code for this object.
    no setterinherited
    key → Key?
    Controls how one widget replaces another widget in the tree.
    finalinherited
    message → String?
    Message showed inside tooltip overlay
    final
    offset → Offset
    Use this argument to move the overlay around of a custom amount
    final
    padding → EdgeInsets
    Padding applied to overlay content
    final
    position → TooltipPosition?
    The tooltip position relative to the child provided
    final
    radius → double
    The radius of the borders and the decoration
    final
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    showTooltip → bool
    You can deactivate the tooltip visualization simply setting showTooltip to false
    final
    simple → bool
    If true no edges will have the decoration, so decorationTranslation and position will have no effect
    final
    style → TextStyle?
    message text style
    final
    tooltipAlignment → Alignment
    The alignment of the tooltip overlay relative to the child provided
    final
    transationOffset → Offset?
    Use this argument to move the overlay around
    final

    Methods

    createElement() → StatefulElement
    Creates a StatefulElement to manage this widget's location in the tree.
    inherited
    createState() → State<ZwapTooltip>
    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.
    inherited
    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

    Static Properties

    globalCorrectPosition ↔ Offset
    Useful when the whole app is wrapped inside a widget that make Overlay.of(context) have different size from the screen size
    getter/setter pair