NiceTutorial class
Step-by-step tutorial overlay that highlights page elements.
NiceTutorial(
active: true,
steps: [
NiceTutorialStep(title: 'Welcome', description: 'Let us show you around!'),
NiceTutorialStep(title: 'Click here', description: 'Start with this button', targetKey: _btnKey),
],
onComplete: () => markTutorialDone(),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- NiceTutorial
- Available extensions
Constructors
-
NiceTutorial({Key? key, bool active = false, List<
NiceTutorialStep> steps = const [], VoidCallback? onComplete, VoidCallback? onSkip, void onStepChange(int step)?, String? skipLabel, String? nextLabel, String? prevLabel, String? doneLabel, Widget? child}) -
const
Properties
- active → bool
-
final
- child → Widget?
-
final
- doneLabel → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- nextLabel → String?
-
final
- onComplete → VoidCallback?
-
final
- onSkip → VoidCallback?
-
final
- onStepChange → void Function(int step)?
-
final
- prevLabel → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- skipLabel → String?
-
final
-
steps
→ List<
NiceTutorialStep> -
final
Methods
-
asFocusable(
{FocusNode? focusNode, bool autofocus = false}) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Mark this widget as focusable. -
asSemanticButton(
{String? label, VoidCallback? onTap}) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Mark this widget as a button for screen readers. -
asSemanticHeading(
String label) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Mark this widget as a heading for screen readers. -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< NiceTutorial> -
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
-
excludeFromSemantics(
) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Exclude this widget from the semantic tree. -
mergeSemantics(
) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Merge semantics of child widgets. -
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
-
withSemanticLabel(
String label) → Widget -
Available on Widget, provided by the NiceAccessibilityExtension extension
Add a semantic label to this widget.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited