FlowConfiguration class
Configuration options for a multi-step flow
Constructors
- FlowConfiguration({bool validateOnTransition = false, bool autoAdvanceOnValidation = false, bool skipValidationForOptionalSteps = true, bool allowSkipAll = false, Duration defaultStepDuration = const Duration(minutes: 5), bool persistState = false, String? storageKey, Duration transitionDuration = const Duration(milliseconds: 300)})
-
Creates a new flow configuration with the given options
const
-
FlowConfiguration.fromJson(Map<
String, dynamic> json) -
Create from JSON map
factory
Properties
-
Whether to allow navigation back to previous steps
final
- allowSkipAll → bool
-
Whether to allow skipping the entire flow
final
- autoAdvanceOnValidation → bool
-
Whether to automatically advance to the next step when the current step is validated
final
- defaultStepDuration → Duration
-
Default duration for steps (used for timed steps)
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- persistState → bool
-
Whether to persist state between app restarts
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- skipValidationForOptionalSteps → bool
-
Whether to skip validation for optional steps
final
- storageKey → String?
-
Storage key to use for persisting state
final
- transitionDuration → Duration
-
Default step transition duration
final
- validateOnTransition → bool
-
Whether to validate steps on transition
final
Methods
-
copyWith(
{bool? validateOnTransition, bool? autoAdvanceOnValidation, bool? skipValidationForOptionalSteps, bool? allowSkipAll, Duration? defaultStepDuration, bool? persistState, String? storageKey, Duration? transitionDuration}) → FlowConfiguration - Creates a copy of this configuration with the given fields replaced
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Convert to JSON map
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override