Configuration
Publish the config file to change the defaults for every resource:
bash
php artisan vendor:publish --tag=filament-relation-navigator-configA published config keeps working across minor versions: every key has a default in the code, so new keys only need adding when you want to change them.
Options
Most options can also be set per resource (a static method on the resource) or per page or relation manager:
- Menu options (
menu.*with a method, record navigation, tab redirect): the page wins, then the resource, then the config. - "Open as page" and a relation manager's menu badge: shown only when every level allows it; any level can turn it off.
- Global search links: the resource's method replaces the config for that resource; a relation manager can only leave itself out.
- The list remembered for previous and next: decided by the resource or the config only, since the list page cannot ask a record page.
menu.presets,menu.search_from,menu.max_heightandmenu.separatorare config only.
| Key | Default | What it does | Other levels |
|---|---|---|---|
menu.preset | 'github' | The menu's look: github, simple, a preset of yours or a view name | getRelationNavigatorPreset() |
menu.presets | simple, github | Names and views of the presets | |
menu.searchable | true | A search field on top of the list | isRelationNavigatorSearchable() |
menu.search_from | 0 | Show the search field from this many items | |
menu.badges | 'lazy' | 'lazy': badges load when the menu opens; true: with the page; false: none | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges(); relation manager: hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Height of the list before it scrolls (a CSS length) | |
menu.separator | true | Record pages and relation pages in two blocks | |
menu.mobile | true | The menu above the heading on small screens | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Keyboard shortcut that opens the menu; null: none | getRelationNavigatorShortcut() |
relation_manager_link | true | The "Open as page" action on relation manager tables | resource hasRelationPageLinks(), relation manager hasRelationPageLink() |
relation_manager_action | link with an arrow | Look of that action: style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Links to relation pages under global search results: true or the most per result | resource hasRelationPageGlobalSearchActions(), relation manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Previous and next record buttons | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | Previous and next follow the list the user came from | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x on the view page opens the relation page | shouldRedirectRelationNavigatorTabs() |
Page methods are instance methods on a record page using HasRelationNavigator; on a resource the same method is static and applies to all its pages. See Page, resource or config.
The whole file
As shipped with the current version:
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,
];