Multi-step Forms for Laravel

Published on by

Multi-step Forms for Laravel image

Arcanist is a package by Kai Sassnowski that takes the pain out of building multi-step form wizards in Laravel. Arcanist is a new package that requires both Laravel 8 and PHP 8:

Arcanist provides a simple yet powerful approach for adding multi-step form wizards to your Laravel application. It takes care of all the boring details so you can spend your time writing features, not boilerplate.

From the documentation page, the main features of this package include:

  • Automatically registering all necessary routes for a wizard
  • Form validation
  • Persisting data between steps
  • Keeping track of which steps have already been completed
  • Resuming wizards at the last unfinished step

Setting up multi-step forms can become quite complex quickly. Using this package, you'll have to work with a few classes, such as the overall “wizard” class and the “steps” classes.

Here’s a look at a wizard class for user registration to give you a visual:

namespace App\Wizards\Registration;
 
use Arcanist\AbstractWizard;
use Illuminate\Http\Request;
 
class RegistrationWizard extends AbstractWizard
{
public static string $title = 'Registration';
 
public static string $slug = 'registration';
 
public string $onCompleteAction = RegistrationAction::class;
 
protected array $steps = [
//
];
 
public static function middleware(): array
{
return [];
}
 
public function sharedData(Request $request): array
{
return [];
}
}

Once you register the above wizard in the package’s configuration file, the package registers associated routes. As you can see above, the $steps property houses the wizard steps in an array. Here’s what a step might look like:

namespace App\Wizards\Registration\Steps;
 
use Arcanist\Field;
use Arcanist\WizardStep;
use Illuminate\Http\Request;
 
class UsernameAndPasswordStep extends WizardStep
{
public string $title = 'Username And Password';
 
public string $slug = 'username-and-password';
 
public function viewData(Request $request): array
{
return $this->withFormData();
}
 
protected function fields(): array
{
return [
Field::make('username')
->rules(['required', 'unique:users,username']),
 
Field::make('password')
->rules(['required', 'confirmed', 'string', 'min:12']),
];
}
}

While we wanted to give you a visual of what the code for a step looks like, you’ll need to read through the getting started documentation to dive deeper into actions, views, and tying everything together.

To learn more about this package, check out the Arcanist documentation. The source code is available as open-source on GitHub. Please note that the documentation is still a work-in-progress.


This package was submitted to our Laravel News Links section. Links is a place the community can post packages and tutorials around the Laravel ecosystem. Follow along on Twitter @LaravelLinks

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Version 4 of Tinkerwell is available now. Get the most popular PHP scratchpad with all its new features and simplify your development workflow today.

Visit Tinkerwell
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
Larafast: Laravel SaaS Starter Kit logo

Larafast: Laravel SaaS Starter Kit

Larafast is a Laravel SaaS Starter Kit with ready-to-go features for Payments, Auth, Admin, Blog, SEO, and beautiful themes. Available with VILT and TALL stacks.

Larafast: Laravel SaaS Starter Kit
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Apply Dynamic Filters to Eloquent Models with the Filterable Package image

Apply Dynamic Filters to Eloquent Models with the Filterable Package

Read article
Property Hooks Get Closer to Becoming a Reality in PHP 8.4 image

Property Hooks Get Closer to Becoming a Reality in PHP 8.4

Read article
Asserting Exceptions in Laravel Tests image

Asserting Exceptions in Laravel Tests

Read article
Reversible Form Prompts and a New Exceptions Facade in Laravel 11.4 image

Reversible Form Prompts and a New Exceptions Facade in Laravel 11.4

Read article
Basset is an alternative way to load CSS & JS assets image

Basset is an alternative way to load CSS & JS assets

Read article
Integrate Laravel with Stripe Connect Using This Package image

Integrate Laravel with Stripe Connect Using This Package

Read article