TutorialSequence class
Orchestrates a multi-step onboarding tutorial by showing one SpotlightOverlay at a time for whatever step controller is currently on — composes SpotlightOverlay rather than reimplementing its highlight/callout logic; this widget is purely the step-advancing state machine around it.
Wrap the screen's content in this once; call controller.start(steps)
whenever the tutorial should begin (e.g. on first app launch).
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TutorialSequence
Constructors
- TutorialSequence({Key? key, required TutorialSequenceController controller, required Widget child, VoidCallback? onComplete, bool showSkip = true, String? skipLabel})
-
const
Properties
- child → Widget
-
final
- controller → TutorialSequenceController
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onComplete → VoidCallback?
-
Called once the sequence ends, however it ended (last step dismissed,
or TutorialSequenceController.skip called) — a good place to
persist "tutorial seen" so it doesn't show again.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showSkip → bool
-
Shows a "Skip" action in every step's overlay that ends the whole
sequence immediately via TutorialSequenceController.skip (ENH-48).
Set false to force the player through every step one at a time.
final
- skipLabel → String?
-
Label for the skip action, only shown when showSkip is true.
Defaults to
'tutorial_skip'.tr(BUG-94).final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TutorialSequence> -
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, int wrapWidth = 65}) → 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