IconStepper class

In general, the stepper widgets help you to show or collect information from users using organized steps. The IconStepper is a simple to use icon stepper widget, wherein each icon defines a step. Hence, the total number of icons represents the total number of available steps.

Inheritance

Constructors

IconStepper({List<Icon>? icons, bool enableNextPreviousButtons = true, bool enableStepTapping = true, Icon? previousButtonIcon, Icon? nextButtonIcon, OnStepReached? onStepReached, Axis direction = Axis.horizontal, Color? stepColor, double stepPadding = 1.0, Color? activeStepColor, Color? activeStepBorderColor, double activeStepBorderWidth = 0.5, double activeStepBorderPadding = 5.0, Color? lineColor, double lineLength = 50.0, double lineDotRadius = 1.0, double stepRadius = 24.0, Curve stepReachedAnimationEffect = Curves.bounceOut, Duration stepReachedAnimationDuration = const Duration(seconds: 1), bool steppingEnabled = true, bool scrollingDisabled = false, int activeStep = 0, AlignmentGeometry alignment = Alignment.center})
Creates an IconStepper widget.

Properties

activeStep int
The currently active step.
final
activeStepBorderColor Color?
The border color of a step when it is reached.
final
activeStepBorderPadding double
Determines how far away the border should be drawn from the step when it is reached.
final
activeStepBorderWidth double
The border width of the active step.
final
activeStepColor Color?
The color of a step when it is reached.
final
alignment AlignmentGeometry
Specifies the alignment of IconStepper widget.
final
direction Axis
Whether to show the steps horizontally or vertically. Note: Ensure horizontal stepper goes inside a column and vertical goes inside a row.
final
enableNextPreviousButtons bool
Whether to enable or disable the next and previous buttons.
final
enableStepTapping bool
Whether to allow tapping a step to move to that step or not.
final
hashCode int
The hash code for this object.
no setterinherited
icons List<Icon>?
Each icon defines a step. Hence, total number of icons determines the total number of steps.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lineColor Color?
The color of the line that separates the steps.
final
lineDotRadius double
The radius of individual dot within the line that separates the steps.
final
lineLength double
The length of the line that separates the steps.
final
nextButtonIcon Icon?
Icon to be used for the next button.
final
onStepReached → OnStepReached?
Determines what should happen when a step is reached. This callback provides the index of the step that was reached.
final
previousButtonIcon Icon?
Icon to be used for the previous button.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollingDisabled bool
Whether the scrolling is disabled or not.
final
stepColor Color?
The color of the step when it is not reached.
final
stepPadding double
The amount of padding inside a step.
final
steppingEnabled bool
Whether the stepping is enabled or disabled.
final
stepRadius double
The radius of a step.
final
stepReachedAnimationDuration Duration
The duration of the animation effect to show when a step is reached.
final
stepReachedAnimationEffect Curve
The animation effect to show when a step is reached.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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}) 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