ZwapTutorialController class

Constructors

ZwapTutorialController({bool log = false, required List<ZwapTutorialStep> steps, ZwapBetweenStepCallback? betweenStepCallback, InsertOverlayCallback? insertOverlayCallback})

Properties

betweenStepCallback ZwapBetweenStepCallback?
This method will be called before pushin the new step
final
hashCode int
The hash code for this object.
no setterinherited
insertOverlayCallback InsertOverlayCallback?
Used to insert the given entry in the Overlay of context
getter/setter pair
log bool
If true some infos are printed in the console
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
steps List<ZwapTutorialStep>
Steps must be exactly the same lenght as the number of key generated with registerTutorialStep method
final

Methods

back({InsertOverlayCallback? insertOverlay}) Future
end() Future
forward({InsertOverlayCallback? insertOverlay}) Future
goToStep(int stepNumber, {bool reverse = false, InsertOverlayCallback? insertOverlay}) Future
Go to the given stepNumber step disposing the current step only if needed.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerTutorialStep(int stepNumber) GlobalKey<_ZwapTutorialOverlayWrapperState>
Return an unique global key and register this step
registerTutorialStepBackgroundRegion(int stepNumber) GlobalKey<State<StatefulWidget>>
registerTutorialStepBackgroundRegionFor(List<int> steps) GlobalKey<State<StatefulWidget>>
start({int? startFrom, InsertOverlayCallback? insertOverlay}) → void
If insertOverlay is not null will be used instead of insertOverlayCallback
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited