Configurazione
Pubblica il file di config per cambiare i valori predefiniti di tutte le resource:
bash
php artisan vendor:publish --tag=filament-relation-navigator-configUna config pubblicata continua a funzionare nelle versioni minor: ogni chiave ha un valore predefinito nel codice, quindi le chiavi nuove vanno aggiunte solo quando vuoi cambiarle.
Opzioni
Quasi tutte le opzioni si possono impostare anche per resource (un metodo statico sulla resource) o per pagina o relation manager:
- Opzioni del menu (
menu.*con un metodo, precedente/successivo, redirect delle schede): vince la pagina, poi la resource, poi la config. - «Apri come pagina» e il badge di un relation manager nel menu: compaiono solo se tutti i livelli lo permettono; qualsiasi livello può spegnerli.
- Link della ricerca globale: il metodo della resource sostituisce la config per quella resource; un relation manager può solo escludersi.
- La lista ricordata per precedente e successivo: la decidono solo la resource o la config, perché la pagina della lista non può chiederlo a una pagina del record.
menu.presets,menu.search_from,menu.max_heightemenu.separatorsono solo nella config.
| Chiave | Predefinito | Cosa fa | Altri livelli |
|---|---|---|---|
menu.preset | 'github' | L'aspetto del menu: github, simple, un tuo preset o il nome di una vista | getRelationNavigatorPreset() |
menu.presets | simple, github | Nomi e viste dei preset | |
menu.searchable | true | Un campo di ricerca sopra la lista | isRelationNavigatorSearchable() |
menu.search_from | 0 | Mostra il campo di ricerca da questo numero di voci | |
menu.badges | 'lazy' | 'lazy': i badge arrivano all'apertura del menu; true: con la pagina; false: niente | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges(); relation manager: hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Altezza della lista prima dello scorrimento (una lunghezza CSS) | |
menu.separator | true | Pagine del record e pagine delle relazioni in due blocchi | |
menu.mobile | true | Il menu sopra il titolo sugli schermi piccoli | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Scorciatoia da tastiera che apre il menu; null: nessuna | getRelationNavigatorShortcut() |
relation_manager_link | true | L'azione «Apri come pagina» sulle tabelle dei relation manager | resource hasRelationPageLinks(), relation manager hasRelationPageLink() |
relation_manager_action | link con freccia | Aspetto di quell'azione: style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Link alle pagine delle relazioni sotto i risultati della ricerca globale: true o il massimo per risultato | resource hasRelationPageGlobalSearchActions(), relation manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Pulsanti record precedente e successivo | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | Precedente e successivo seguono la lista da cui arrivi | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x sulla pagina di visualizzazione apre la pagina della relazione | shouldRedirectRelationNavigatorTabs() |
I metodi di pagina sono metodi d'istanza su una pagina del record che usa HasRelationNavigator; su una resource lo stesso metodo è statico e vale per tutte le sue pagine. Vedi Pagina, resource o config.
Il file completo
Come arriva con la versione attuale (i commenti sono in inglese):
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,
];