CleverStepper 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.

{@tool sample --template=stateful_widget_scaffold_center}

int _index = 0;

@override
Widget build(BuildContext context) {
  return CleverStepper(
    currentStep: _index,
    onStepCancel: () {
      if (_index > 0) {
        setState(() { _index -= 1; });
      }
    },
    onStepContinue: () {
      if (_index <= 0) {
        setState(() { _index += 1; });
      }
    },
    onStepTapped: (int index) {
      setState(() { _index = index; });
    },
    steps: <Step>[
      Step(
        title: const Text('Step 1 title'),
        content: Container(
          alignment: Alignment.centerLeft,
          child: const Text('Content for Step 1')
        ),
      ),
      const Step(
        title: Text('Step 2 title'),
        content: Text('Content for Step 2'),
      ),
    ],
  );
}

{@end-tool}

See also:

• Step
• material.io/archive/guidelines/components/steppers.html

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• CleverStepper

Constructors

CleverStepper({Key? key, required List<CleverStep> steps, ScrollPhysics? physics, CleverStepperType type = CleverStepperType.vertical, int currentStep = 0, ValueChanged<int>? onStepTapped, ValueChanged<int>? onStepLongPressed, dynamic onStepContinue({dynamic value})?, dynamic onStepCancel({dynamic value})?, CleverControlsWidgetBuilder? controlsBuilder, bool showTwoPane = false, Color activeCircleColor = Colors.green})

Creates a stepper from a list of steps.

const

Properties

activeCircleColor → Color

final

controlsBuilder → CleverControlsWidgetBuilder?

The callback for creating custom controls.

final

currentStep → int

The index into steps of the current step whose content is displayed.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onStepCancel → (dynamic Function({dynamic value})?)

The callback called when the 'cancel' button is tapped.

final

onStepContinue → (dynamic Function({dynamic value})?)

The callback called when the 'continue' button is tapped.

final

onStepLongPressed → ValueChanged<int>?

The callback called when a step is long pressed, with its index passed as an argument.

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 setter, inherited

showTwoPane → bool

final

steps → List<CleverStep>

The steps of the stepper whose titles, subtitles, icons always get shown.

final

type → CleverStepperType

The type of stepper that determines the layout. In the case of CleverStepperType.horizontal, the content of the current step is displayed underneath as opposed to the CleverStepperType.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<CleverStepper>

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}) → 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