Configuración
Publica el archivo de config para cambiar los valores predeterminados de todos los recursos:
bash
php artisan vendor:publish --tag=filament-relation-navigator-configUna config publicada sigue funcionando entre versiones minor: cada clave tiene un valor predeterminado en el código, así que solo tienes que añadir las claves nuevas cuando quieras cambiarlas.
Opciones
La mayoría de las opciones también se pueden definir por recurso (un método static en el recurso) o por página o relation manager:
- Opciones del menú (
menu.*con un método, navegación entre registros, redirección de pestañas): gana la página, después el recurso, después la config. - «Abrir como página» y el badge de un relation manager en el menú: se muestran solo cuando todos los niveles lo permiten; cualquier nivel puede desactivarlos.
- Enlaces de la búsqueda global: el método del recurso reemplaza la config para ese recurso; un relation manager solo puede excluirse.
- La lista que se recuerda para anterior y siguiente: la deciden solo el recurso o la config, porque la página de la lista no puede preguntarle a una página del registro.
menu.presets,menu.search_from,menu.max_heightymenu.separatorsolo están en la config.
| Clave | Predeterminado | Qué hace | Otros niveles |
|---|---|---|---|
menu.preset | 'github' | El aspecto del menú: github, simple, un preset tuyo o el nombre de una vista | getRelationNavigatorPreset() |
menu.presets | simple, github | Nombres y vistas de los presets | |
menu.searchable | true | Un campo de búsqueda encima de la lista | isRelationNavigatorSearchable() |
menu.search_from | 0 | Muestra el campo de búsqueda a partir de este número de elementos | |
menu.badges | 'lazy' | 'lazy': los badges se cargan al abrir el menú; true: con la página; false: ninguno | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges(); relation manager: hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Altura de la lista antes de que aparezca el scroll (una longitud CSS) | |
menu.separator | true | Páginas del registro y páginas de relación en dos bloques | |
menu.mobile | true | El menú encima del título en pantallas pequeñas | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Atajo de teclado que abre el menú; null: ninguno | getRelationNavigatorShortcut() |
relation_manager_link | true | La acción «Abrir como página» en las tablas de los relation managers | recurso hasRelationPageLinks(), relation manager hasRelationPageLink() |
relation_manager_action | enlace con flecha | Aspecto de esa acción: style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Enlaces a las páginas de relación bajo los resultados de la búsqueda global: true o el máximo por resultado | recurso hasRelationPageGlobalSearchActions(), relation manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Botones de registro anterior y siguiente | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | Anterior y siguiente siguen la lista de la que viene el usuario | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x en la página de vista abre la página de relación | shouldRedirectRelationNavigatorTabs() |
Los métodos de página son métodos de instancia en una página del registro que usa HasRelationNavigator; en un recurso, el mismo método es static y se aplica a todas sus páginas. Consulta Página, recurso o config.
El archivo completo
Tal como viene con la versión actual (los comentarios están en inglés):
php
<?php
return [
/*
|--------------------------------------------------------------------------
| Breadcrumb menu
|--------------------------------------------------------------------------
|
| `preset` picks one of `presets`:
|
| - github (default): the last breadcrumb stays text, a caret next to it
| opens a panel with a heading and a check on the current page
| (like GitHub's "Switch repository").
| - simple: the last breadcrumb itself opens the list.
|
| `searchable` adds a search field on top of the list, whatever the
| preset; Enter opens the first match. For the menu of 1.2 and earlier,
| set `'preset' => 'simple'` and `'searchable' => false`.
|
| Add your own preset by pointing a name to any view, or publish the
| package views and change them:
|
| php artisan vendor:publish --tag=filament-relation-navigator-views
|
| A page can override these with getRelationNavigatorPreset(),
| isRelationNavigatorSearchable() and hasRelationNavigatorBadges().
|
*/
'menu' => [
'preset' => 'github',
'presets' => [
'simple' => 'filament-relation-navigator::menu.simple',
'github' => 'filament-relation-navigator::menu.github',
],
'searchable' => true,
// With `searchable`, the search field appears from this many items.
'search_from' => 0,
// The relation managers' badges, as in their tabs. 'lazy' (default)
// loads them when the menu opens, so the page renders without their
// queries; true renders them with the page; false turns them off. A
// relation manager can leave its badge out: hasRelationNavigatorBadge().
'badges' => 'lazy',
'max_height' => '24rem',
// The record pages and the relation pages in two blocks.
'separator' => true,
// Filament hides the breadcrumbs on small screens: show the menu
// above the page heading there.
'mobile' => true,
// Opens the menu from anywhere on the page, outside text fields:
// modifiers (alt, shift, ctrl, meta, or mod: ⌘ on a Mac, Ctrl
// elsewhere) plus a letter, a digit or / . , ; Null turns it off.
// A shortcut of the panel's global search is ignored, never doubled.
'shortcut' => 'alt+shift+r',
],
/*
|--------------------------------------------------------------------------
| Relation managers on the record pages
|--------------------------------------------------------------------------
|
| An "Open as page" action in the header of the table of every relation
| manager that has its own page, on the view and edit pages. Per resource:
| hasRelationPageLinks(); per relation manager: hasRelationPageLink().
|
*/
'relation_manager_link' => true,
// Its look. `style`: link, button or icon_button (the label becomes a
// tooltip). `label`: text or translation key (null: "Open as page",
// translated). `icon`: any Filament icon, or null for none. For more,
// RelationNavigator::configureRelationPageActionUsing() in a service
// provider, or configureRelationPageAction() on a resource or a relation
// manager.
'relation_manager_action' => [
'style' => 'link',
'label' => null,
'icon' => 'heroicon-m-arrow-up-right',
'icon_position' => 'after',
'color' => 'gray',
'size' => null,
'new_tab' => false,
],
/*
|--------------------------------------------------------------------------
| Global search
|--------------------------------------------------------------------------
|
| Links to the record's relation pages under its global search results:
| false, true, or the most links to show per result. Per resource:
| hasRelationPageGlobalSearchActions(); per relation manager:
| hasRelationPageGlobalSearchAction(). They run the relation managers'
| canViewForRecord() for every result.
|
*/
'global_search_actions' => false,
/*
|--------------------------------------------------------------------------
| Previous and next record
|--------------------------------------------------------------------------
|
| Two buttons before the header actions of the pages with the menu: they
| open the previous or the next record on the same page. Off by
| default: they add a few queries per render. Per page, override
| hasRelationNavigatorRecordNavigation(); to change the records,
| getRelationNavigatorRecordNavigationQuery(). Not for nested resources.
|
*/
'record_navigation' => false,
// Previous and next follow the list the user came from (the list page,
// or the parent's relation manager for a nested resource): its sort,
// filters, search and tab (up to 100 records), instead of the key order.
'record_navigation_follows_list' => true,
/*
|--------------------------------------------------------------------------
| Links to relation manager tabs
|--------------------------------------------------------------------------
|
| A link to a tab of the view or edit page (`/customers/1?relation=bills`)
| opens the relation page instead (`/customers/1/bills`). Handy once the
| relation pages replace the tabs; off by default.
|
*/
'redirect_relation_tabs' => false,
];