Konfiguration
Veröffentliche die Config-Datei, um die Standardwerte für alle Resources zu ändern:
bash
php artisan vendor:publish --tag=filament-relation-navigator-configEine veröffentlichte Config funktioniert über Minor-Versionen hinweg weiter: jeder Schlüssel hat einen Standardwert im Code, neue Schlüssel musst du also nur ergänzen, wenn du sie ändern willst.
Optionen
Die meisten Optionen lassen sich auch pro Resource (eine statische Methode auf der Resource) oder pro Seite oder Relation Manager setzen:
- Menü-Optionen (
menu.*mit einer Methode, Datensatznavigation, Tab-Weiterleitung): die Seite gewinnt, dann die Resource, dann die Config. - „Als Seite öffnen“ und das Menü-Badge eines Relation Managers: erscheinen nur, wenn jede Ebene es erlaubt; jede Ebene kann sie abschalten.
- Links der globalen Suche: die Methode der Resource ersetzt die Config für diese Resource; ein Relation Manager kann sich nur selbst ausschließen.
- Die gemerkte Liste für vorherigen und nächsten Datensatz: entscheiden nur die Resource oder die Config, da die Listenseite keine Datensatzseite fragen kann.
menu.presets,menu.search_from,menu.max_heightundmenu.separatorgibt es nur in der Config.
| Schlüssel | Standard | Was er tut | Weitere Ebenen |
|---|---|---|---|
menu.preset | 'github' | Das Aussehen des Menüs: github, simple, ein eigenes Preset oder ein View-Name | getRelationNavigatorPreset() |
menu.presets | simple, github | Namen und Views der Presets | |
menu.searchable | true | Ein Suchfeld über der Liste | isRelationNavigatorSearchable() |
menu.search_from | 0 | Das Suchfeld ab dieser Anzahl Einträge zeigen | |
menu.badges | 'lazy' | 'lazy': Badges laden beim Öffnen des Menüs; true: mit der Seite; false: keine | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges(); Relation Manager: hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Höhe der Liste, bevor sie scrollt (eine CSS-Länge) | |
menu.separator | true | Datensatzseiten und Relationsseiten in zwei Blöcken | |
menu.mobile | true | Das Menü über der Überschrift auf kleinen Bildschirmen | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Tastenkürzel, das das Menü öffnet; null: keines | getRelationNavigatorShortcut() |
relation_manager_link | true | Die Aktion „Als Seite öffnen“ an Relation-Manager-Tabellen | Resource hasRelationPageLinks(), Relation Manager hasRelationPageLink() |
relation_manager_action | Link mit Pfeil | Aussehen dieser Aktion: style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Links auf Relationsseiten unter den Ergebnissen der globalen Suche: true oder die maximale Anzahl pro Ergebnis | Resource hasRelationPageGlobalSearchActions(), Relation Manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Buttons für vorherigen und nächsten Datensatz | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | Vorheriger und nächster folgen der Liste, von der der Benutzer kommt | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x auf der Ansichtsseite öffnet die Relationsseite | shouldRedirectRelationNavigatorTabs() |
Seitenmethoden sind Instanzmethoden auf einer Datensatzseite mit HasRelationNavigator; auf einer Resource ist dieselbe Methode statisch und gilt für alle ihre Seiten. Siehe Seite, Resource oder Config.
Die ganze Datei
So, wie sie mit der aktuellen Version ausgeliefert wird (die Kommentare sind auf Englisch):
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,
];