SafaehOnboarding class
A reusable onboarding shell with six complete visual directions.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SafaehOnboarding
Constructors
-
SafaehOnboarding({Key? key, required List<
SafaehOnboardingStep> steps, SafaehOnboardingDesign design = SafaehOnboardingDesign.zen, int initialStep = 0, SafaehOnboardingLabels labels = const SafaehOnboardingLabels(), SafaehOnboardingHostActions actions = const SafaehOnboardingHostActions(), SafaehOnboardingControlPlacement controlPlacement = SafaehOnboardingControlPlacement.top, SafaehOnboardingSkipPlacement skipPlacement = SafaehOnboardingSkipPlacement.topEnd, double? contentMaxWidth, ValueChanged<int> ? onStepChanged, SafaehOnboardingBackgroundBuilder? backgroundBuilder, bool showSkip = false, bool showTopBar = true, bool showTracker = true, SafaehOnboardingTrackerStyle trackerStyle = SafaehOnboardingTrackerStyle.design, bool showActions = true}) -
const
Properties
- actions → SafaehOnboardingHostActions
-
final
- backgroundBuilder → SafaehOnboardingBackgroundBuilder?
-
final
- contentMaxWidth → double?
-
Optional max width for the tracker and action chrome on wide screens.
The background remains full-bleed; null preserves the original layout.
final
- controlPlacement → SafaehOnboardingControlPlacement
-
final
- design → SafaehOnboardingDesign
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialStep → int
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- labels → SafaehOnboardingLabels
-
final
-
onStepChanged
→ ValueChanged<
int> ? -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showActions → bool
-
final
- showSkip → bool
-
final
- showTopBar → bool
-
final
- showTracker → bool
-
final
- skipPlacement → SafaehOnboardingSkipPlacement
-
final
-
steps
→ List<
SafaehOnboardingStep> -
final
- trackerStyle → SafaehOnboardingTrackerStyle
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SafaehOnboarding> -
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