Skip to main content

Documentation Index

Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

You are currently viewing the documentation for Filament 2.x, which is a previous version of Filament.Looking for the current stable version? Visit the 5.x documentation.
Filament allows you to display widgets inside pages, below the header and above the footer. To add a widget to a page, use the getHeaderWidgets() or getFooterWidgets() methods: 
use App/Filament/Widgets/StatsOverviewWidget;

protected function getHeaderWidgets(): array
{
    return [
        StatsOverviewWidget::class
    ];
}
getHeaderWidgets() returns an array of widgets to display above the page content, whereas getFooterWidgets() are displayed below. If you’d like to learn how to build and customize widgets, check out the Dashboard documentation section.

​
Customizing the widgets grid

You may change how many grid columns are used to display widgets. You may override the getHeaderWidgetsColumns() or getFooterWidgetsColumns() methods to return a number of grid columns to use: 
protected function getHeaderWidgetsColumns(): int | array
{
    return 3;
}

​
Responsive widgets grid

You may wish to change the number of widget grid columns based on the responsive breakpoint of the browser. You can do this using an array that contains the number of columns that should be used at each breakpoint: 
protected function getHeaderWidgetsColumns(): int | array
{
    return [
        'md' => 4,
        'xl' => 5,
    ];
}
This pairs well with responsive widget widths.