anthonyedmonds/laravel-form-builder

Create one-thing-per-page forms with forking logic and task lists; ideal for the GOV.UK Design System!

dev-main 2024-04-29 13:04 UTC

Requires

• php: ^8.3
• illuminate/support: ^11

Requires (Dev)

• brianium/paratest: ^7
• larastan/larastan: ^2
• laravel/pint: ^1
• networkrailbusinesssystems/badges: ^1
• orchestra/testbench: ^9
• phpunit/phpunit: ^11

MIT

• Anthony Edmonds

• form
• builder
• laravel
• question
• gov.uk
• task list
• one thing per page

README

Create one-thing-per-page forms with forking logic and task lists; ideal for the GOV.UK Design System!

What's in the box?

• Laravel 11 compatible classes for generating dynamic forms
• A complete start-to-finish form lifecycle
• Tasks to group questions into manageable chunks
• Forks to allow branching questions
• Session and database persisted models
• Support for looping, skipping, and drafting answers

Installation

1. Install the library using Composer:

   composer require anthonyedmonds\laravel-form-builder

   • Laravel will automatically detect and register the Laravel Form Builder service provider.

2. Publish the config file:

   php artisan vendor:publish --provider="AnthonyEdmonds\LaravelFormBuilder\ServiceProviders\LaravelFormBuilderServiceProvider"

3. Add the form routes to your web.php routes file:

   Route::laravelFormBuilder();

4. Create and configure a Form class, filling it with any number of Task, Fork, and Question classes.

5. Create a Model with the HasForm trait

6. Access the form and away you go!

   // Starting fresh...
   return MyModel::form()->start(); // RedirectResponse
   
   // From existing...
   return $myModel->form()->start(); // RedirectResponse

   <!-- From blade... -->
   <a href="{{ $myModel->form()->startRoute() }}">Start form</a>

Documentation

Start

Task

Fork

Question

Summary

Finish

Contribution

Feel free to submit ideas and features as issues, and raise pull requests.