GuideItem class

Constructors

GuideItem.new({required String description, GlobalKey<State<StatefulWidget>>? toGuideKey, Rect? toGuideRect, DescriptionPosition position = DescriptionPosition.auto, TextStyle descriptionStyle = const TextStyle(), EdgeInsets padding = EdgeInsets.zero, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(4)), double textInterval = 4})

Properties

borderRadius ↔ BorderRadius
Rounded corners for the guidance area
getter/setter pair
description ↔ String
Description for single feature item
getter/setter pair
descriptionStyle ↔ TextStyle
Style for the guidance text
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
padding ↔ EdgeInsets
Padding inside the guidance area
getter/setter pair
position ↔ DescriptionPosition
Enumeration for the position of the text hint, includes the following: screenCenter: Center of the screen widgetTopCenter: Centered at the top of the target area widgetTopFit: Top of the target area with adaptive fitting widgetBottomCenter: Centered at the bottom of the target area widgetBottomFit: Bottom of the target area with adaptive fitting auto: Automatically determined based on the position of your component and the dimensions of the text
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textInterval ↔ double
The interval between description and guidance area.
getter/setter pair
toGuideKey ↔ GlobalKey<State<StatefulWidget>>?
The key of the widget to be highlighted for guidance, used to calculate position (or you can use a fixed Rect to define the position)
getter/setter pair
toGuideRect ↔ Rect?
The Rect that defines the target position for the guidance
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited