FeaturesTour class

The main widget for displaying a guided tour for a specific widget.

Inheritance

Constructors

FeaturesTour({required FeaturesTourController controller, required double index, required Widget child, Key? key, double? nextIndex, Duration nextIndexTimeout = const Duration(seconds: 3), ChildConfig? childConfig, Widget introduce = const SizedBox.shrink(), IntroduceConfig? introduceConfig, NextConfig? nextConfig, SkipConfig? skipConfig, DoneConfig? doneConfig, bool enabled = true, FutureOr<void> onBeforeIntroduce()?, FutureOr<void> onAfterIntroduce(IntroduceResult introduceResult)?})
Creates a FeaturesTour to display a guided tour for a specific widget.
const

Properties

child → Widget
The child widget wrapped by FeaturesTour.
final
childConfig → ChildConfig?
The configuration for the overlay widget displayed over the child. If null, the global configuration (ChildConfig.global) will be used.
final
controller → FeaturesTourController
The controller for the current page, which is responsible for managing the tour.
final
doneConfig → DoneConfig?
The configuration for the "Done" button. If null, the global configuration (DoneConfig.global) will be used.
final
enabled → bool
Determines whether this widget's actions are enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
index → double
A unique index used to order the tour steps. This value must not be duplicated.
final
introduce → Widget
The widget used to introduce this feature in the tour.
final
introduceConfig → IntroduceConfig?
The configuration for the introduce widget. If null, the global configuration (IntroduceConfig.global) will be used.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
nextConfig → NextConfig?
The configuration for the "Next" button. If null, the global configuration (NextConfig.global) will be used.
final
nextIndex → double?
Specifies the next index to start the tour. The plugin will wait for this index to appear or until nextIndexTimeout is reached. If set to null, the tour will proceed in the natural order of the index.
final
nextIndexTimeout → Duration
The timeout duration for waiting on nextIndex. The default is 3 seconds.
final
onAfterIntroduce → FutureOr<void> Function(IntroduceResult introduceResult)?
A callback that is triggered after the introduce widget is shown.
final
onBeforeIntroduce → FutureOr<void> Function()?
A callback that is triggered before the introduce widget is shown.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipConfig → SkipConfig?
The configuration for the "Skip" button. If null, the global configuration (SkipConfig.global) will be used.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FeaturesTour>
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

Static Methods

removeAll({bool markAsShowed = true}) → Future<void>
Removes all controllers for all pages.
setGlobalConfig({bool? force, String? preferencePrefix, ChildConfig? childConfig, IntroduceConfig? introduceConfig, PreDialogConfig? preDialogConfig, SkipConfig? skipConfig, NextConfig? nextConfig, DoneConfig? doneConfig, bool? debugLog}) → void
Sets the global configs.
setTestingLogger(Logger? logger) → void
Sets a global logger for all controllers.