TutorialAwareWidget class

A widget that automatically registers its key and context with the TutorialRepository.

This widget is used to wrap other widgets that need to be referenced in tutorials. It simplifies the process of registering keys and contexts for tutorial steps.

The TutorialAwareWidget will register:

If you want to use a previously created globalKey, you can hand it to the globalKey parameter, but do not use it in the key argument of the child widget, because this will throw an error (because then multiple widgets will be using the same key).

Example usage:

TutorialAwareWidget(
  tutorialKeyIDs: [ExampleTutorialID.floatingButtonKey],
  child: FloatingActionButton(
    onPressed: _incrementCounter,
    tooltip: 'Increment',
    child: const Icon(Icons.add),
  ),
)
Inheritance

Constructors

TutorialAwareWidget({GlobalKey<State<StatefulWidget>>? globalKey, List<TutorialID>? tutorialKeyIDs, List<TutorialID>? tutorialContextIDs, required Widget child})
Creates a TutorialAwareWidget.

Properties

child → Widget
The child widget to be wrapped by this TutorialAwareWidget.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tutorialContextIDs → List<TutorialID>?
The list of TutorialIDs to register the widget's BuildContext with.
final
tutorialKeyIDs → List<TutorialID>?
The list of TutorialIDs to register the widget's GlobalKey with.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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