Search packages, repositories and app categories

universal_stepper cover
Package detailsv1.0.0+1

universal_stepper

Provides a universal stepper widget for Flutter. The widget can be used for building horizontal and vertical steppers.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
7
Likes
5
Pub points
160

Install package

flutter pub add universal_stepper

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A versatile Flutter package that offers a universal stepper widget, supporting both horizontal and vertical layouts. It simplifies the creation of step-by-step interfaces for forms, onboarding flows, or multi-stage processes across all major platforms. The widget is customizable and integrates seamlessly into existing Flutter applications. Designed for flexibility and ease of use, it enables developers to maintain consistent UI patterns with minimal code. Its cross-platform compatibility ensures uniform behavior on Android, iOS, Web, macOS, Windows, and Linux.

Use cases

  • Onboarding wizards
  • Multi-step form navigation
  • Checkout process design
  • Progress tracking interfaces
  • Setup wizards

Key features

  • Supports horizontal and vertical orientations
  • Cross-platform compatibility
  • Customizable styling
  • Simple API integration
  • Reusable step components

Suitable for

  • Developers building guided workflows
  • Teams needing consistent stepper UIs
  • Apps requiring multi-step user input
  • Design systems with reusable components
  • Cross-platform applications

Considerations

  • May require additional styling for complex themes
  • Limited built-in animation options
  • Best suited for linear step sequences
  • Not ideal for highly dynamic step logic
  • Depends on proper state management for step control

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

A simple package to build steppers with custom elements. You can set up your own body content, badges, and paths using indexed builders.

Vertical Stepper

To create a vertical stepper, set stepperDirection to Axis.vertical.

UniversalStepper(
  inverted: false,
  stepperDirection: Axis.vertical,
  elementBuilder: (context, index) {
    return Expanded(
      child: Container(
        padding: const EdgeInsets.only(left: 10, bottom: 15),
        child: ... // your element
      ),
    );
  },
  badgeBuilder: (context, index) {
    return Container(
      width: 30,
      padding: const EdgeInsets.all(6),
      decoration: const BoxDecoration(
        color: Colors.green,
        borderRadius: BorderRadius.all(Radius.circular(30)),
      ),
      child: const FittedBox(child: Icon(Icons.fastfood, color: Colors.white)),
    );
  },
  pathBuilder: (context, index) {
    return Container(
      color: index == stepperData.length - 1
          ? Colors.transparent
          : (index < currentStep ? Colors.green : Colors.grey),
      width: 4,
    );
  },
  subPathBuilder: (context, index) {
    return Container(
      color: index == stepperData.length - 1
          ? Colors.transparent
          : (index < currentStep ? Colors.green : Colors.grey),
      width: 4,
    );
  },
  elementCount: stepperData.length,
  badgePosition: StepperBadgePosition.start,
)

Here’s an example of what the result might look like:

Parameters

  • elementBuilder: A builder for the content of the stepper.

  • badgeBuilder: A builder for the badge.

  • badgePosition: Determines the alignment of the badge. Options include StepperBadgePosition.start, StepperBadgePosition.center, or StepperBadgePosition.end.

  • pathBuilder: A builder for the main path (e.g., a line, dotted line, etc.). This is the most commonly used path.

  • subPathBuilder: A builder for the secondary path, used when badgePosition is set to StepperBadgePosition.center. This path is displayed under the badge and allows you to control its visibility based on the active step.

  • elementCount: The number of elements in the stepper.

  • inverted: A flag to invert the position of the path and badge relative to the element. By default, this is false, and for vertical steppers, the path appears on the left. When set to true, the path appears on the right. For horizontal steppers, the path appears on the top and when set to true, the path appears on the bottom.

For example, if you set inverted to true and badgePosition to StepperBadgePosition.center, the result will look like this:

Horizontal Stepper

To create a horizontal stepper, set stepperDirection to Axis.horizontal.

Here’s an example of a horizontal stepper:

And here’s the inverted variant:

For full examples, check out the example app.

Categories

Source repository

Projects using this package

No data available yet.