Multi-step Forms for Laravel


May 14th, 2021

Multi-step Forms for Laravel

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:

1namespace App\Wizards\Registration;
3use Arcanist\AbstractWizard;
4use Illuminate\Http\Request;
6class RegistrationWizard extends AbstractWizard
8 public static string $title = 'Registration';
10 public static string $slug = 'registration';
12 public string $onCompleteAction = RegistrationAction::class;
14 protected array $steps = [
15 //
16 ];
18 public static function middleware(): array
19 {
20 return [];
21 }
23 public function sharedData(Request $request): array
24 {
25 return [];
26 }

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:

1namespace App\Wizards\Registration\Steps;
3use Arcanist\Field;
4use Arcanist\WizardStep;
5use Illuminate\Http\Request;
7class UsernameAndPasswordStep extends WizardStep
9 public string $title = 'Username And Password';
11 public string $slug = 'username-and-password';
13 public function viewData(Request $request): array
14 {
15 return $this->withFormData();
16 }
18 protected function fields(): array
19 {
20 return [
21 Field::make('username')
22 ->rules(['required', 'unique:users,username']),
24 Field::make('password')
25 ->rules(['required', 'confirmed', 'string', 'min:12']),
26 ];
27 }

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

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.