> ## 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.
# Viewing records
export const LaracastsBanner = ({title, description, url, series}) => {
const instructors = {
'building-advanced-components': {
name: 'Dan Harrin',
avatar: 'https://avatars.githubusercontent.com/u/41773797?v=4',
twitter: 'https://twitter.com/danjharrin',
website: 'https://danharrin.com',
github: 'https://github.com/danharrin'
},
'rapid-laravel-development': {
name: 'Kevin McKee',
avatar: 'https://avatars.githubusercontent.com/u/4503765?v=4',
twitter: 'https://twitter.com/iAmKevinMcKee',
website: 'https://kevinmckee.me',
github: 'https://github.com/iAmKevinMcKee'
}
};
const instructor = instructors[series] || instructors['building-advanced-components'];
return
{instructor.name}
Instructor
;
};
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 3.x, which is a previous version of Filament.
Looking for the current stable version? Visit the [5.x documentation](/5.x).
## Creating a resource with a View page
To create a new resource with a View page, you can use the `--view` flag:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-resource User --view
```
## Using an infolist instead of a disabled form
By default, the View page will display a disabled form with the record's data. If you preferred to display the record's data in an "infolist", you can define an `infolist()` method on the resource class:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Infolists;
use Filament\Infolists\Infolist;
public static function infolist(Infolist $infolist): Infolist
{
return $infolist
->schema([
Infolists\Components\TextEntry::make('name'),
Infolists\Components\TextEntry::make('email'),
Infolists\Components\TextEntry::make('notes')
->columnSpanFull(),
]);
}
```
The `schema()` method is used to define the structure of your infolist. It is an array of [entries](../../infolists/entries/getting-started#available-entries) and [layout components](../../infolists/layout/getting-started#available-layout-components), in the order they should appear in your infolist.
Check out the Infolists docs for a [guide](../../infolists/getting-started) on how to build infolists with Filament.
## Adding a View page to an existing resource
If you want to add a View page to an existing resource, create a new page in your resource's `Pages` directory:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-page ViewUser --resource=UserResource --type=ViewRecord
```
You must register this new page in your resource's `getPages()` method:
```php theme={"theme":"gruvbox-dark-hard"}
public static function getPages(): array
{
return [
'index' => Pages\ListUsers::route('/'),
'create' => Pages\CreateUser::route('/create'),
'view' => Pages\ViewUser::route('/{record}'),
'edit' => Pages\EditUser::route('/{record}/edit'),
];
}
```
## Viewing records in modals
If your resource is simple, you may wish to view records in modals rather than on the [View page](./viewing-records). If this is the case, you can just [delete the view page](./getting-started#deleting-resource-pages).
If your resource doesn't contain a `ViewAction`, you can add one to the `$table->actions()` array:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables;
use Filament\Tables\Table;
public static function table(Table $table): Table
{
return $table
->columns([
// ...
])
->actions([
Tables\Actions\ViewAction::make(),
// ...
]);
}
```
## Customizing data before filling the form
You may wish to modify the data from a record before it is filled into the form. To do this, you may define a `mutateFormDataBeforeFill()` method on the View page class to modify the `$data` array, and return the modified version before it is filled into the form:
```php theme={"theme":"gruvbox-dark-hard"}
protected function mutateFormDataBeforeFill(array $data): array
{
$data['user_id'] = auth()->id();
return $data;
}
```
Alternatively, if you're viewing records in a modal action, check out the [Actions documentation](../../actions/prebuilt-actions/view#customizing-data-before-filling-the-form).
## Lifecycle hooks
Hooks may be used to execute code at various points within a page's lifecycle, like before a form is filled. To set up a hook, create a protected method on the View page class with the name of the hook:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Resources\Pages\ViewRecord;
class ViewUser extends ViewRecord
{
// ...
protected function beforeFill(): void
{
// Runs before the disabled form fields are populated from the database. Not run on pages using an infolist.
}
protected function afterFill(): void
{
// Runs after the disabled form fields are populated from the database. Not run on pages using an infolist.
}
}
```
## Authorization
For authorization, Filament will observe any [model policies](https://laravel.com/docs/authorization#creating-policies) that are registered in your app.
Users may access the View page if the `view()` method of the model policy returns `true`.
## Creating another View page
One View page may not be enough space to allow users to navigate a lot of information. You can create as many View pages for a resource as you want. This is especially useful if you are using [resource sub-navigation](./getting-started#resource-sub-navigation), as you are then easily able to switch between the different View pages.
To create a View page, you should use the `make:filament-page` command:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-page ViewCustomerContact --resource=CustomerResource --type=ViewRecord
```
You must register this new page in your resource's `getPages()` method:
```php theme={"theme":"gruvbox-dark-hard"}
public static function getPages(): array
{
return [
'index' => Pages\ListCustomers::route('/'),
'create' => Pages\CreateCustomer::route('/create'),
'view' => Pages\ViewCustomer::route('/{record}'),
'view-contact' => Pages\ViewCustomerContact::route('/{record}/contact'),
'edit' => Pages\EditCustomer::route('/{record}/edit'),
];
}
```
Now, you can define the `infolist()` or `form()` for this page, which can contain other components that are not present on the main View page:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Infolists\Infolist;
public function infolist(Infolist $infolist): Infolist
{
return $infolist
->schema([
// ...
]);
}
```
## Customizing relation managers for a specific view page
You can specify which relation managers should appear on a view page by defining a `getAllRelationManagers()` method:
```php theme={"theme":"gruvbox-dark-hard"}
protected function getAllRelationManagers(): array
{
return [
CustomerAddressesRelationManager::class,
CustomerContactsRelationManager::class,
];
}
```
This is useful when you have [multiple view pages](#creating-another-view-page) and need different relation managers on
each page:
```php theme={"theme":"gruvbox-dark-hard"}
// ViewCustomer.php
protected function getAllRelationManagers(): array
{
return [
RelationManagers\OrdersRelationManager::class,
RelationManagers\SubscriptionsRelationManager::class,
];
}
// ViewCustomerContact.php
protected function getAllRelationManagers(): array
{
return [
RelationManagers\ContactsRelationManager::class,
RelationManagers\AddressesRelationManager::class,
];
}
```
If `getAllRelationManagers()` isn't defined, any relation managers defined in the resource will be used.
## Adding view pages to resource sub-navigation
If you're using [resource sub-navigation](./getting-started#resource-sub-navigation), you can register this page as normal in `getRecordSubNavigation()` of the resource:
```php theme={"theme":"gruvbox-dark-hard"}
use App\Filament\Resources\CustomerResource\Pages;
use Filament\Resources\Pages\Page;
public static function getRecordSubNavigation(Page $page): array
{
return $page->generateNavigationItems([
// ...
Pages\ViewCustomerContact::class,
]);
}
```
## Custom view
For further customization opportunities, you can override the static `$view` property on the page class to a custom view in your app:
```php theme={"theme":"gruvbox-dark-hard"}
protected static string $view = 'filament.resources.users.pages.view-user';
```
This assumes that you have created a view at `resources/views/filament/resources/users/pages/view-user.blade.php`.
Here's a basic example of what that view might contain:
```blade theme={"theme":"gruvbox-dark-hard"}
@if ($this->hasInfolist())
{{ $this->infolist }}
@else
{{ $this->form }}
@endif
@if (count($relationManagers = $this->getRelationManagers()))
@endif
```
To see everything that the default view contains, you can check the `vendor/filament/filament/resources/views/resources/pages/view-record.blade.php` file in your project.
)}
Your logo here