PHPackages                             axn/laravel-stepper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. axn/laravel-stepper

ActiveLibrary[Utility & Helpers](/categories/utility)

axn/laravel-stepper
===================

Step by step Laravel 5 helper.

1.9.0(1mo ago)199621MITPHP

Since Aug 6Pushed 1mo ago3 watchersCompare

[ Source](https://github.com/AXN-Informatique/laravel-stepper)[ Packagist](https://packagist.org/packages/axn/laravel-stepper)[ Docs](https://github.com/AXN-Informatique/laravel-stepper)[ RSS](/packages/axn-laravel-stepper/feed)WikiDiscussions master Synced today

READMEChangelog (8)Dependencies (2)Versions (15)Used By (1)

Laravel Stepper
===============

[](#laravel-stepper)

Package that let you create a progress visualization tool step by step (stepper).

- **Author:** AXN Informatique
- **Website:**
- **License:** MIT license (see the license file)

---

- [Installation](#installation)
- [Usage](#usage)
- [Personalize the template](#personalize-the-template)
- [Personalize classes](#personalize-classes)

Installation
------------

[](#installation)

To install Laravel Stepper as a Composer package to be used with Laravel 5, simply run:

```
composer require axn/laravel-stepper

```

Once it's installed, the package is automatically registered via Artisan command `package:discover` (Laravel >=5.5). If not, you must register the service provider in `config/app.php` by adding this line in `providers` section:

```
'Axn\LaravelStepper\ServiceProvider',

```

Usage
-----

[](#usage)

The stepper is going to be used on several pages. There might be several steppers per application, that's why a stepper has to be defined in a dedicated class:

```
use Axn\LaravelStepper\Stepper;

class BasicStepper extends Stepper
{
    public function register()
    {
        $this->addStep('step 1');
        $this->addStep('step 2');
        $this->addStep('step 3');
        $this->addStep('step 4');
        $this->addStep('step 5');
    }
}
```

What's important about that class :

- It extends the abscract class : `Axn\LaravelStepper\Stepper`
- It's implementing the `register()` method
- It's in that method, that all the different steps are defined

Then, we can inject this class into controller's methods :

```
    //...

    public function index(BasicStepper $stepper)
    {
        $stepper->setCurrentStepName('step 3');

        return $this->view('example-view', [
            'stepper' => $stepper->render()
        ]);
    }

    //...
```

Because the class is injected by the IoC container, it's instanciated and the `register()` is automatically called. After that it's necessary to precise to the stepper which step is the current one : `$stepper->setCurrentStepName('step 3')`. Then the rendering of the stepper will be transmitted to the view in which you can simply put : `{!! $stepper !!}`.

Personalize the template
------------------------

[](#personalize-the-template)

### Change the template

[](#change-the-template)

This package provides several templates. By default, the template "default" is used. To use the template "arrows", you need to add to the stepper class the name of the template to use:

```
use Axn\LaravelStepper\Stepper;

class BasicStepper extends Stepper
{
    protected $view = 'stepper::arrows';
    //...
}
```

That's it!

Of course, in a very classical way, you can use any view of the template system. For example, to use the template `resources/views/partials/steppers/custom.blade.php`, put the following code in your class:

```
use Axn\LaravelStepper\Stepper;

class BasicStepper extends Stepper
{
    protected $view = 'partials.steppers.custom';
    //...
}
```

### Personalize a template

[](#personalize-a-template)

All provided templates are more examples to understand how to use the package rather than production templates. For example, CSS styles are embedded in templates, which is not a good practice.

It's possible to start from one of thoose templates provided with the package and to modify them. For that, you have to publish templates, then edit them.

To publish all templates, use the following command:

```
php artisan vendor:publish

```

After this step, you'll find all templates in `resources/views/vendor/stepper/`. It will be very easy to edit them depending on your needs.

### Methods in templates

[](#methods-in-templates)

To personalize your templates, different methods are accessible. Here is the list:

#### Stepper class

[](#stepper-class)

`{{ $stepper->getStep($stepName) }}` return a step, instance of StepInterface, given the name of a step

`{{ $stepper->getCurrentStep($stepName) }}` return the instance of the current step

`{{ $stepper->getPrevStep($stepName) }}` return the instance of the previous step

`{{ $stepper->getNextStep($stepName) }}` return the instance of the next step

`{{ $stepper->stepExists($stepName) }}` get if a given step with it's name is existing

`{{ $stepper->getNumSteps() }}` get the total number of steps

`{{ $stepper->getCurrentStepName() }}` get the name of the current step

The stepper object implements the Iterator's interface, so it's possible to loop easily on it. Every loop is returning an instance of StepInterface implemented by the Step class.

```
@foreach ($stepper as $step)
    // ...
@endforeach
```

#### Step class (StepInterface implementation and more if you wish)

[](#step-class-stepinterface-implementation-and-more-if-you-wish)

`{{ $step->getName() }}` return the name associated to the step

`{{ $step->getUrl() }}` return the URL associated to the step

`{{ $step->getRoute() }}` return the route associated to the step

`{{ $step->getPosition() }}` return step's position

`{{ $step->getTitle() }}` return the title associated to the step

`{{ $step->getDescription() }}` return the description associated to the step

`{{ $step->isCurrent() }}` return if it's current step or no

`{{ $step->isPassed() }}` return if the step is in the past

`{{ $step->isFirst() }}` return if it's the first step

`{{ $step->isLast() }}` return if it's the last step

Personalize classes
-------------------

[](#personalize-classes)

Because the concrete class of our stepper is a child of the abscract stepper class, it's possible to override properties and methods of that stepper class.

It's also possible to override the Step class very easily by implementing the StepInterface interface and putting in the stepper class the name of the Step class to use:

```
use Axn\LaravelStepper\Stepper;

class BasicStepper extends Stepper
{
    protected $stepClass = 'App\CustomStep';
    //...
}
```

###  Health Score

53

—

FairBetter than 96% of packages

Maintenance92

Actively maintained with recent releases

Popularity20

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 83.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~303 days

Recently: every ~457 days

Total

14

Last Release

38d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1314974?v=4)[Axel Neumann](/maintainers/axn)[@axn](https://github.com/axn)

---

Top Contributors

[![forxer](https://avatars.githubusercontent.com/u/407917?v=4)](https://github.com/forxer "forxer (36 commits)")[![axn-quentin-lozach](https://avatars.githubusercontent.com/u/23211424?v=4)](https://github.com/axn-quentin-lozach "axn-quentin-lozach (2 commits)")[![lgtaxn](https://avatars.githubusercontent.com/u/23211553?v=4)](https://github.com/lgtaxn "lgtaxn (2 commits)")[![sylvainR37](https://avatars.githubusercontent.com/u/29980311?v=4)](https://github.com/sylvainR37 "sylvainR37 (2 commits)")[![thiagogomesverissimo](https://avatars.githubusercontent.com/u/908508?v=4)](https://github.com/thiagogomesverissimo "thiagogomesverissimo (1 commits)")

### Embed Badge

![Health badge](/badges/axn-laravel-stepper/health.svg)

```
[![Health](https://phpackages.com/badges/axn-laravel-stepper/health.svg)](https://phpackages.com/packages/axn-laravel-stepper)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[renatomarinho/laravel-page-speed

Laravel Page Speed

2.5k1.7M10](/packages/renatomarinho-laravel-page-speed)[illuminate/pagination

The Illuminate Pagination package.

12234.1M1.0k](/packages/illuminate-pagination)[illuminate/pipeline

The Illuminate Pipeline package.

9349.2M282](/packages/illuminate-pipeline)[illuminate/redis

The Illuminate Redis package.

8314.6M375](/packages/illuminate-redis)[illuminate/cookie

The Illuminate Cookie package.

244.6M137](/packages/illuminate-cookie)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)