Stepper class
A material stepper widget that displays progress through a sequence of steps. Steppers are particularly useful in the case of forms where one step requires the completion of another one, or where multiple steps need to be completed in order to submit the whole form.
The widget is a flexible wrapper. A parent class should pass currentStep to this widget based on some logic triggered by the three callbacks that it provides.
link
To create a local project with this code sample, run:
flutter create --sample=material.Stepper.1 mysample
See also:
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- Stepper
Constructors
-
Stepper({Key? key, required List<
Step> steps, ScrollController? controller, ScrollPhysics? physics, StepperType type = StepperType.vertical, int currentStep = 0, ValueChanged<int> ? onStepTapped, VoidCallback? onStepContinue, VoidCallback? onStepCancel, ControlsWidgetBuilder? controlsBuilder, double? elevation, EdgeInsetsGeometry? margin, MaterialStateProperty<Color> ? connectorColor, double? connectorThickness, StepIconBuilder? stepIconBuilder, double? stepIconHeight, double? stepIconWidth, EdgeInsets? stepIconMargin, Clip clipBehavior = Clip.none}) -
Creates a stepper from a list of steps.
const
Properties
- clipBehavior → Clip
-
The Step.content will be clipped to this Clip type.
final
-
connectorColor
→ MaterialStateProperty<
Color> ? -
Customize connected lines colors.
final
- connectorThickness → double?
-
The thickness of the connecting lines.
final
- controller → ScrollController?
-
An object that can be used to control the position to which this scroll
view is scrolled.
final
- controlsBuilder → ControlsWidgetBuilder?
-
The callback for creating custom controls.
final
- currentStep → int
-
The index into steps of the current step whose content is displayed.
final
- elevation → double?
-
The elevation of this stepper's Material when type is StepperType.horizontal.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- margin → EdgeInsetsGeometry?
-
Custom margin on vertical stepper.
final
- onStepCancel → VoidCallback?
-
The callback called when the 'cancel' button is tapped.
final
- onStepContinue → VoidCallback?
-
The callback called when the 'continue' button is tapped.
final
-
onStepTapped
→ ValueChanged<
int> ? -
The callback called when a step is tapped, with its index passed as
an argument.
final
- physics → ScrollPhysics?
-
How the stepper's scroll view should respond to user input.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stepIconBuilder → StepIconBuilder?
-
Callback for creating custom icons for the steps.
final
- stepIconHeight → double?
-
Overrides the default step icon size height.
final
- stepIconMargin → EdgeInsets?
-
Overrides the default step icon margin.
final
- stepIconWidth → double?
-
Overrides the default step icon size width.
final
-
steps
→ List<
Step> -
The steps of the stepper whose titles, subtitles, icons always get shown.
final
- type → StepperType
-
The type of stepper that determines the layout. In the case of
StepperType.horizontal, the content of the current step is displayed
underneath as opposed to the StepperType.vertical case where it is
displayed in-between.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< Stepper> -
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