Introduction
Filament automatically generates navigation for your panel based on your resources and pages. You can customize the navigation structure, groups, and appearance to match your needs.
Navigation groups
Organize navigation items into collapsible groups:
Using enums for groups
You can use enums to define navigation groups:
Register the enum:
Custom navigation items
Add custom navigation items that aren’t tied to resources or pages:
Custom navigation builder
For complete control over navigation, provide a custom builder:
When using a custom navigation builder, automatic navigation generation is disabled. You must explicitly include all resources and pages you want to appear.
Disabling navigation
Disable navigation entirely to create a single-page panel:
Top navigation
Switch from sidebar navigation to a top navigation bar:
This moves navigation items to a horizontal bar below the header.
Make the sidebar collapsible:
Customize the sidebar width:
Collapsed width
Set the width when collapsed:
Resource navigation
Customize how resources appear in navigation:
Hiding resources from navigation
Active navigation icons
Specify a different icon for when the resource is active:
Page navigation
Customize how pages appear in navigation:
Nested navigation
Nest pages under other navigation items:
Sub-navigation
Add sub-navigation tabs within a page:
Breadcrumbs
Breadcrumbs are automatically generated based on navigation hierarchy.
Disabling breadcrumbs
Customizing breadcrumbs
Override breadcrumbs in resources or pages:
Global search
The global search appears in the navigation bar and searches across all resources that have enabled it.
Disabling global search
Customizing search keybinding
Configuring search debounce
Customize the user menu in the navigation bar:
Navigation icons
Filament uses Heroicons by default. You can use any Heroicon name:
You can also register custom icon sets in your panel configuration.