Skip to content
Esta página é uma tradução: se algo estiver diferente, a documentação em inglês é a referência. Ler em inglês

Referência da API ​

Tudo o que está abaixo é API pública, coberta pelo versionamento semântico: não muda de forma incompatível dentro da 1.x. O que não está listado aqui é interno.

Traits ​

TraitOnde usarO que faz
Concerns\HasRelationPagesum resourceCada relation manager ganha sua própria página
Concerns\InteractsWithRelationPageum relation managerEste relation manager ganha uma página; lê as propriedades static opcionais abaixo
Concerns\HasRelationNavigatoruma página do registro (visualização, edição, personalizada)O menu no breadcrumb, e a página aparece nele

Todos no namespace Wit3\FilamentRelationNavigator.

Em um resource ​

Todos static, todos opcionais.

MétodoPara que serve
hasRelationPage(string $slug): boolDeixar uma relação de fora
canAccessRelationPage(Model $record, string $slug): boolVetar uma página de relação para um registro (páginas, menu, pesquisa global, redirecionamento)
relationPageHeader(Schema $schema): SchemaCabeçalho acima da relação em todas as páginas de relação
getRelationPageHeaderActions(): arrayAções de cabeçalho das páginas de relação
getRelationPageHeaderWidgets(): array, getRelationPageFooterWidgets(): arrayWidgets das páginas de relação (recebem $record)
hasRelationPageLinks(): bool"Abrir como página" nos seus relation managers
configureRelationPageAction(Action $action, RelationManager $manager): ActionMudar essa ação para este resource
hasRelationPageGlobalSearchActions(): boolLinks da pesquisa global para este resource
qualquer método de opção, staticA opção para todas as páginas do resource

Em um relation manager ​

Todos static, todos opcionais. As propriedades exigem InteractsWithRelationPage; os métodos funcionam sem ele.

Propriedade ou métodoPara que serve
$hasRelationPage, hasRelationPage(): boolUma página para este relation manager ou não
$relationPageSlug, getRelationPageSlug(): ?stringO slug da página dele
$hasRelationPageLink, hasRelationPageLink(): bool"Abrir como página" na tabela dele
$hasRelationPageGlobalSearchAction, hasRelationPageGlobalSearchAction(): boolO link dele abaixo dos resultados da pesquisa global
$hasRelationNavigatorBadge, hasRelationNavigatorBadge(): boolO badge dele no menu (a aba mantém o seu)
getRelationPageTitle(Model $ownerRecord)Título da página dele; null mantém o padrão
getRelationPageSubheading(Model $ownerRecord)Subtítulo da página dele
getRelationPageBreadcrumb(Model $ownerRecord): ?stringÚltimo item do breadcrumb da página dele
relationPageHeader(), getRelationPageHeaderActions(), getRelationPageHeaderWidgets(), getRelationPageFooterWidgets()Como no resource, só para a página dele
configureRelationPageAction(Action $action, RelationManager $manager): ActionMudar a ação "Abrir como página" dele

O isBadgeLazyLoaded() do próprio Filament (ou $isBadgeLazyLoaded) também deixa o badge dele no menu lazy.

Em uma página do registro (HasRelationNavigator) ​

Sobrescreva qualquer um deles na página:

MétodoPara que serve
os métodos de opçãoAs opções desta página
getRelationNavigatorRecordNavigationQuery(): ?BuilderOs registros que anterior e próximo percorrem
withRelationNavigator(array $breadcrumbs): arrayAdicionar o menu a breadcrumbs que você mesmo monta

Uma classe de página de relação sua ​

Estenda Pages\RelationPage (ou rode php artisan make:filament-relation-navigator CustomerResource) e espalhe ...CustomerRelationPage::relationRoutes() em getPages().

MembroPara que serve
protected static ?array $relationsSó estes slugs
protected static array $excludedRelationsNunca estes slugs
protected static ?string $contextPageChave da página que ela representa (padrão: a página de visualização, senão a de edição)
$title, $subheading, $breadcrumb e todos os métodos de página do FilamentComo em qualquer página do Filament

Helpers ​

Métodos static de RelationNavigator:

MétodoPara que serve
getItems(string $resource, Model $record, ...)Os itens do menu de um registro
getRecordSubNavigation(Page $page): arrayOs mesmos itens como subnavegação do Filament
getRelationManagerPageUrl(RelationManager $manager): ?stringA página de um relation manager, para botões seus
getGlobalSearchResultActions(string $resource, Model $record): arrayLinks da pesquisa global, para juntar aos seus
configureRelationPageActionUsing(Closure $callback): voidMudar todas as ações "Abrir como página"
makeRelationPageAction(RelationManager $manager): ActionMontar essa ação
getRelationPageClass(string $resource): ?stringA classe de página de relação de um resource
RELATION_PAGE_ACTIONNome da ação "Abrir como página"

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

Rotas, views e comandos ​

  • Nomes das rotas: {base das rotas do resource}.relations.{slug}, para getUrl('relations.orders', [...]).
  • Views: filament-relation-navigator::menu.github, menu.simple, menu.mobile, menu.partials.list, menu.partials.trigger-attributes. As variáveis delas estão em Um preset só seu.
  • Comandos: make:filament-relation-navigator {resource}, make:filament-relation-navigator-preset {nome} --from=github|simple.
  • Traduções: filament-relation-navigator::navigator.*.

Versão 1.8.1, lançada em 2026-11-15 · Licença MIT.