GuideItem class

Constructors

GuideItem.new({Widget? descriptionWidget, GlobalKey<State<StatefulWidget>>? toGuideKey, Rect? toGuideRect, DescriptionPosition position = DescriptionPosition.auto, EdgeInsets padding = EdgeInsets.zero, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(4)), double descriptionInterval = 4})

Properties

borderRadius ↔ BorderRadius
Rounded corners for the guidance area
getter/setter pair
descriptionInterval ↔ double
The interval between description and guidance area.
getter/setter pair
descriptionWidget ↔ Widget?
Description widget for single feature item
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 alignTopLeft: Positions the content above the target area, aligned to the left side alignTopRight: Positions the content above the target area, aligned to the right side alignBottomLeft: Positions the content below the target area, aligned to the left side alignBottomRight: Positions the content below the target area, aligned to the right side 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
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