Configuration
Publiez le fichier de config pour changer les valeurs par défaut de toutes les ressources :
bash
php artisan vendor:publish --tag=filament-relation-navigator-configUne config publiée continue de fonctionner d'une version mineure à l'autre : chaque clé a une valeur par défaut dans le code, donc il ne faut ajouter les nouvelles clés que si vous voulez les changer.
Options
La plupart des options peuvent aussi se régler par ressource (une méthode statique sur la ressource) ou par page ou relation manager :
- Options du menu (
menu.*avec une méthode, navigation entre enregistrements, redirection des onglets) : la page l'emporte, puis la ressource, puis la config. - « Ouvrir comme page » et le badge d'un relation manager dans le menu : affichés seulement si tous les niveaux l'autorisent ; n'importe quel niveau peut les désactiver.
- Liens de la recherche globale : la méthode de la ressource remplace la config pour cette ressource ; un relation manager peut seulement s'exclure.
- La liste mémorisée pour précédent et suivant : décidée seulement par la ressource ou la config, car la page de liste ne peut pas interroger une page d'enregistrement.
menu.presets,menu.search_from,menu.max_heightetmenu.separatorse règlent uniquement dans la config.
| Clé | Par défaut | Ce qu'elle fait | Autres niveaux |
|---|---|---|---|
menu.preset | 'github' | L'apparence du menu : github, simple, un preset à vous ou un nom de vue | getRelationNavigatorPreset() |
menu.presets | simple, github | Noms et vues des presets | |
menu.searchable | true | Un champ de recherche au-dessus de la liste | isRelationNavigatorSearchable() |
menu.search_from | 0 | Affiche le champ de recherche à partir de ce nombre d'éléments | |
menu.badges | 'lazy' | 'lazy' : les badges se chargent à l'ouverture du menu ; true : avec la page ; false : aucun | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges() ; relation manager : hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Hauteur de la liste avant le défilement (une longueur CSS) | |
menu.separator | true | Pages de l'enregistrement et pages de relation en deux blocs | |
menu.mobile | true | Le menu au-dessus du titre sur les petits écrans | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Raccourci clavier qui ouvre le menu ; null : aucun | getRelationNavigatorShortcut() |
relation_manager_link | true | L'action « Ouvrir comme page » sur les tables des relation managers | ressource hasRelationPageLinks(), relation manager hasRelationPageLink() |
relation_manager_action | lien avec une flèche | Apparence de cette action : style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Liens vers les pages de relation sous les résultats de la recherche globale : true ou le maximum par résultat | ressource hasRelationPageGlobalSearchActions(), relation manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Boutons enregistrement précédent et suivant | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | Précédent et suivant suivent la liste d'où vient l'utilisateur | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x sur la page d'affichage ouvre la page de relation | shouldRedirectRelationNavigatorTabs() |
Les méthodes de page sont des méthodes d'instance sur une page d'enregistrement qui utilise HasRelationNavigator ; sur une ressource, la même méthode est statique et s'applique à toutes ses pages. Voir Page, ressource ou config.
Le fichier complet
Tel qu'il est fourni avec la version actuelle (les commentaires sont en anglais) :
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,
];