Clustery

Nastavení je deset obrazovek, které k sobě patří. V menu mají být jednou položkou, v adresním řádku jedním prefixem, a kdo je na jedné z nich, má mít zbylých devět na jedno kliknutí. Cluster je taková sekce, deklarovaná jako jedna třída, kterou jmenují její členové.

menu                 URL                             na stránce
─────────            ───────────────────────────     ─────────────────────────────
Settings      →      /admin/settings                 přesměruje na prvního člena
                     /admin/settings/currencies      Currencies │ Taxes │ Mail
                     /admin/settings/taxes           stejní členové, označené Taxes

Jak to funguje

Cluster je Page — Clusters\Cluster ji rozšiřuje —, takže se registruje, routuje a zobrazuje v menu přesně jako vlastní stránka, ze stejných statických vlastností. Všechno ostatní plyne z jednoho řádku na každém členovi: člen jmenuje svůj cluster.

Členství mění pět věcí a každou vlastní vrstva, která tu práci už dělala:

Adresa clusteru přesměrovává. Nic nevykreslí: pošle uživatele na prvního člena, kterého smí otevřít, v pořadí, v jakém se členové kreslí, a přeskočí toho, jehož routa by ho odmítla. Když odmítnou všichni, je to 403; cluster, který nikdo nejmenuje, je 404.

Členové se kreslí z vlastních položek menu. Každý člen už deklaruje navigation() — popisek, ikonu, pořadí, badge, viditelnost — a cluster kreslí právě tyhle, v pořadí sort(), bez skrytých. Nic nového se pro to nedeklaruje a člen, který žádnou položku nedeklaruje, je routovaný pod prefixem, ale v navigaci chybí, stejně jako by chyběl v menu. Aktuální člen se pozná podle registrovaného klíče, takže resource zůstane označený i na své editační stránce, nejen na seznamu. Cluster s jedním viditelným členem navigaci nekreslí: jedna záložka by byla nadpis stránky napsaný podruhé.

Pasti. Člen, který jmenuje třídu, jež není cluster, cluster, který není registrovaný, nebo cluster v jiném clusteru, se odmítne výjimkou ClusterException při registraci rout — nikdy to není stránka potichu routovaná v kořeni, mimo oprávnění sekce. A vnořený resource sedí tam, kde jeho rodič: jeho stránky se routují pod záznamem rodiče, a tedy i pod rodičovým clusterem.

Deklarace clusteru

use NyonCode\WirePanels\Clusters\Cluster;
use NyonCode\WirePanels\Enums\SubNavigationPosition;
 
final class Settings extends Cluster
{
    protected static ?string $navigationIcon = 'outline:cog-6-tooth';   
    protected static ?string $navigationGroup = 'admin';
    protected static int $navigationSort = 90;
    protected static ?string $permission = 'settings.view';
    protected static SubNavigationPosition $subNavigationPosition = SubNavigationPosition::Start;   
}

a zaregistrujte ho stejně jako stránku — config('wire-panels.pages') nebo objevovanou složkou:

// config/wire-panels.php
'pages' => [App\Clusters\Settings::class],

php artisan make:wire-cluster Settings zapíše třídu do app/Clusters/ a řekne, který z obou kroků zbývá.

Jak do něj dát obrazovku

Stránka jmenuje svůj cluster statickou vlastností:

use NyonCode\WirePanels\Pages\Page;
 
final class Taxes extends Page
{
    protected static string $view = 'livewire.settings.taxes';
 
    protected static ?string $cluster = Settings::class;   
 
    protected static int $navigationSort = 20;
}

Resource implementuje BelongsToCluster, což je jedna metoda:

use NyonCode\WireCore\Core\Resources\Concerns\DescribesRecords;
use NyonCode\WireCore\Core\Resources\Contracts\DescribesResource;
use NyonCode\WireCore\Core\Resources\Contracts\ProvidesNavigation;
use NyonCode\WireCore\Core\Resources\Navigation\NavigationItem;
use NyonCode\WireCore\Foundation\Routing\Contracts\BelongsToCluster;
use NyonCode\WireCore\Foundation\Routing\Contracts\ProvidesPages;
 
final class CurrencyResource implements BelongsToCluster, DescribesResource, ProvidesNavigation, ProvidesPages
{
    use DescribesRecords;
 
    public static function cluster(): ?string   
    {
        return Settings::class;
    }                                            
 
    public static function modelClass(): ?string
    {
        return Currency::class;
    }
 
    public static function navigation(): NavigationItem
    {
        return NavigationItem::make()->icon('outline:banknotes')->sort(10);
    }
 
    public static function pages(): array
    {
        return ['index' => ListCurrencies::class, 'edit' => EditCurrency::class];
    }
}

php artisan make:wire-page Taxes --cluster=Settings zapíše stránku člena, která tu statickou vlastnost už má.

Kde se členové kreslí

$subNavigationPosition bere SubNavigationPosition:

Sloupec na telefonu je sloupec, ke kterému nikdo nesroluje, takže pod lg jsou záložky v každé poloze. Sloupec rozkládá pár řádků obyčejného CSS navázaných na atribut stránky data-cluster-frame, ne utility třídy, takže nezávisí na tom, co zrovna obsahuje Tailwind build aplikace.

Odkazy do clusteru

Na odkazování se nic nemění. Člen si nechá svůj klíč i jméno routy, takže:

CurrencyResource::url();              // /admin/settings/currencies
CurrencyResource::url('edit', $eur);  // /admin/settings/currencies/3/edit
Settings::url();                      // /admin/settings — pošle vás na prvního člena

Ručně napsaná cesta člena do clusteru nenásleduje; odkaz postavený přes klíč nebo přes třídu ano.

Co cluster deklaruje

A na členovi:

ClusterNavigation je jediný vlastník, kterého se ptá router, menu i stránka: clusterOf($class), members($cluster), items($cluster, $zone), landing($cluster, $zone, $user) a for($member, $zone).

Související

• Navigace — menu, ve kterém sedí položka clusteru, a parent() pro větev, která zůstává v sidebaru
• Stránky — Page, kterou cluster je, a vlastní záložky záznamu
• Routování — prefixy, jména rout a url()
• Příkazová řádka — make:wire-cluster a make:wire-page --cluster