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.
See also:
- Inheritance
- Object
- Widget
- StatefulWidget
- Stepper
Constructors
- Stepper({Key key, List<Step> steps, StepperType type: StepperType.vertical, int currentStep: 0, ValueChanged<int> onStepTapped, VoidCallback onStepContinue, VoidCallback onStepCancel })
-
Creates a stepper from a list of steps.
Properties
- currentStep → int
-
The index into steps of the current step whose content is displayed.
read-only - onStepCancel → VoidCallback
-
The callback called when the 'cancel' button is tapped.
read-only - onStepContinue → VoidCallback
-
The callback called when the 'continue' button is tapped.
read-only - onStepTapped → ValueChanged<int>
-
The callback called when a step is tapped, with its index passed as an argument.
read-only - steps → List<Step>
-
The steps of the stepper whose titles, subtitles, icons always get shown.
read-only - 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.
read-only - hashCode → int
-
Get a hash code for this object.
read-only, inherited - key → Key
-
Controls how one widget replaces another widget in the tree.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
createState(
) → _StepperState -
Creates the mutable state for this widget at a given location in the tree.
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited -
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by toString.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited -
toStringShort(
) → String -
A short, textual description of this widget.
inherited