Usage v1.0.0

Install, register, and configure

Developer setup for a Laravel + Filament host. Admin form-building steps are in Workflows.

Requirements

• PHP 8.2+
• Laravel 11+
• Filament ^3.3|^4.0|^5.0 (starter uses Filament v5 Schema: Section, Wizard, Tabs)
• Livewire ^3.0|^4.0
• A users table (submissions and audit logs may FK to users)
• Optional: spiggle/dynamic-fields for shared types and import
• Optional: Filament Shield / Spatie Permission
• Optional: spatie/laravel-activitylog (audit also writes to package tables without it)

Composer name: spiggle/form-builder. Namespace: Spiggle\FormBuilder. Plugin id: spiggle-form-builder.

Install (path repository)

{
  "repositories": [
    {
      "type": "path",
      "url": "packages/spiggle-form-builder",
      "options": { "symlink": true }
    }
  ],
  "require": {
    "spiggle/form-builder": "*"
  }
}

composer require spiggle/form-builder:@dev

The service provider auto-registers. Livewire component name: form-builder.public-form.

Publish config, migrations, views

php artisan vendor:publish --tag=form-builder-config
php artisan vendor:publish --tag=form-builder-migrations
php artisan vendor:publish --tag=form-builder-views
php artisan migrate

Migrations also auto-load from the package. Tables: form_builder_forms, form_builder_submissions, form_builder_audit_logs (prefixed so they do not collide with a generic forms table). Publishing views is only needed if you want to restyle the public renderer.

For public file downloads on the public disk: php artisan storage:link.

Register the Filament plugin

Starter: app/Providers/Filament/AdminPanelProvider.php.

use Spiggle\FormBuilder\Filament\FormBuilderPlugin;

$panel
    ->plugin(\Spiggle\DynamicFields\Filament\DynamicFieldsPlugin::make()) // optional, recommended
    ->plugin(FormBuilderPlugin::make());

Registers two resources:

• Forms — navigation group Forms (sort 40), icon clipboard-document-list
• Submissions — same group (sort 41), icon inbox-stack

Public routing

Default: GET /forms/{path} (path can include slashes). Named route: form-builder.public. Only published and active forms resolve (scopePublished).

Environment:

• FORM_BUILDER_ROUTE_PREFIX — default forms. Empty prefix serves at /{base_path} (easy to collide with /admin; keep a prefix unless you know the route table).
• FORM_BUILDER_ROOT_PATHS=true — registers ResolveFormPath on the web group so unmatched paths that match a published form’s base_path or slug still render. Reserved first segments: admin, livewire, api, up, storage, vendor (configurable).

PathResolver rejects reserved segments, existing form slugs/paths, and existing Laravel routes, then appends -f{4-char-hash} (example style: contact-us-f8a1).

Permissions / Shield

AuthorizesFormBuilder::check($key) uses the same fallback as Dynamic Fields: permission or super_admin; if the permission row does not exist yet, authenticated panel users keep access.

php artisan shield:generate --all

Then assign those permissions to the roles that should manage forms vs only view/export submissions.

Artisan commands

Configuration

Published file: config/form-builder.php.

Useful PHP API

use Spiggle\FormBuilder\Models\Form;

$form = Form::query()->published()->where('base_path', 'contact-us')->first();
$form->publicUrl();
$form->document();          // portable JSON object
$form->fields();            // flattened field arrays
$form->cloneForm();         // unpublished copy, new path
$form->importCustomFields([1, 2, 3]); // Dynamic Fields ids

app(\Spiggle\FormBuilder\Services\SubmissionManager::class)
    ->capture($form, $data, request(), ['source' => 'api']);