Configuration

Introduction

Filament panels are highly configurable. This guide covers all available configuration options for customizing your panel’s appearance, behavior, and functionality.

Basic configuration

Panel ID and path

Every panel requires a unique ID and path:

$panel
    ->id('admin')
    ->path('admin')

The ID is used for route names and internal identification, while the path determines the URL.

Domain configuration

Host your panel on a specific domain:

// Single domain
$panel->domain('admin.example.com')

// Multiple domains
$panel->domains([
    'admin.example.com',
    'admin.example.org',
])

Home URL

Set a custom home URL for the panel:

$panel->homeUrl('/dashboard')

// Dynamic URL
$panel->homeUrl(fn (): string => route('admin.dashboard'))

Branding

Brand name

Customize the application name displayed in the panel:

$panel->brandName('My Application')

Brand logo

Add a custom logo:

$panel->brandLogo(asset('images/logo.png'))

// Different logos for light and dark mode
$panel
    ->brandLogo(asset('images/logo-light.png'))
    ->darkModeBrandLogo(asset('images/logo-dark.png'))

Brand logo height

$panel->brandLogoHeight('2rem')

Favicon

Set a custom favicon:

$panel->favicon(asset('images/favicon.png'))

Colors

Customize the color scheme:

use Filament\Support\Colors\Color;

$panel->colors([
    'primary' => Color::Amber,
    'danger' => Color::Rose,
    'gray' => Color::Zinc,
    'info' => Color::Blue,
    'success' => Color::Emerald,
    'warning' => Color::Orange,
])

Custom colors

Define custom color palettes:

$panel->colors([
    'primary' => [
        50 => '254, 252, 232',
        100 => '254, 249, 195',
        // ... additional shades
    ],
])

Dark mode

Configure dark mode behavior:

use Filament\Enums\ThemeMode;

// Default to dark mode
$panel->defaultThemeMode(ThemeMode::Dark)

// Default to light mode
$panel->defaultThemeMode(ThemeMode::Light)

// Default to system preference
$panel->defaultThemeMode(ThemeMode::System)

Forcing dark mode

Disable the theme switcher:

$panel
    ->darkMode(false) // Disable dark mode completely
    ->darkMode(true)  // Force dark mode only

Font

Customize the font family:

$panel->font('Inter')

// Using Google Fonts
$panel->font('Poppins', provider: FontProvider::GoogleFonts)

Maximum content width

Set the maximum width for page content:

use Filament\Support\Enums\MaxWidth;

$panel->maxContentWidth(MaxWidth::Full)
$panel->maxContentWidth(MaxWidth::SevenExtraLarge)
$panel->maxContentWidth(MaxWidth::FiveExtraLarge)

SPA mode

Enable single-page application mode for faster navigation:

$panel->spa()

// With prefetching
$panel->spa(prefetch: true)

SPA URL exceptions

Exclude certain URLs from SPA mode:

$panel->spaUrlExceptions([
    '/admin/reports/*',
])

Database transactions

Automatically wrap actions in database transactions:

$panel->databaseTransactions()

Middleware

Add custom middleware to panel routes:

$panel->middleware([
    'throttle:60,1',
])

// Authenticated routes only
$panel->authMiddleware([
    'verified',
])

Render hooks

Inject content at specific locations in the panel:

use Filament\View\PanelsRenderHook;
use Illuminate\Support\Facades\Blade;

$panel->renderHook(
    PanelsRenderHook::BODY_START,
    fn (): string => Blade::render('@livewire(\'banner\')')
)

Available hooks:

BODY_START
BODY_END
HEAD_START
HEAD_END
CONTENT_START
CONTENT_END
SIDEBAR_START
SIDEBAR_END
TOPBAR_START
TOPBAR_END

Plugins

use Filament\SpatieLaravelTranslatablePlugin;

$panel->plugins([
    SpatieLaravelTranslatablePlugin::make()
        ->defaultLocales(['en', 'es', 'fr']),
])

Unsaved changes alerts

Warn users about unsaved changes:

$panel->unsavedChangesAlerts()

Database notifications

Enable database notifications:

$panel->databaseNotifications()

// With polling
$panel->databaseNotificationsPolling('30s')

Broadcasting

Enable real-time broadcasting:

$panel->broadcasting()

Customize the top navigation bar:

// Hide topbar
$panel->topbar(false)

Avatars

Configure user avatars:

use Filament\AvatarProviders\UiAvatarsProvider;

$panel->avatarProvider(UiAvatarsProvider::class)

Custom avatar provider

use Filament\AvatarProviders\Contracts\AvatarProvider;
use Illuminate\Database\Eloquent\Model;

$panel->avatarProvider(
    new class implements AvatarProvider
    {
        public function get(Model $record): string
        {
            return 'https://avatar.example.com/' . $record->id;
        }
    }
)

Icons

Customize icons used throughout the panel:

use Filament\Support\Icons\Icon;

$panel->icons([
    'panels::topbar.global-search.field' => 'heroicon-m-magnifying-glass',
    'panels::sidebar.collapse-button' => 'heroicon-m-chevron-left',
])

Resources

Configure default resource behavior:

// Default redirect after creating a record
$panel->resourceCreatePageRedirect('edit')

// Default redirect after editing a record  
$panel->resourceEditPageRedirect('view')

// Read-only relation managers on view pages
$panel->readOnlyRelationManagersOnResourceViewPagesByDefault()

Vite theme

Use Vite to build custom themes:

$panel->viteTheme('resources/css/filament/admin/theme.css')

// Multiple themes
$panel->viteTheme([
    'resources/css/filament/admin/theme.css',
    'resources/css/filament/admin/custom.css',
])

// Custom build directory
$panel->viteTheme('resources/css/theme.css', buildDirectory: 'admin')

Custom theme

use Filament\Support\Assets\Theme;

$panel->theme(
    Theme::make('custom', __DIR__ . '/../../resources/css/custom.css')
)

Strict authorization

Require authorization for all resources and pages:

$panel->strictAuthorization()

This throws an exception if a resource or page doesn’t implement authorization.

Getting Started

Panel Builder

Core Concepts

Building Blocks

Advanced

Introduction

Basic configuration

Panel ID and path

Domain configuration

Home URL

Branding

Brand name

Brand logo

Brand logo height

Favicon

Colors

Custom colors

Dark mode

Forcing dark mode

Font

Maximum content width

SPA mode

SPA URL exceptions

Database transactions

Middleware

Render hooks

Plugins

Unsaved changes alerts

Database notifications

Broadcasting

Topbar

Avatars

Custom avatar provider

Icons

Resources

Vite theme

Custom theme

Strict authorization

​Introduction

​Basic configuration

​Panel ID and path

​Domain configuration

​Home URL

​Branding

​Brand name

​Brand logo

​Brand logo height

​Favicon

​Colors

​Custom colors

​Dark mode

​Forcing dark mode

​Font

​Maximum content width

​SPA mode

​SPA URL exceptions

​Database transactions

​Middleware

​Render hooks

​Plugins

​Unsaved changes alerts

​Database notifications

​Broadcasting

​Topbar

​Avatars

​Custom avatar provider

​Icons

​Resources

​Vite theme

​Custom theme

​Strict authorization

Introduction

Basic configuration

Panel ID and path

Domain configuration

Home URL

Branding

Brand name

Brand logo

Brand logo height

Favicon

Colors

Custom colors

Dark mode

Forcing dark mode

Font

Maximum content width

SPA mode

SPA URL exceptions

Database transactions

Middleware

Render hooks

Plugins

Unsaved changes alerts

Database notifications

Broadcasting

Topbar

Avatars

Custom avatar provider

Icons

Resources

Vite theme

Custom theme

Strict authorization