Конфигурация
Опубликуйте файл конфига, чтобы изменить значения по умолчанию для всех ресурсов:
bash
php artisan vendor:publish --tag=filament-relation-navigator-configОпубликованный конфиг продолжает работать в минорных версиях: у каждого ключа есть значение по умолчанию в коде, поэтому новые ключи нужно добавлять, только когда вы хотите их изменить.
Опции
Большинство опций можно задать также для ресурса (статический метод на ресурсе) или для страницы или relation manager:
- Опции меню (
menu.*с методом, навигация по записям, редирект со вкладок): приоритет у страницы, затем у ресурса, затем у конфига. - «Открыть как страницу» и бейдж relation manager в меню: показываются, только если это разрешают все уровни; отключить может любой уровень.
- Ссылки в глобальном поиске: метод ресурса заменяет конфиг для этого ресурса; relation manager может только исключить себя.
- Список, который запоминается для «предыдущей» и «следующей»: решают только ресурс или конфиг, потому что страница списка не может спросить страницу записи.
menu.presets,menu.search_from,menu.max_heightиmenu.separatorзадаются только в конфиге.
| Ключ | По умолчанию | Что делает | Другие уровни |
|---|---|---|---|
menu.preset | 'github' | Вид меню: github, simple, ваш пресет или имя представления | getRelationNavigatorPreset() |
menu.presets | simple, github | Имена и представления пресетов | |
menu.searchable | true | Поле поиска над списком | isRelationNavigatorSearchable() |
menu.search_from | 0 | Показывать поле поиска начиная с этого числа элементов | |
menu.badges | 'lazy' | 'lazy': бейджи загружаются при открытии меню; true: вместе со страницей; false: без бейджей | hasRelationNavigatorBadges(), hasDeferredRelationNavigatorBadges(); relation manager: hasRelationNavigatorBadge() |
menu.max_height | '24rem' | Высота списка, после которой появляется прокрутка (длина CSS) | |
menu.separator | true | Страницы записи и страницы связей двумя блоками | |
menu.mobile | true | Меню над заголовком на маленьких экранах | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | Сочетание клавиш, которое открывает меню; null: без сочетания | getRelationNavigatorShortcut() |
relation_manager_link | true | Действие «Открыть как страницу» в таблицах relation manager | ресурс hasRelationPageLinks(), relation manager hasRelationPageLink() |
relation_manager_action | ссылка со стрелкой | Вид этого действия: style, label, icon, icon_position, color, size, new_tab | configureRelationPageActionUsing(), configureRelationPageAction() |
global_search_actions | false | Ссылки на страницы связей под результатами глобального поиска: true или наибольшее число на результат | ресурс hasRelationPageGlobalSearchActions(), relation manager hasRelationPageGlobalSearchAction() |
record_navigation | false | Кнопки предыдущей и следующей записи | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | «Предыдущая» и «следующая» следуют списку, из которого пришёл пользователь | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | ?relation=x на странице просмотра открывает страницу связи | shouldRedirectRelationNavigatorTabs() |
Методы страницы — это методы экземпляра на странице записи с HasRelationNavigator; на ресурсе тот же метод статический и действует для всех его страниц. См. Страница, ресурс или конфиг.
Файл целиком
В том виде, в каком он поставляется с текущей версией (комментарии на английском):
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,
];