add optionalSlashSlash to protocol options (#3675)

* add optionalSlashSlash to protocol options * Update documentation * rename optionalSlashSlash to optionalSlashes * regenerate package-lock.json with node v16
ueberdosis · Feb 27, 2023 · 1ac3070 · 1ac3070
1 parent 8262564
commit 1ac3070
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 8 deletions.
diff --git a/docs/api/marks/link.md b/docs/api/marks/link.md
@@ -31,6 +31,18 @@ Link.configure({
 })
 ```
 
+By default, [linkify](https://linkify.js.org/docs/) adds `//` to the end of a protocol however this behavior can be changed by passing `optionalSlashes` option
+```js
+Link.configure({
+  protocols: [
+    {
+      scheme: 'tel',
+      optionalSlashes: true
+    }
+  ]
+})
+```
+
 ### autolink
 If enabled, it adds links as you type.
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/extension-link/package.json b/packages/extension-link/package.json
@@ -37,7 +37,7 @@
     "@tiptap/pm": "^2.0.0-beta.218"
   },
   "dependencies": {
-    "linkifyjs": "^3.0.5"
+    "linkifyjs": "^4.1.0"
   },
   "repository": {
     "type": "git",

diff --git a/packages/extension-link/src/link.ts b/packages/extension-link/src/link.ts
@@ -6,6 +6,11 @@ import { autolink } from './helpers/autolink'
 import { clickHandler } from './helpers/clickHandler'
 import { pasteHandler } from './helpers/pasteHandler'
 
+export interface LinkProtocolOptions {
+  scheme: string;
+  optionalSlashes?: boolean;
+}
+
 export interface LinkOptions {
   /**
    * If enabled, it adds links as you type.
@@ -14,7 +19,7 @@ export interface LinkOptions {
   /**
    * An array of custom protocols to be registered with linkifyjs.
    */
-  protocols: Array<string>
+  protocols: Array<LinkProtocolOptions | string>
   /**
    * If enabled, links will be opened on click.
    */
@@ -62,7 +67,13 @@ export const Link = Mark.create<LinkOptions>({
   keepOnSplit: false,
 
   onCreate() {
-    this.options.protocols.forEach(registerCustomProtocol)
+    this.options.protocols.forEach(protocol => {
+      if (typeof protocol === 'string') {
+        registerCustomProtocol(protocol)
+        return
+      }
+      registerCustomProtocol(protocol.scheme, protocol.optionalSlashes)
+    })
   },
 
   onDestroy() {