Reimagine Navigation rendering features

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 $renders = '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,46 @@
+<?php
+
+namespace LaraZeus\Sky\Classes\LinkRenderers;
+
+use Illuminate\Database\Eloquent\Model;
+
+abstract class NavLinkRenderer
+{
+    public static string $renders;
+
+    public function __construct(
+        protected array $item
+    ) {
+    }
+
+    // TODO: something to control these classes for end-user?
+    public static string $activeClasses = 'border-b border-b-secondary-500 text-secondary-500';
+
+    public static string $defaultActiveClass = '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::$defaultActiveClass;
+    }
+
+    /**
+     * @return array{}
+     */
+    public function getPreparedLink(string $classes = ''): array
+    {
+        return [
+            'classes' => $classes . ' ' . $this->getActiveClass(),
+            'target' => $this->item['data']['target'] ?? '_self',
+            'link' => $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 $renders = '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 $renders = '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,51 @@
 
 namespace LaraZeus\Sky\Classes;
 
+use LaraZeus\Sky\Classes\LinkRenderers\GenericLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\NavLinkRenderer;
 use LaraZeus\Sky\SkyPlugin;
 
 class RenderNavItem
 {
-    public static function render(array $item, string $class = ''): string
-    {
-        $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) . '"
+    /**
+     * @var class-string<NavLinkRenderer>
+     */
+    public static string $defaultRendererClass = GenericLinkRenderer::class;
+
+    private static function anchorLink(
+        string $classes,
+        string $target,
+        string $link,
+        string $label,
+    ): string {
+        // TODO: make this component based?
+        // Then it's probably easier for users to further customize this?
+        return '<a class="' . $classes . '"
+                    target="' . $target . '"
+                    href="' . $link . '"
                 >' .
-                $item['label'] .
-                '</a>';
+            $label . // TODO: allow optional wrapping link text in span?
+            // Or maybe support this customization via components?
+            '</a>';
+    }
 
+    public static function render(array $item, string $class = ''): string
+    {
+        $itemType = $item['type'];
+        if (str($itemType)->contains('_')) {
+            $itemType = str($itemType)->replace('_', '-')->toString();
+        }
+        $renderersMap = SkyPlugin::get()->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 static::anchorLink(...$renderer->getPreparedLink($class));
     }
 }

src/Configuration.php

@@ -6,6 +6,10 @@
 use Filament\Forms\Components\Select;
 use Filament\Forms\Components\TextInput;
 use Illuminate\Support\Str;
+use LaraZeus\Sky\Classes\LinkRenderers\LibraryLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\NavLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\PageLinkRenderer;
+use LaraZeus\Sky\Classes\LinkRenderers\PostLinkRenderer;
 
 trait Configuration
 {
@@ -55,6 +59,11 @@ trait Configuration
 
     protected array $itemTypes = [];
 
+    /**
+     * @var class-string<NavLinkRenderer>[]
+     */
+    protected array $navRenderers = [];
+
     protected array | Closure $extraFields = [];
 
     public function navigationGroupLabel(Closure | string $lable): static
@@ -279,4 +288,27 @@ public function hideResources(array $resources = []): static
 
         return $this;
     }
+
+    /**
+     * @param  class-string<NavLinkRenderer>  $rendererClass
+     * @return $this
+     */
+    public function navRenderer(string $rendererClass): static
+    {
+        $this->navRenderers[$rendererClass::$renders] = $rendererClass;
+
+        return $this;
+    }
+
+    public function getNavRenderers(): array
+    {
+        return array_merge(
+            [
+                PageLinkRenderer::$renders => PageLinkRenderer::class,
+                PostLinkRenderer::$renders => PostLinkRenderer::class,
+                LibraryLinkRenderer::$renders => LibraryLinkRenderer::class,
+            ],
+            $this->navRenderers
+        );
+    }
 }