Page - Filament

The Page class is the foundation for creating custom pages in Filament panels. Pages can include forms, widgets, actions, and custom content, and can be organized within navigation groups and clusters.

Namespace

Filament\Pages\Page

Inheritance

Extends: Filament\Pages\BasePage Implements: HasActions, HasRenderHookScopes, HasSchemas

Type Parameters

TConfiguration - The page configuration class (extends PageConfiguration)

Static Methods

getUrl()

Generate a URL to this page.

public static function getUrl(
    array $parameters = [],
    bool $isAbsolute = true,
    ?string $panel = null,
    ?Model $tenant = null,
    bool $shouldGuessMissingParameters = false,
    ?string $configuration = null
): string

array<mixed>

default:"[]"

Additional route parameters.

bool

default:"true"

Whether to generate an absolute URL.

string | null

default:"null"

The panel ID. Defaults to the current panel.

Model | null

default:"null"

The tenant model for multi-tenancy.

bool

default:"false"

Whether to guess missing route parameters.

string | null

default:"null"

The configuration key.

string

Returns the generated URL.

registerRoutes()

public static function registerRoutes(
    Panel $panel,
    ?PageConfiguration $configuration = null
): void

Panel

The panel instance.

PageConfiguration | null

Optional page configuration.

registerNavigationItems()

public static function registerNavigationItems(): void

This method is called automatically to register the page in the panel navigation.

getNavigationItems()

Get the navigation items for this page.

public static function getNavigationItems(): array

array<NavigationItem>

Returns an array of navigation items.

getRouteName()

Get the route name for this page.

public static function getRouteName(?Panel $panel = null): string

Panel | null

The panel instance. Defaults to the current panel.

string

Returns the route name.

getNavigationLabel()

Get the navigation label for this page.

public static function getNavigationLabel(): string

string

Returns the navigation label.

getNavigationIcon()

Get the navigation icon for this page.

public static function getNavigationIcon(): string | BackedEnum | Htmlable | null

string | BackedEnum | Htmlable | null

Returns the icon identifier.

getNavigationGroup()

Get the navigation group for this page.

public static function getNavigationGroup(): string | UnitEnum | null

string | UnitEnum | null

Returns the navigation group name.

getNavigationSort()

Get the navigation sort order for this page.

public static function getNavigationSort(): ?int

int | null

Returns the sort order.

getNavigationBadge()

Get the navigation badge for this page.

public static function getNavigationBadge(): ?string

string | null

Returns the badge content.

getNavigationBadgeColor()

Get the navigation badge color.

public static function getNavigationBadgeColor(): string | array | null

string | array<string> | null

Returns the badge color.

shouldRegisterNavigation()

Check if this page should register navigation items.

public static function shouldRegisterNavigation(): bool

bool

Returns true if navigation should be registered.

isDiscovered()

Check if this page should be automatically discovered.

public static function isDiscovered(): bool

bool

Returns true if the page should be discovered.

getCluster()

Get the cluster this page belongs to.

public static function getCluster(): ?string

class-string<Cluster> | null

Returns the cluster class name or null.

Instance Methods

getLayout()

Get the layout view for this page.

public function getLayout(): string

string

Returns the layout view name.

getBreadcrumbs()

Get the breadcrumbs for this page.

public function getBreadcrumbs(): array

array<string>

Returns an array of breadcrumb labels.

getFooter()

Get the footer view for this page.

public function getFooter(): ?View

View | null

Returns the footer view or null.

getHeader()

Get the header view for this page.

public function getHeader(): ?View

View | null

Returns the header view or null.

content()

Define the content schema for this page.

public function content(Schema $schema): Schema

Schema

The schema instance to configure.

Schema

Returns the configured schema.

Example:

use Filament\Schemas\Schema;
use Filament\Schemas\Components\Section;

public function content(Schema $schema): Schema
{
    return $schema
        ->components([
            Section::make('Content')
                ->schema([
                    // Components...
                ]),
        ]);
}

getHeaderWidgets()

Get the widgets to display in the page header.

protected function getHeaderWidgets(): array

array<class-string<Widget> | WidgetConfiguration>

Returns an array of widget configurations.

getFooterWidgets()

Get the widgets to display in the page footer.

protected function getFooterWidgets(): array

array<class-string<Widget> | WidgetConfiguration>

Returns an array of widget configurations.

getHeaderWidgetsColumns()

Get the column configuration for header widgets.

public function getHeaderWidgetsColumns(): int | array

int | array<string, ?int>

Returns the number of columns or responsive column configuration.

getFooterWidgetsColumns()

Get the column configuration for footer widgets.

public function getFooterWidgetsColumns(): int | array

int | array<string, ?int>

Returns the number of columns or responsive column configuration.

getWidgetData()

Get data to pass to page widgets.

public function getWidgetData(): array

array<string, mixed>

Returns an array of data to pass to widgets.

Properties

$cluster

protected static ?string $cluster = null;

The cluster class this page belongs to.

$navigationGroup

protected static string | UnitEnum | null $navigationGroup = null;

The navigation group for this page.

$navigationIcon

protected static string | BackedEnum | null $navigationIcon = null;

The navigation icon for this page.

$navigationLabel

protected static ?string $navigationLabel = null;

The navigation label for this page.

$navigationSort

protected static ?int $navigationSort = null;

The navigation sort order.

$shouldRegisterNavigation

protected static bool $shouldRegisterNavigation = true;

Whether this page should register navigation items.

Traits

CanAuthorizeAccess - Authorization checks
HasErrorNotifications - Error notification handling
HasRoutes - Route management
HasSubNavigation - Sub-navigation support
InteractsWithHeaderActions - Header action management

Resource - For CRUD pages
Panel - Panel configuration
Action - Page actions

​Namespace

​Inheritance

​Type Parameters

​Static Methods

​getUrl()

​registerRoutes()

​registerNavigationItems()

​getNavigationItems()

​getRouteName()

​getNavigationLabel()

​getNavigationIcon()

​getNavigationGroup()

​getNavigationSort()

​getNavigationBadge()

​getNavigationBadgeColor()

​shouldRegisterNavigation()

​isDiscovered()

​getCluster()

​Instance Methods

​getLayout()

​getBreadcrumbs()

​getFooter()

​getHeader()

​content()

​getHeaderWidgets()

​getFooterWidgets()

​getHeaderWidgetsColumns()

​getFooterWidgetsColumns()

​getWidgetData()

​Properties

​$cluster

​$navigationGroup

​$navigationIcon

​$navigationLabel

​$navigationSort

​$shouldRegisterNavigation

​Traits

​Related Classes

Namespace

Inheritance

Type Parameters

Static Methods

getUrl()

registerRoutes()

registerNavigationItems()

getNavigationItems()

getRouteName()

getNavigationLabel()

getNavigationIcon()

getNavigationGroup()

getNavigationSort()

getNavigationBadge()

getNavigationBadgeColor()

shouldRegisterNavigation()

isDiscovered()

getCluster()

Instance Methods

getLayout()

getBreadcrumbs()

getFooter()

getHeader()

content()

getHeaderWidgets()

getFooterWidgets()

getHeaderWidgetsColumns()

getFooterWidgetsColumns()

getWidgetData()

Properties

$cluster

$navigationGroup

$navigationIcon

$navigationLabel

$navigationSort

$shouldRegisterNavigation

Traits

Related Classes