Merge pull request #583 from awcodes/feat/link-protocols

Feat: allow link protocols for deep links

Author: awcodes

config/filament-tiptap-editor.php

@@ -113,4 +113,15 @@
     |
     */
     'preset_colors' => [],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Protocols
+    |--------------------------------------------------------------------------
+    |
+    | With newer versions of Tiptap, you need to define additional protocols
+    | for the link extension. i.e. 'ftp', 'mailto', etc.
+    |
+    */
+    'link_protocols' => [],
 ];

resources/dist/filament-tiptap-editor.js

@@ -175,6 +175,7 @@ export default function tiptap({
    getSearchResultsUsing,
    mentionDebounce,
    mentionSearchStrategy,
+    linkProtocols = [],
 }) {
     let editor = null;
 
@@ -321,6 +322,14 @@ export default function tiptap({
                             if (['ordered-list', 'bullet-list', 'checked-list'].includes(tool)) {
                                 extensions.push(e)
                                 if (!extensions.includes(ListItem)) extensions.push(ListItem);
+                            } else if (tool === 'link') {
+                                if (linkProtocols?.length) {
+                                    extensions.push(e.configure({
+                                        protocols: linkProtocols,
+                                    }))
+                                } else {
+                                    extensions.push(e)
+                                }
                             } else {
                                 extensions.push(e)
                             }

resources/js/plugin.js

@@ -71,6 +71,7 @@ class="relative z-0 tiptap-wrapper rounded-md bg-white dark:bg-gray-900 focus-wi
                         },
                         mentionDebounce: @js($mentionDebounce),
                         mentionSearchStrategy: @js($mentionSearchStrategy),
+                        linkProtocols: @js(config('filament-tiptap-editor.link_protocols')),
                     })"
                     x-init="$nextTick(() => { init() })"
                     x-on:click.away="blur()"

resources/views/tiptap-editor.blade.php

@@ -88,7 +88,9 @@ public function getExtensions(): array
             new Underline,
             new Superscript,
             new Subscript,
-            new Marks\Link,
+            new Marks\Link([
+                'protocols' => config('filament-tiptap-editor.link_protocols', []),
+            ]),
             new Marks\Small,
             ...$customExtensions,
         ];