Reimagine Navigation rendering features

config/zeus-sky.php

@@ -58,4 +58,11 @@
      * \LaraZeus\Sky\Editors\RichEditor::class,
      */
     'editor' => \LaraZeus\Sky\Editors\RichEditor::class,
+
+    /**
+     * A list of custom NavLinkRenderer classes for your app.
+     */
+    'navRenderers' => [
+        // Add your custom Nav Renderers here...
+    ],
 ];

resources/views/components/sky-link.blade.php

@@ -0,0 +1,3 @@
+<a {{ $attributes->except(['label', 'hasLabelWrap']) }}>
+    {{ $label }}
+</a>

src/Classes/LinkRenderers/GenericLinkRenderer.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+
+class GenericLinkRenderer extends NavLinkRenderer
+{
+    public function getModel(): ?Model
+    {
+        return null;
+    }
+
+    public function getLink(): ?string
+    {
+        return $this->item['data']['url'];
+    }
+
+    public function isActiveRoute(): bool
+    {
+        return false;
+    }
+}

src/Classes/LinkRenderers/LibraryLinkRenderer.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+use LaraZeus\Sky\Models\Library;
+use LaraZeus\Sky\SkyPlugin;
+
+class LibraryLinkRenderer extends NavLinkRenderer
+{
+    public static string $rendersKey = 'library-link';
+
+    public function getModel(): ?Model
+    {
+        return SkyPlugin::get()->getModel('Tag')::find($this->item['data']['library_id']);
+    }
+
+    public function getLink(): ?string
+    {
+        /**
+         * @var Library $tag
+         */
+        $tag = $this->getModel();
+
+        return route('library.tag', $tag->slug);
+    }
+
+    public function isActiveRoute(): bool
+    {
+        /**
+         * @var Library $tag
+         */
+        $tag = $this->getModel();
+
+        return str(request()->url())->contains($tag->library->first()->slug);
+    }
+}

src/Classes/LinkRenderers/NavLinkRenderer.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+
+abstract class NavLinkRenderer
+{
+    public static string $rendersKey;
+
+    public function __construct(
+        protected array $item
+    ) {
+    }
+
+    public static string $activeClasses = 'border-b border-b-secondary-500 text-secondary-500';
+
+    public static string $nonActiveClasses = 'border-transparent';
+
+    abstract public function getModel(): ?Model;
+
+    abstract public function getLink(): ?string;
+
+    abstract public function isActiveRoute(): bool;
+
+    public function getActiveClass(): string
+    {
+        return $this->isActiveRoute() ?
+                self::$activeClasses :
+                self::$nonActiveClasses;
+    }
+
+    /**
+     * @return array{}
+     */
+    public function getPreparedLink(string $classes = ''): array
+    {
+        return [
+            'class' => $classes . ' ' . $this->getActiveClass(),
+            'target' => $this->item['data']['target'] ?? '_self',
+            'href' => $this->getLink(),
+            'label' => $this->item['label'],
+        ];
+    }
+}

src/Classes/LinkRenderers/PageLinkRenderer.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+use LaraZeus\Sky\Models\Post;
+use LaraZeus\Sky\SkyPlugin;
+
+class PageLinkRenderer extends NavLinkRenderer
+{
+    public static string $rendersKey = 'page-link';
+
+    public function getModel(): ?Model
+    {
+        return SkyPlugin::get()->getModel('Post')::page()
+            ->whereDate('published_at', '<=', now())
+            ->find($this->item['data']['page_id']);
+    }
+
+    public function getLink(): ?string
+    {
+        /**
+         * @var Post $page
+         */
+        $page = $this->getModel();
+
+        return route('page', $page);
+    }
+
+    public function isActiveRoute(): bool
+    {
+        /**
+         * @var Post $page
+         */
+        $page = $this->getModel();
+
+        return request()->routeIs('page', $page);
+    }
+}

src/Classes/LinkRenderers/PostLinkRenderer.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+use LaraZeus\Sky\Models\Post;
+use LaraZeus\Sky\SkyPlugin;
+
+class PostLinkRenderer extends NavLinkRenderer
+{
+    public static string $rendersKey = 'post-link';
+
+    public function getModel(): ?Model
+    {
+        return SkyPlugin::get()->getModel('Post')::whereDate('published_at', '<=', now())
+            ->find($this->item['data']['post_id']);
+    }
+
+    public function getLink(): ?string
+    {
+        /**
+         * @var Post $post
+         */
+        $post = $this->getModel();
+
+        return route('post', $post);
+    }
+
+    public function isActiveRoute(): bool
+    {
+        /**
+         * @var Post $post
+         */
+        $post = $this->getModel();
+
+        return request()->routeIs('post', $post);
+    }
+}

src/Classes/RenderNavItem.php

@@ -2,52 +2,79 @@
 
 namespace LaraZeus\Sky\Classes;
 
-use LaraZeus\Sky\SkyPlugin;
+use Illuminate\Support\Facades\Blade;
+use LaraZeus\Sky\Classes\LinkRenderers\GenericLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\LibraryLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\NavLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\PageLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\PostLinkRenderer;
 
 class RenderNavItem
 {
-    public static function render(array $item, string $class = ''): string
+    /**
+     * @var class-string<NavLinkRenderer>
+     */
+    public static string $defaultRendererClass = GenericLinkRenderer::class;
+
+    /**
+     * Set the default active CSS class(es) on a nav link.
+     *
+     * @return $this
+     */
+    public static function setActiveClasses(string $activeClasses): void
+    {
+        NavLinkRenderer::$activeClasses = $activeClasses;
+    }
+
+    /**
+     * Set the default non-active CSS class(es) on a nav link.
+     *
+     * @return $this
+     */
+    public static function setNonActiveClasses(string $nonActiveClass): void
+    {
+        NavLinkRenderer::$nonActiveClasses = $nonActiveClass;
+    }
+
+    public static function getNavRenderers(): array
     {
-        $color = 'border-b border-b-secondary-500 text-secondary-500';
-
-        if ($item['type'] === 'page-link' || $item['type'] === 'page_link') {
-            $page = SkyPlugin::get()->getModel('Post')::page()->whereDate('published_at', '<=', now())->find($item['data']['page_id']) ?? '';
-            $activeClass = (request()->routeIs('page', $page)) ? $color : 'border-transparent';
-
-            return '<a class="' . $class . ' ' . $activeClass . '"
-                    target="' . ($item['data']['target'] ?? '_self') . '"
-                    href="' . route('page', $page) . '"
-                >' .
-                $item['label'] .
-                '</a>';
-        } elseif ($item['type'] === 'post-link' || $item['type'] === 'post_link') {
-            $post = SkyPlugin::get()->getModel('Post')::find($item['data']['post_id']) ?? '';
-            $activeClass = (request()->routeIs('post', $post)) ? $color : 'border-transparent';
-
-            return '<a class="' . $class . ' ' . $activeClass . '"
-                    target="' . ($item['data']['target'] ?? '_self') . '"
-                    href="' . route('post', $post) . '"
-                >' .
-                $item['label'] .
-                '</a>';
-        } elseif ($item['type'] === 'library-link' || $item['type'] === 'library_link') {
-            $tag = SkyPlugin::get()->getModel('Tag')::find($item['data']['library_id']) ?? '';
-            $activeClass = (str(request()->url())->contains($tag->library->first()->slug)) ? $color : 'border-transparent';
-
-            return '<a class="' . $class . ' ' . $activeClass . '"
-                    target="' . ($item['data']['target'] ?? '_self') . '"
-                    href="' . route('library.tag', $tag->slug) . '"
-                >' .
-                $item['label'] .
-                '</a>';
+        $allRenderers = array_merge([
+            PageLinkRenderer::$rendersKey => PageLinkRenderer::class,
+            PostLinkRenderer::$rendersKey => PostLinkRenderer::class,
+            LibraryLinkRenderer::$rendersKey => LibraryLinkRenderer::class,
+        ], config('zeus-sky.navRenderers', []));
 
+        $renderersMap = [];
+        foreach ($allRenderers as $renderer) {
+            /**
+             * @var NavLinkRenderer $renderer
+             */
+            $renderersMap[$renderer::$rendersKey] = $renderer;
+        }
+
+        return $renderersMap;
+    }
+
+    public static function render(array $item, string $class = ''): string
+    {
+        $itemType = $item['type'];
+        if (str($itemType)->contains('_')) {
+            $itemType = str($itemType)->replace('_', '-')->toString();
+        }
+        $renderersMap = static::getNavRenderers();
+        if (array_key_exists($itemType, $renderersMap)) {
+            $rendererClass = $renderersMap[$itemType];
+            $renderer = new $rendererClass($item);
         } else {
-            return '<a class="' . $class . '"
-                    target="' . ($item['data']['target'] ?? '_self') . '"
-                    href="' . $item['data']['url'] . '"
-                >' .
-                $item['label'] .
-                '</a>';
+            $renderer = new static::$defaultRendererClass($item);
         }
+
+        /**
+         * @var NavLinkRenderer $renderer
+         */
+        return Blade::render(
+            '<x-zeus::sky-link :class="$class" :target="$target" :href="$href" :label="$label"  />',
+            $renderer->getPreparedLink($class)
+        );
     }
 }

src/Components/SkyLink.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace LaraZeus\Sky\Components;
+
+use Illuminate\View\Component;
+
+class SkyLink extends Component
+{
+    public function __construct(
+        public string $label,
+        public ?bool $hasLabelWrap = false,
+    ) {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function render()
+    {
+        return view('zeus.sky-link', $this->data());
+    }
+}

src/Configuration.php

@@ -6,6 +6,7 @@
 use Filament\Forms\Components\Select;
 use Filament\Forms\Components\TextInput;
 use Illuminate\Support\Str;
+use LaraZeus\Sky\Classes\LinkRenderers\NavLinkRenderer;
 
 trait Configuration
 {
@@ -55,6 +56,11 @@ trait Configuration
 
     protected array $itemTypes = [];
 
+    /**
+     * @var class-string<NavLinkRenderer>[]
+     */
+    protected array $navRenderers = [];
+
     protected array | Closure $extraFields = [];
 
     public function navigationGroupLabel(Closure | string $lable): static

src/SkyServiceProvider.php

@@ -5,6 +5,7 @@
 use Filament\Facades\Filament;
 use Filament\Forms\Components\Select;
 use LaraZeus\Core\CoreServiceProvider;
+use LaraZeus\Sky\Components\SkyLink;
 use LaraZeus\Sky\Console\InstallCommand;
 use LaraZeus\Sky\Console\migrateCommand;
 use LaraZeus\Sky\Console\PublishCommand;
@@ -31,6 +32,7 @@ public function configurePackage(Package $package): void
             ->hasConfigFile()
             ->hasCommands($this->getCommands())
             ->hasViews('zeus')
+            ->hasViewComponent('zeus', SkyLink::class)
             ->hasRoute('web');
     }