Skip to main content

Introduction

Wizards create multistep forms with validation between steps:
For panel resources or action modals, see the specific documentation for those contexts.

Submit button

Render a submit button on the last step:
Using the Filament button component:
string | Htmlable
The HTML or view for the submit button.

Step icons

Add icons to steps:
string | BackedEnum | Htmlable | Closure
The icon to display.

Completed icons

Customize icons for completed steps:
string | BackedEnum | Htmlable | Closure
The icon for completed steps.

Step descriptions

Add descriptions to steps:
string | Htmlable | Closure
The step description.

Default active step

Set which step loads by default:
int | Closure
default:"1"
The starting step index.

Skippable steps

Allow free navigation between steps:
bool | Closure
default:"false"
Whether steps can be skipped.

Persisting the current step

Persist the current step in the URL query string:
Customize the query parameter:
string | Closure
default:"'step'"
The query string parameter name.

Step lifecycle hooks

Run code before and after step validation:

Preventing navigation

Throw Halt to prevent moving to the next step:

Grid columns in steps

Customize the grid within steps:
int | array | Closure
The number of columns or responsive configuration.

Customizing actions

Customize the next and previous buttons:
Closure
A closure that receives and modifies the action.