TTourStep class
A single step in an onboarding or feature walkthrough TTour.
Constructors
-
TTourStep({required GlobalKey<
State< targetKey, required String title, required String description, IconData? icon, TTourPlacement placement = TTourPlacement.auto, EdgeInsets spotlightPadding = const EdgeInsets.all(8.0), BorderRadius spotlightBorderRadius = const BorderRadius.all(Radius.circular(8.0))})StatefulWidget> > -
const
Properties
- description → String
-
Explanatory description text guiding the user.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → IconData?
-
Optional icon shown in the card header.
final
- placement → TTourPlacement
-
Preferred placement for the popover card. Defaults to TTourPlacement.auto.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spotlightBorderRadius → BorderRadius
-
Border radius for the spotlight cutout. Defaults to 8.0.
final
- spotlightPadding → EdgeInsets
-
Padding around the spotlight cutout. Defaults to 8.0.
final
-
targetKey
→ GlobalKey<
State< StatefulWidget> > -
The global key of the widget to highlight with a spotlight cutout.
final
- title → String
-
Headline title for this tour step.
final
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