@lexical/link 0.9.0 → 0.9.2

package/LexicalLink.dev.js

@@ -17,6 +17,8 @@ class LinkNode extends lexical.ElementNode {
 
   /** @internal */
 
+  /** @internal */
+
   /** @internal */
   static getType() {
     return 'link';
@@ -25,7 +27,8 @@ class LinkNode extends lexical.ElementNode {
   static clone(node) {
     return new LinkNode(node.__url, {
       rel: node.__rel,
-      target: node.__target
+      target: node.__target,
+      title: node.__title
     }, node.__key);
   }
 
@@ -33,11 +36,13 @@ class LinkNode extends lexical.ElementNode {
     super(key);
     const {
       target = null,
-      rel = null
+      rel = null,
+      title = null
     } = attributes;
     this.__url = url;
     this.__target = target;
     this.__rel = rel;
+    this.__title = title;
   }
 
   createDOM(config) {
@@ -52,6 +57,10 @@ class LinkNode extends lexical.ElementNode {
       element.rel = this.__rel;
     }
 
+    if (this.__title !== null) {
+      element.title = this.__title;
+    }
+
     utils.addClassNamesToElement(element, config.theme.link);
     return element;
   }
@@ -60,6 +69,7 @@ class LinkNode extends lexical.ElementNode {
     const url = this.__url;
     const target = this.__target;
     const rel = this.__rel;
+    const title = this.__title;
 
     if (url !== prevNode.__url) {
       anchor.href = url;
@@ -81,6 +91,14 @@ class LinkNode extends lexical.ElementNode {
       }
     }
 
+    if (title !== prevNode.__title) {
+      if (title) {
+        anchor.title = title;
+      } else {
+        anchor.removeAttribute('title');
+      }
+    }
+
     return false;
   }
 
@@ -96,7 +114,8 @@ class LinkNode extends lexical.ElementNode {
   static importJSON(serializedNode) {
     const node = $createLinkNode(serializedNode.url, {
       rel: serializedNode.rel,
-      target: serializedNode.target
+      target: serializedNode.target,
+      title: serializedNode.title
     });
     node.setFormat(serializedNode.format);
     node.setIndent(serializedNode.indent);
@@ -108,6 +127,7 @@ class LinkNode extends lexical.ElementNode {
     return { ...super.exportJSON(),
       rel: this.getRel(),
       target: this.getTarget(),
+      title: this.getTitle(),
       type: 'link',
       url: this.getURL(),
       version: 1
@@ -141,13 +161,23 @@ class LinkNode extends lexical.ElementNode {
     writable.__rel = rel;
   }
 
+  getTitle() {
+    return this.getLatest().__title;
+  }
+
+  setTitle(title) {
+    const writable = this.getWritable();
+    writable.__title = title;
+  }
+
   insertNewAfter(selection, restoreSelection = true) {
     const element = this.getParentOrThrow().insertNewAfter(selection, restoreSelection);
 
     if (lexical.$isElementNode(element)) {
       const linkNode = $createLinkNode(this.__url, {
         rel: this.__rel,
-        target: this.__target
+        target: this.__target,
+        title: this.__title
       });
       element.append(linkNode);
       return linkNode;
@@ -193,7 +223,8 @@ function convertAnchorElement(domNode) {
     if (content !== null && content !== '') {
       node = $createLinkNode(domNode.getAttribute('href') || '', {
         rel: domNode.getAttribute('rel'),
-        target: domNode.getAttribute('target')
+        target: domNode.getAttribute('target'),
+        title: domNode.getAttribute('title')
       });
     }
   }
@@ -202,10 +233,23 @@ function convertAnchorElement(domNode) {
     node
   };
 }
+/**
+ * Takes a URL and creates a LinkNode.
+ * @param url - The URL the LinkNode should direct to.
+ * @param attributes - Optional HTML a tag attributes { target, rel, title }
+ * @returns The LinkNode.
+ */
+
 
 function $createLinkNode(url, attributes) {
   return lexical.$applyNodeReplacement(new LinkNode(url, attributes));
 }
+/**
+ * Determines if node is a LinkNode.
+ * @param node - The node to be checked.
+ * @returns true if node is a LinkNode, false otherwise.
+ */
+
 function $isLinkNode(node) {
   return node instanceof LinkNode;
 }
@@ -219,14 +263,16 @@ class AutoLinkNode extends LinkNode {
   static clone(node) {
     return new AutoLinkNode(node.__url, {
       rel: node.__rel,
-      target: node.__target
+      target: node.__target,
+      title: node.__title
     }, node.__key);
   }
 
   static importJSON(serializedNode) {
     const node = $createAutoLinkNode(serializedNode.url, {
       rel: serializedNode.rel,
-      target: serializedNode.target
+      target: serializedNode.target,
+      title: serializedNode.title
     });
     node.setFormat(serializedNode.format);
     node.setIndent(serializedNode.indent);
@@ -252,7 +298,8 @@ class AutoLinkNode extends LinkNode {
     if (lexical.$isElementNode(element)) {
       const linkNode = $createAutoLinkNode(this.__url, {
         rel: this._rel,
-        target: this.__target
+        target: this.__target,
+        title: this.__title
       });
       element.append(linkNode);
       return linkNode;
@@ -262,16 +309,38 @@ class AutoLinkNode extends LinkNode {
   }
 
 }
+/**
+ * Takes a URL and creates an AutoLinkNode. AutoLinkNodes are generally automatically generated
+ * during typing, which is especially useful when a button to generate a LinkNode is not practical.
+ * @param url - The URL the LinkNode should direct to.
+ * @param attributes - Optional HTML a tag attributes. { target, rel, title }
+ * @returns The LinkNode.
+ */
+
 function $createAutoLinkNode(url, attributes) {
   return lexical.$applyNodeReplacement(new AutoLinkNode(url, attributes));
 }
+/**
+ * Determines if node is an AutoLinkNode.
+ * @param node - The node to be checked.
+ * @returns true if node is an AutoLinkNode, false otherwise.
+ */
+
 function $isAutoLinkNode(node) {
   return node instanceof AutoLinkNode;
 }
 const TOGGLE_LINK_COMMAND = lexical.createCommand('TOGGLE_LINK_COMMAND');
+/**
+ * Generates or updates a LinkNode. It can also delete a LinkNode if the URL is null,
+ * but saves any children and brings them up to the parent node.
+ * @param url - The URL the link directs to.
+ * @param attributes - Optional HTML a tag attributes. { target, rel, title }
+ */
+
 function toggleLink(url, attributes = {}) {
   const {
-    target
+    target,
+    title
   } = attributes;
   const rel = attributes.rel === undefined ? 'noopener' : attributes.rel;
   const selection = lexical.$getSelection();
@@ -316,6 +385,10 @@ function toggleLink(url, attributes = {}) {
           linkNode.setRel(rel);
         }
 
+        if (title !== undefined) {
+          linkNode.setTitle(title);
+        }
+
         return;
       }
     }
@@ -341,6 +414,10 @@ function toggleLink(url, attributes = {}) {
           linkNode.setRel(rel);
         }
 
+        if (title !== undefined) {
+          linkNode.setTitle(title);
+        }
+
         return;
       }
 
@@ -387,7 +464,7 @@ function toggleLink(url, attributes = {}) {
 }
 
 function $getLinkAncestor(node) {
-  return $getAncestor(node, ancestor => $isLinkNode(ancestor));
+  return $getAncestor(node, $isLinkNode);
 }
 
 function $getAncestor(node, predicate) {

package/LexicalLink.js.flow

@@ -19,21 +19,16 @@ import {$isElementNode, ElementNode} from 'lexical';
 export type LinkAttributes = {
   rel?: null | string,
   target?: null | string,
+  title?: null | string,
 };
 declare export class LinkNode extends ElementNode {
   __url: string;
   __target: null | string;
   __rel: null | string;
+  __title: null | string;
   static getType(): string;
   static clone(node: LinkNode): LinkNode;
-  constructor(
-    url: string,
-    attributes?: {
-      rel?: null | string,
-      target?: null | string,
-    },
-    key?: NodeKey,
-  ): void;
+  constructor(url: string, attributes?: LinkAttributes, key?: NodeKey): void;
   createDOM(config: EditorConfig): HTMLElement;
   updateDOM(
     prevNode: LinkNode,
@@ -47,6 +42,8 @@ declare export class LinkNode extends ElementNode {
   setTarget(target: null | string): void;
   getRel(): null | string;
   setRel(rel: null | string): void;
+  getTitle(): null | string;
+  setTitle(title: null | string): void;
   insertNewAfter(
     selection: RangeSelection,
     restoreSelection?: boolean,
@@ -85,5 +82,5 @@ declare export var TOGGLE_LINK_COMMAND: LexicalCommand<
 >;
 declare export function toggleLink(
   url: null | string,
-  attributes: {target?: null | string, rel?: null | string},
+  attributes: LinkAttributes,
 ): void;

package/LexicalLink.prod.js

@@ -4,12 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-'use strict';var k=require("@lexical/utils"),m=require("lexical");
-class n extends m.ElementNode{static getType(){return"link"}static clone(a){return new n(a.__url,{rel:a.__rel,target:a.__target},a.__key)}constructor(a,b={},c){super(c);let {target:h=null,rel:e=null}=b;this.__url=a;this.__target=h;this.__rel=e}createDOM(a){let b=document.createElement("a");b.href=this.__url;null!==this.__target&&(b.target=this.__target);null!==this.__rel&&(b.rel=this.__rel);k.addClassNamesToElement(b,a.theme.link);return b}updateDOM(a,b){let c=this.__url,h=this.__target,e=this.__rel;
-c!==a.__url&&(b.href=c);h!==a.__target&&(h?b.target=h:b.removeAttribute("target"));e!==a.__rel&&(e?b.rel=e:b.removeAttribute("rel"));return!1}static importDOM(){return{a:()=>({conversion:p,priority:1})}}static importJSON(a){let b=q(a.url,{rel:a.rel,target:a.target});b.setFormat(a.format);b.setIndent(a.indent);b.setDirection(a.direction);return b}exportJSON(){return{...super.exportJSON(),rel:this.getRel(),target:this.getTarget(),type:"link",url:this.getURL(),version:1}}getURL(){return this.getLatest().__url}setURL(a){this.getWritable().__url=
-a}getTarget(){return this.getLatest().__target}setTarget(a){this.getWritable().__target=a}getRel(){return this.getLatest().__rel}setRel(a){this.getWritable().__rel=a}insertNewAfter(a,b=!0){a=this.getParentOrThrow().insertNewAfter(a,b);return m.$isElementNode(a)?(b=q(this.__url,{rel:this.__rel,target:this.__target}),a.append(b),b):null}canInsertTextBefore(){return!1}canInsertTextAfter(){return!1}canBeEmpty(){return!1}isInline(){return!0}extractWithChild(a,b){if(!m.$isRangeSelection(b))return!1;a=b.anchor.getNode();
-let c=b.focus.getNode();return this.isParentOf(a)&&this.isParentOf(c)&&0<b.getTextContent().length}}function p(a){let b=null;if(k.isHTMLAnchorElement(a)){let c=a.textContent;null!==c&&""!==c&&(b=q(a.getAttribute("href")||"",{rel:a.getAttribute("rel"),target:a.getAttribute("target")}))}return{node:b}}function q(a,b){return m.$applyNodeReplacement(new n(a,b))}function r(a){return a instanceof n}
-class u extends n{static getType(){return"autolink"}static clone(a){return new u(a.__url,{rel:a.__rel,target:a.__target},a.__key)}static importJSON(a){let b=v(a.url,{rel:a.rel,target:a.target});b.setFormat(a.format);b.setIndent(a.indent);b.setDirection(a.direction);return b}static importDOM(){return null}exportJSON(){return{...super.exportJSON(),type:"autolink",version:1}}insertNewAfter(a,b=!0){a=this.getParentOrThrow().insertNewAfter(a,b);return m.$isElementNode(a)?(b=v(this.__url,{rel:this._rel,
-target:this.__target}),a.append(b),b):null}}function v(a,b){return m.$applyNodeReplacement(new u(a,b))}let w=m.createCommand("TOGGLE_LINK_COMMAND");function x(a){return y(a,b=>r(b))}function y(a,b){for(;null!==a&&null!==(a=a.getParent())&&!b(a););return a}exports.$createAutoLinkNode=v;exports.$createLinkNode=q;exports.$isAutoLinkNode=function(a){return a instanceof u};exports.$isLinkNode=r;exports.AutoLinkNode=u;exports.LinkNode=n;exports.TOGGLE_LINK_COMMAND=w;
-exports.toggleLink=function(a,b={}){let {target:c}=b,h=void 0===b.rel?"noopener":b.rel;b=m.$getSelection();if(m.$isRangeSelection(b))if(b=b.extract(),null===a)b.forEach(l=>{l=l.getParent();if(r(l)){let d=l.getChildren();for(let f=0;f<d.length;f++)l.insertBefore(d[f]);l.remove()}});else{if(1===b.length){var e=b[0];e=r(e)?e:x(e);if(null!==e){e.setURL(a);void 0!==c&&e.setTarget(c);null!==h&&e.setRel(h);return}}let l=null,d=null;b.forEach(f=>{var g=f.getParent();if(g!==d&&null!==g&&(!m.$isElementNode(f)||
-f.isInline()))if(r(g))d=g,g.setURL(a),void 0!==c&&g.setTarget(c),null!==h&&d.setRel(h);else if(g.is(l)||(l=g,d=q(a,{rel:h,target:c}),r(g)?null===f.getPreviousSibling()?g.insertBefore(d):g.insertAfter(d):f.insertBefore(d)),r(f)){if(!f.is(d)){if(null!==d){g=f.getChildren();for(let t=0;t<g.length;t++)d.append(g[t])}f.remove()}}else null!==d&&d.append(f)})}}
+'use strict';var k=require("@lexical/utils"),n=require("lexical");
+class p extends n.ElementNode{static getType(){return"link"}static clone(a){return new p(a.__url,{rel:a.__rel,target:a.__target,title:a.__title},a.__key)}constructor(a,b={},d){super(d);let {target:l=null,rel:h=null,title:e=null}=b;this.__url=a;this.__target=l;this.__rel=h;this.__title=e}createDOM(a){let b=document.createElement("a");b.href=this.__url;null!==this.__target&&(b.target=this.__target);null!==this.__rel&&(b.rel=this.__rel);null!==this.__title&&(b.title=this.__title);k.addClassNamesToElement(b,
+a.theme.link);return b}updateDOM(a,b){let d=this.__url,l=this.__target,h=this.__rel,e=this.__title;d!==a.__url&&(b.href=d);l!==a.__target&&(l?b.target=l:b.removeAttribute("target"));h!==a.__rel&&(h?b.rel=h:b.removeAttribute("rel"));e!==a.__title&&(e?b.title=e:b.removeAttribute("title"));return!1}static importDOM(){return{a:()=>({conversion:q,priority:1})}}static importJSON(a){let b=r(a.url,{rel:a.rel,target:a.target,title:a.title});b.setFormat(a.format);b.setIndent(a.indent);b.setDirection(a.direction);
+return b}exportJSON(){return{...super.exportJSON(),rel:this.getRel(),target:this.getTarget(),title:this.getTitle(),type:"link",url:this.getURL(),version:1}}getURL(){return this.getLatest().__url}setURL(a){this.getWritable().__url=a}getTarget(){return this.getLatest().__target}setTarget(a){this.getWritable().__target=a}getRel(){return this.getLatest().__rel}setRel(a){this.getWritable().__rel=a}getTitle(){return this.getLatest().__title}setTitle(a){this.getWritable().__title=a}insertNewAfter(a,b=!0){a=
+this.getParentOrThrow().insertNewAfter(a,b);return n.$isElementNode(a)?(b=r(this.__url,{rel:this.__rel,target:this.__target,title:this.__title}),a.append(b),b):null}canInsertTextBefore(){return!1}canInsertTextAfter(){return!1}canBeEmpty(){return!1}isInline(){return!0}extractWithChild(a,b){if(!n.$isRangeSelection(b))return!1;a=b.anchor.getNode();let d=b.focus.getNode();return this.isParentOf(a)&&this.isParentOf(d)&&0<b.getTextContent().length}}
+function q(a){let b=null;if(k.isHTMLAnchorElement(a)){let d=a.textContent;null!==d&&""!==d&&(b=r(a.getAttribute("href")||"",{rel:a.getAttribute("rel"),target:a.getAttribute("target"),title:a.getAttribute("title")}))}return{node:b}}function r(a,b){return n.$applyNodeReplacement(new p(a,b))}function t(a){return a instanceof p}
+class v extends p{static getType(){return"autolink"}static clone(a){return new v(a.__url,{rel:a.__rel,target:a.__target,title:a.__title},a.__key)}static importJSON(a){let b=w(a.url,{rel:a.rel,target:a.target,title:a.title});b.setFormat(a.format);b.setIndent(a.indent);b.setDirection(a.direction);return b}static importDOM(){return null}exportJSON(){return{...super.exportJSON(),type:"autolink",version:1}}insertNewAfter(a,b=!0){a=this.getParentOrThrow().insertNewAfter(a,b);return n.$isElementNode(a)?
+(b=w(this.__url,{rel:this._rel,target:this.__target,title:this.__title}),a.append(b),b):null}}function w(a,b){return n.$applyNodeReplacement(new v(a,b))}let x=n.createCommand("TOGGLE_LINK_COMMAND");function y(a,b){for(;null!==a&&null!==(a=a.getParent())&&!b(a););return a}exports.$createAutoLinkNode=w;exports.$createLinkNode=r;exports.$isAutoLinkNode=function(a){return a instanceof v};exports.$isLinkNode=t;exports.AutoLinkNode=v;exports.LinkNode=p;exports.TOGGLE_LINK_COMMAND=x;
+exports.toggleLink=function(a,b={}){let {target:d,title:l}=b,h=void 0===b.rel?"noopener":b.rel;b=n.$getSelection();if(n.$isRangeSelection(b))if(b=b.extract(),null===a)b.forEach(m=>{m=m.getParent();if(t(m)){let c=m.getChildren();for(let f=0;f<c.length;f++)m.insertBefore(c[f]);m.remove()}});else{if(1===b.length){var e=b[0];e=t(e)?e:y(e,t);if(null!==e){e.setURL(a);void 0!==d&&e.setTarget(d);null!==h&&e.setRel(h);void 0!==l&&e.setTitle(l);return}}let m=null,c=null;b.forEach(f=>{var g=f.getParent();if(g!==
+c&&null!==g&&(!n.$isElementNode(f)||f.isInline()))if(t(g))c=g,g.setURL(a),void 0!==d&&g.setTarget(d),null!==h&&c.setRel(h),void 0!==l&&c.setTitle(l);else if(g.is(m)||(m=g,c=r(a,{rel:h,target:d}),t(g)?null===f.getPreviousSibling()?g.insertBefore(c):g.insertAfter(c):f.insertBefore(c)),t(f)){if(!f.is(c)){if(null!==c){g=f.getChildren();for(let u=0;u<g.length;u++)c.append(g[u])}f.remove()}}else null!==c&&c.append(f)})}}

package/index.d.ts

@@ -11,11 +11,10 @@ import { ElementNode, Spread } from 'lexical';
 export declare type LinkAttributes = {
     rel?: null | string;
     target?: null | string;
+    title?: null | string;
 };
 export declare type SerializedLinkNode = Spread<{
-    type: 'link';
     url: string;
-    version: 1;
 }, Spread<LinkAttributes, SerializedElementNode>>;
 /** @noInheritDoc */
 export declare class LinkNode extends ElementNode {
@@ -25,6 +24,8 @@ export declare class LinkNode extends ElementNode {
     __target: null | string;
     /** @internal */
     __rel: null | string;
+    /** @internal */
+    __title: null | string;
     static getType(): string;
     static clone(node: LinkNode): LinkNode;
     constructor(url: string, attributes?: LinkAttributes, key?: NodeKey);
@@ -39,6 +40,8 @@ export declare class LinkNode extends ElementNode {
     setTarget(target: null | string): void;
     getRel(): null | string;
     setRel(rel: null | string): void;
+    getTitle(): null | string;
+    setTitle(title: null | string): void;
     insertNewAfter(selection: RangeSelection, restoreSelection?: boolean): null | ElementNode;
     canInsertTextBefore(): false;
     canInsertTextAfter(): false;
@@ -46,12 +49,20 @@ export declare class LinkNode extends ElementNode {
     isInline(): true;
     extractWithChild(child: LexicalNode, selection: RangeSelection | NodeSelection | GridSelection, destination: 'clone' | 'html'): boolean;
 }
+/**
+ * Takes a URL and creates a LinkNode.
+ * @param url - The URL the LinkNode should direct to.
+ * @param attributes - Optional HTML a tag attributes { target, rel, title }
+ * @returns The LinkNode.
+ */
 export declare function $createLinkNode(url: string, attributes?: LinkAttributes): LinkNode;
+/**
+ * Determines if node is a LinkNode.
+ * @param node - The node to be checked.
+ * @returns true if node is a LinkNode, false otherwise.
+ */
 export declare function $isLinkNode(node: LexicalNode | null | undefined): node is LinkNode;
-export declare type SerializedAutoLinkNode = Spread<{
-    type: 'autolink';
-    version: 1;
-}, SerializedLinkNode>;
+export declare type SerializedAutoLinkNode = SerializedLinkNode;
 export declare class AutoLinkNode extends LinkNode {
     static getType(): string;
     static clone(node: AutoLinkNode): AutoLinkNode;
@@ -60,9 +71,27 @@ export declare class AutoLinkNode extends LinkNode {
     exportJSON(): SerializedAutoLinkNode;
     insertNewAfter(selection: RangeSelection, restoreSelection?: boolean): null | ElementNode;
 }
+/**
+ * Takes a URL and creates an AutoLinkNode. AutoLinkNodes are generally automatically generated
+ * during typing, which is especially useful when a button to generate a LinkNode is not practical.
+ * @param url - The URL the LinkNode should direct to.
+ * @param attributes - Optional HTML a tag attributes. { target, rel, title }
+ * @returns The LinkNode.
+ */
 export declare function $createAutoLinkNode(url: string, attributes?: LinkAttributes): AutoLinkNode;
+/**
+ * Determines if node is an AutoLinkNode.
+ * @param node - The node to be checked.
+ * @returns true if node is an AutoLinkNode, false otherwise.
+ */
 export declare function $isAutoLinkNode(node: LexicalNode | null | undefined): node is AutoLinkNode;
 export declare const TOGGLE_LINK_COMMAND: LexicalCommand<string | ({
     url: string;
 } & LinkAttributes) | null>;
+/**
+ * Generates or updates a LinkNode. It can also delete a LinkNode if the URL is null,
+ * but saves any children and brings them up to the parent node.
+ * @param url - The URL the link directs to.
+ * @param attributes - Optional HTML a tag attributes. { target, rel, title }
+ */
 export declare function toggleLink(url: null | string, attributes?: LinkAttributes): void;

package/package.json

@@ -8,13 +8,13 @@
     "link"
   ],
   "license": "MIT",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "main": "LexicalLink.js",
   "peerDependencies": {
-    "lexical": "0.9.0"
+    "lexical": "0.9.2"
   },
   "dependencies": {
-    "@lexical/utils": "0.9.0"
+    "@lexical/utils": "0.9.2"
   },
   "repository": {
     "type": "git",