Skip to content
Cette page est une traduction : en cas de différence, la documentation en anglais fait foi. La lire en anglais

Référence de l'API ​

Tout ce qui suit est de l'API publique, couverte par le versionnage sémantique : elle ne change pas de façon incompatible au sein de la 1.x. Tout ce qui n'est pas listé ici est interne.

Traits ​

TraitOù l'utiliserCe qu'il fait
Concerns\HasRelationPagesune ressourceChaque relation manager a sa propre page
Concerns\InteractsWithRelationPageun relation managerCe relation manager a une page ; lit les propriétés statiques facultatives ci-dessous
Concerns\HasRelationNavigatorune page d'enregistrement (affichage, modification, personnalisée)Le menu du fil d'Ariane, et la page y figure

Tous dans le namespace Wit3\FilamentRelationNavigator.

Sur une ressource ​

Toutes statiques, toutes facultatives.

MéthodeRôle
hasRelationPage(string $slug): boolExclure une relation
canAccessRelationPage(Model $record, string $slug): boolInterdire une page de relation pour un enregistrement (pages, menu, recherche globale, redirection)
relationPageHeader(Schema $schema): SchemaEn-tête au-dessus de la relation sur toutes les pages de relation
getRelationPageHeaderActions(): arrayActions d'en-tête des pages de relation
getRelationPageHeaderWidgets(): array, getRelationPageFooterWidgets(): arrayWidgets des pages de relation (ils reçoivent $record)
hasRelationPageLinks(): bool« Ouvrir comme page » sur ses relation managers
configureRelationPageAction(Action $action, RelationManager $manager): ActionModifier cette action pour cette ressource
hasRelationPageGlobalSearchActions(): boolLiens de recherche globale pour cette ressource
toute méthode d'option, statiqueL'option pour toutes les pages de la ressource

Sur un relation manager ​

Toutes statiques, toutes facultatives. Les propriétés nécessitent InteractsWithRelationPage ; les méthodes fonctionnent sans.

Propriété ou méthodeRôle
$hasRelationPage, hasRelationPage(): boolUne page pour ce relation manager ou non
$relationPageSlug, getRelationPageSlug(): ?stringLe slug de sa page
$hasRelationPageLink, hasRelationPageLink(): bool« Ouvrir comme page » sur sa table
$hasRelationPageGlobalSearchAction, hasRelationPageGlobalSearchAction(): boolSon lien sous les résultats de la recherche globale
$hasRelationNavigatorBadge, hasRelationNavigatorBadge(): boolSon badge dans le menu (l'onglet garde le sien)
getRelationPageTitle(Model $ownerRecord)Titre de sa page ; null garde la valeur par défaut
getRelationPageSubheading(Model $ownerRecord)Sous-titre de sa page
getRelationPageBreadcrumb(Model $ownerRecord): ?stringDernier élément du fil d'Ariane de sa page
relationPageHeader(), getRelationPageHeaderActions(), getRelationPageHeaderWidgets(), getRelationPageFooterWidgets()Comme sur la ressource, pour sa page seulement
configureRelationPageAction(Action $action, RelationManager $manager): ActionModifier son action « Ouvrir comme page »

Le isBadgeLazyLoaded() de Filament (ou $isBadgeLazyLoaded) rend aussi son badge lazy dans le menu.

Sur une page d'enregistrement (HasRelationNavigator) ​

Surchargez n'importe laquelle sur la page :

MéthodeRôle
les méthodes d'optionLes options de cette page
getRelationNavigatorRecordNavigationQuery(): ?BuilderLes enregistrements que parcourent précédent et suivant
withRelationNavigator(array $breadcrumbs): arrayAjouter le menu à un fil d'Ariane que vous construisez vous-même

Votre propre classe de page de relation ​

Étendez Pages\RelationPage (ou lancez php artisan make:filament-relation-navigator CustomerResource), et ajoutez ...CustomerRelationPage::relationRoutes() dans getPages().

MembreRôle
protected static ?array $relationsSeulement ces slugs
protected static array $excludedRelationsJamais ces slugs
protected static ?string $contextPageClé de la page dont elle tient lieu (par défaut : la page d'affichage, sinon la page de modification)
$title, $subheading, $breadcrumb, et toutes les méthodes des pages FilamentComme sur n'importe quelle page Filament

Fonctions utilitaires ​

Méthodes statiques de RelationNavigator :

MéthodeRôle
getItems(string $resource, Model $record, ...)Les éléments du menu d'un enregistrement
getRecordSubNavigation(Page $page): arrayLes mêmes éléments en sous-navigation Filament
getRelationManagerPageUrl(RelationManager $manager): ?stringLa page d'un relation manager, pour vos propres boutons
getGlobalSearchResultActions(string $resource, Model $record): arrayLes liens de recherche globale, à fusionner avec les vôtres
configureRelationPageActionUsing(Closure $callback): voidModifier toutes les actions « Ouvrir comme page »
makeRelationPageAction(RelationManager $manager): ActionConstruire cette action
getRelationPageClass(string $resource): ?stringLa classe de page de relation d'une ressource
RELATION_PAGE_ACTIONNom de l'action « Ouvrir comme page »

RelationNavigatorItem (dans $items) : key, label, url, icon, badge, badgeColor, isActive, isBadgeDeferred, isRelationPage().

Routes, vues et commandes ​

  • Noms des routes : {base des routes de la ressource}.relations.{slug}, pour getUrl('relations.orders', [...]).
  • Vues : filament-relation-navigator::menu.github, menu.simple, menu.mobile, menu.partials.list, menu.partials.trigger-attributes. Leurs variables sont listées dans Votre propre preset.
  • Commandes : make:filament-relation-navigator {resource}, make:filament-relation-navigator-preset {nom} --from=github|simple.
  • Traductions : filament-relation-navigator::navigator.*.

Version 1.8.1, publiée le 2026-11-15 · Licence MIT.