設定
すべてのリソースのデフォルトを変更するには、設定ファイルを公開します。
bash
php artisan vendor:publish --tag=filament-relation-navigator-config公開した設定ファイルは、マイナーバージョンをまたいでもそのまま動作します。すべてのキーにはコード内にデフォルト値があるので、新しいキーは変更したいときだけ追加すれば十分です。
オプション
ほとんどのオプションは、リソース単位(リソースの static メソッド)や、ページまたはリレーションマネージャー単位でも設定できます。
- メニューのオプション(メソッドのある
menu.*、前後のレコード、タブのリダイレクト):ページが最優先で、次にリソース、最後に設定です。 - 「ページとして開く」とリレーションマネージャーのメニューのバッジ:すべてのレベルが許可している場合にだけ表示されます。どのレベルでも無効にできます。
- グローバル検索のリンク:そのリソースでは、リソースのメソッドが設定を置き換えます。リレーションマネージャーは自分を除外することしかできません。
- 前後のレコードのために記憶する一覧:リソースまたは設定だけで決まります。一覧ページからはレコードページに問い合わせられないためです。
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()。リレーションマネージャー:hasRelationNavigatorBadge() |
menu.max_height | '24rem' | スクロールが始まるまでのリストの高さ(CSS の長さ) | |
menu.separator | true | レコードのページとリレーションページを 2 つのブロックに分ける | |
menu.mobile | true | 小さな画面では見出しの上にメニューを表示 | hasRelationNavigatorMobileMenu() |
menu.shortcut | 'alt+shift+r' | メニューを開くキーボードショートカット。null:なし | getRelationNavigatorShortcut() |
relation_manager_link | true | リレーションマネージャーのテーブルの「ページとして開く」アクション | リソース hasRelationPageLinks()、リレーションマネージャー hasRelationPageLink() |
relation_manager_action | 矢印付きのリンク | そのアクションの見た目:style、label、icon、icon_position、color、size、new_tab | configureRelationPageActionUsing()、configureRelationPageAction() |
global_search_actions | false | グローバル検索の結果の下に表示するリレーションページへのリンク:true または結果ごとの最大数 | リソース hasRelationPageGlobalSearchActions()、リレーションマネージャー hasRelationPageGlobalSearchAction() |
record_navigation | false | 前後のレコードのボタン | hasRelationNavigatorRecordNavigation() |
record_navigation_follows_list | true | 前後のレコードが、ユーザーが来た一覧に従う | shouldRelationNavigatorRecordNavigationFollowList() |
redirect_relation_tabs | false | 詳細ページの ?relation=x でリレーションページを開く | shouldRedirectRelationNavigatorTabs() |
ページのメソッドは、HasRelationNavigator を使うレコードのページのインスタンスメソッドです。リソースでは同じメソッドが static になり、そのすべてのページに適用されます。ページ、リソース、設定を参照してください。
ファイル全体
現在のバージョンに含まれているものです(コメントは英語です)。
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,
];