Step Progress Indicator

GitHub: SandroMaglione Twitter: SandroMaglione

Open source Flutter package, bar indicator made of a series of selected and unselected steps.

Made by Sandro Maglione, check out his personal official website sandromaglione.com

Check out the full step_progress_indicator tutorial

See the full example here

Check out the official dartdoc for the package here

Screenshots

Install and import the package. Then just customize its parameters.

dependencies:
  flutter:
    sdk: flutter
  step_progress_indicator: ^0.2.3+6

HorizontalVertical
Horizontal indicator screenVertical indicator screen
Circular1Circular2
Circular step progress indicator screen 1Circular step progress indicator screen 2
Circular step progress indicator screen 1Circular step progress indicator example 1

Examples

StepProgressIndicator - Example 1

Step Progress Indicator - Example 1

StepProgressIndicator(
    totalSteps: 10,
)

StepProgressIndicator - Example 2

Step Progress Indicator - Example 2

StepProgressIndicator(
    totalSteps: 10,
    currentStep: 6,
    selectedColor: Colors.red,
    unselectedColor: Colors.yellow,
)

StepProgressIndicator - Example 3

Step Progress Indicator - Example 3

StepProgressIndicator(
    totalSteps: 20,
    currentStep: 6,
    size: 10,
    selectedColor: Colors.purple,
    unselectedColor: Colors.transparent,
)

StepProgressIndicator - Example 4

Step Progress Indicator - Example 4

StepProgressIndicator(
    totalSteps: 15,
    currentStep: 12,
    size: 20,
    selectedColor: Colors.amber,
    unselectedColor: Colors.black,
    roundedEdges: Radius.circular(10),
),

StepProgressIndicator - Example 5

Step Progress Indicator - Example 5

StepProgressIndicator(
    totalSteps: 100,
    currentStep: 32,
    size: 8,
    padding: 0,
    selectedColor: Colors.yellow,
    unselectedColor: Colors.cyan,
    roundedEdges: Radius.circular(10),
),

StepProgressIndicator - Example 6

Step Progress Indicator - Example 6

StepProgressIndicator(
    totalSteps: 12,
    currentStep: 4,
    padding: 6.0,
    size: 12,
    progressDirection: TextDirection.rtl,
    selectedColor: Colors.green,
    unselectedColor: Colors.black12,
)

StepProgressIndicator - Example 7

Step Progress Indicator - Example 7

StepProgressIndicator(
    totalSteps: 5,
    padding: 20.0,
    size: 20,
    customColor: (index) => index == 0
        ? Colors.redAccent
        : index == 4 ? Colors.blueAccent : Colors.deepOrange,
)

StepProgressIndicator - Example 8

Step Progress Indicator - Example 8

StepProgressIndicator(
    totalSteps: 6,
    currentStep: 4,
    size: 36,
    selectedColor: Colors.black,
    unselectedColor: Colors.grey[200],
    customStep: (index, color, _) => color == Colors.black
        ? Container(
            color: color,
            child: Icon(
            Icons.check,
            color: Colors.white,
            ),
        )
        : Container(
            color: color,
            child: Icon(
            Icons.remove,
            ),
        ),
)

StepProgressIndicator - Example 9

Step Progress Indicator - Example 9

StepProgressIndicator(
    totalSteps: 10,
    currentStep: 7,
    selectedColor: Colors.pink,
    unselectedColor: Colors.amber,
    customSize: (index) => (index + 1) * 10.0,
)

CircularStepProgressIndicator - Example 1

Circular Step Progress Indicator - Example 1

Row(
    mainAxisAlignment: MainAxisAlignment.spaceEvenly,
    children: <Widget>[
        CircularStepProgressIndicator(
            totalSteps: 10,
            currentStep: 6,
            width: 100,
        ),
        CircularStepProgressIndicator(
            totalSteps: 12,
            currentStep: 6,
            selectedColor: Colors.redAccent,
            unselectedColor: Colors.grey[200],
            selectedStepSize: 10.0,
            width: 100,
        ),
        CircularStepProgressIndicator(
            totalSteps: 20,
            currentStep: 6,
            padding: math.pi / 15,
            selectedColor: Colors.cyan,
            unselectedColor: Colors.yellowAccent,
            selectedStepSize: 3.0,
            unselectedStepSize: 9.0,
            width: 100,
        ),
    ],
)

CircularStepProgressIndicator - Example 2

Circular Step Progress Indicator - Example 2

Row(
    mainAxisAlignment: MainAxisAlignment.spaceEvenly,
    children: <Widget>[
    CircularStepProgressIndicator(
        totalSteps: 20,
        currentStep: 12,
        stepSize: 20,
        selectedColor: Colors.red,
        unselectedColor: Colors.purple[400],
        padding: math.pi / 80,
        width: 150,
        height: 150,
        startingAngle: -math.pi * 2 / 3,
        arcSize: math.pi * 2 / 3 * 2,
    ),
    CircularStepProgressIndicator(
        totalSteps: 100,
        currentStep: 74,
        stepSize: 10,
        selectedColor: Colors.greenAccent,
        unselectedColor: Colors.grey[200],
        padding: 0,
        width: 150,
        height: 150,
        selectedStepSize: 15,
    ),
    ],
),

CircularStepProgressIndicator - Example 3

Circular Step Progress Indicator - Example 3

CircularStepProgressIndicator(
    totalSteps: 100,
    currentStep: 72,
    selectedColor: Colors.yellow,
    unselectedColor: Colors.lightBlue,
    padding: 0,
    width: 100,
    child: Icon(
        Icons.tag_faces,
        color: Colors.red,
        size: 84,
    ),
)

CircularStepProgressIndicator - Example 4

Circular Step Progress Indicator - Example 4

CircularStepProgressIndicator(
    totalSteps: 20,
    stepSize: 20,
    customColor: (index) => index % 3 == 0
        ? Colors.deepPurple
        : index % 2 == 0
            ? Colors.deepOrange
            : Colors.grey[100],
    width: 250,
)

StepProgressIndicator Parameters

ParameterTypeDescriptionDefault
totalStepsintTotal number of step of the complete indicator.@required
currentStepintNumber of steps to underline, all the steps with index <= currentStep will have Color equal to selectedColor.0
customStep(int, Color, double)WidgetDefines a custom Widget to display at each step, given the current step index, the Color, which could be defined with selectedColor and unselectedColor or using customColor, and its size, which could be defined using size, selectedSize, unselectedSize, or customSize.-
onTap(int)void Function()Defines onTap function given index of the pressed step.-
customColor(int)ColorAssign a custom Color for each step.-
customSize(int)doubleAssign a custom size for each step.-
selectedColorColorColor of the selected steps.Colors.blue
unselectedColorColorColor of the unselected steps.Colors.grey
directionAxisDefines if indicator is horizontal or vertical.Axis.horizontal
progressDirectionTextDirectionDefines if steps grow from left-to-right / top-to-bottom TextDirection.ltr or right-to-left / bottom-to-top TextDirection.rtl.TextDirection.ltr
sizedoubleSize of the indicator (height if direction is Axis.horizontal, width if Axis.vertical).4.0
paddingdoubleSpacing, left-right if horizontal, top-bottom if vertical, of each step.2.0
fallbackLengthdoubleLength of the progress indicator in case the main axis (based on direction attribute) has no size limit i.e. double.infinity.100.0
selectedSizedoubleSpecify a custom size for selected steps.-
unselectedSizedoubleSpecify a custom size for unselected steps.-
roundedEdgesRadiusAdd rounded edge corners to first and last step.-

CircularStepProgressIndicator Parameters

ParameterTypeDescriptionDefault
totalStepsintTotal number of step of the complete indicator.@required
currentStepintNumber of steps to underline, all the steps with index <= currentStep will have Color equal to selectedColor.0
childWidgetWidget child contained inside the indicator.-
selectedColorColorColor of the selected steps.Colors.blue
unselectedColorColorColor of the unselected steps.Colors.grey
customColor(int)ColorAssign a custom Color for each step.-
customStepSize(int)doubleAssign a custom size for each step.-
selectedStepSizedoubleSpecify a custom size for selected steps.-
unselectedStepSizedoubleSpecify a custom size for unselected steps.-
circularDirectionTextDirectionDefines if steps grow clockwise (CircularDirection.clockwise) or counterclockwise (CircularDirection.counterclockwise)CircularDirection.clockwise
stepSizedoubleSize of the each step of the indicator.6.0
heightdoubleHeight of the indicator's container.-
widthdoubleWidth of the indicator's container.-
paddingdoubleSpacing between each step.math.pi / 20
startingAngledoubleAngle in which is placed the starting point of the indicator.0
arcSizedoubleAngle in radiants which represents the size of the arc used to display the indicator.math.pi * 2
fallbackHeightdoubleHeight of the indicator's container in case the parent height has no size limit i.e. double.infinity.100.0
fallbackWidthdoubleWidth of the indicator's container in case the parent width has no size limit i.e. double.infinity.100.0

Roadmap

I am always open for suggestions and ideas for possible improvements or fixes.

Feel free to open a Pull request if you would like to contribute to the project.

If you would like to have a new feature implemented, just write a new issue.

Versioning

  • v0.2.3+6 - 20 May 2020
  • v0.2.2+5 - 26 April 2020
  • v0.2.1+4 - 25 February 2020
  • v0.2.0+3 - 24 February 2020
  • v0.1.1+2 - 24 January 2020
  • v0.1.0+1 - 23 January 2020

License

MIT License, see the LICENSE.md file for details.

Libraries

step_progress_indicator