AuiStepper class
A stepper widget that displays a sequence of steps with their states.
Supports both horizontal and vertical layouts, custom colors for each step state, and connector lines between steps.
Example:
AuiStepper(
steps: const [
AuiStep(title: 'Cart', state: AuiStepState.completed),
AuiStep(title: 'Shipping', state: AuiStepState.active),
AuiStep(title: 'Payment', subtitle: 'Optional'),
],
currentStep: 1,
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- AuiStepper
Constructors
-
AuiStepper({Key? key, required List<
AuiStep> steps, required int currentStep, StepperDirection direction = StepperDirection.horizontal, Color? activeColor, Color? completedColor, Color? errorColor, Color? inactiveColor, Color? connectorColor}) -
Creates an AuiStepper.
const
Properties
- activeColor → Color?
-
Fill color for the active step indicator circle.
Defaults to ColorScheme.primary if null.
final
- completedColor → Color?
-
Fill color for completed step indicator circles and completed connectors.
Defaults to ColorScheme.primary if null.
final
- connectorColor → Color?
-
Color of the connector lines between steps.
Completed segments use completedColor instead.
Defaults to
Colors.grey.shade300if null.final - currentStep → int
-
Index of the currently active step (0-based).
final
- direction → StepperDirection
-
Layout direction: horizontal (default) or vertical.
final
- errorColor → Color?
-
Fill color for the error step indicator circle.
Defaults to Colors.red if null.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inactiveColor → Color?
-
Border / text color for pending step indicator circles.
Defaults to Colors.grey if null.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
steps
→ List<
AuiStep> -
The list of steps to display.
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, 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