> ## 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.
# Getting started
export const EditOnGitHub = ({version, path}) => {
const url = `https://github.com/filamentphp/filament/edit/${version}/${path}`;
return ;
};
export const Footer = () => {
const sponsorsByTier = JSON.parse(`{
"agency_partner": [
{
"name": "Kirschbaum",
"url": "https://kirschbaumdevelopment.com/solutions/filament-development",
"filename": "kirschbaum.svg"
}
],
"gold": [
{
"name": "Agiledrop",
"url": "https://www.agiledrop.com/laravel?utm_source=filament",
"filename": "agiledrop.svg"
},
{
"name": "Baiz.ai",
"url": "https://baiz.ai",
"filename": "baiz-ai.svg"
},
{
"name": "CMS Max",
"url": "https://cmsmax.com?ref=filamentphp.com",
"filename": "cms-max.svg"
},
{
"name": "Mailtrap",
"url": "https://mailtrap.io/email-sending?utm_source=community&utm_medium=referral&utm_campaign=filament",
"filename": "mailtrap.svg"
},
{
"name": "SerpApi",
"url": "https://serpapi.com/?utm_source=filamentphp",
"filename": "serpapi.svg"
}
]
}`);
function shuffleArray(items) {
const result = [...items];
for (let index = result.length - 1; index > 0; index--) {
const randomIndex = Math.floor(Math.random() * (index + 1));
[result[index], result[randomIndex]] = [result[randomIndex], result[index]];
}
return result;
}
const sponsors = Object.entries(sponsorsByTier).flatMap(([, sponsors]) => shuffleArray(sponsors));
return ;
};
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](/5.x).
Filament allows you to create completely custom pages for the admin panel.
## Creating a page
To create a new page, you can use:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-page Settings
```
This command will create two files - a page class in the `/Pages` directory of the Filament directory, and a view in the `/pages` directory of the Filament views directory.
Page classes are all full-page [Livewire](https://laravel-livewire.com) components with a few extra utilities you can use with the admin panel.
## Conditionally hiding pages in navigation
You can prevent pages from appearing in the menu by overriding the `shouldRegisterNavigation()` method in your Page class. This is useful if you want to control which users can see the page in the sidebar.
```php theme={"theme":"gruvbox-dark-hard"}
protected static function shouldRegisterNavigation(): bool
{
return auth()->user()->canManageSettings();
}
```
Please be aware that all users will still be able to visit this page through its direct URL, so to fully limit access you must also also check in the `mount()` method of the page:
```php theme={"theme":"gruvbox-dark-hard"}
public function mount(): void
{
abort_unless(auth()->user()->canManageSettings(), 403);
}
```
## Customization
Filament will automatically generate a title, navigation label and URL (slug) for your page based on its name. You may override it using static properties of your page class:
```php theme={"theme":"gruvbox-dark-hard"}
protected static ?string $title = 'Custom Page Title';
protected static ?string $navigationLabel = 'Custom Navigation Label';
protected static ?string $slug = 'custom-url-slug';
```
You may also specify a custom header and footer view for any page. You may return them from the `getHeader()` and `getFooter()` methods:
```php theme={"theme":"gruvbox-dark-hard"}
use Illuminate\Contracts\View\View;
protected function getHeader(): View
{
return view('filament.settings.custom-header');
}
protected function getFooter(): View
{
return view('filament.settings.custom-footer');
}
```
)}
Your logo here