@lexical/list 0.8.1 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LexicalList.dev.js +456 -100
- package/LexicalList.prod.js +20 -20
- package/LexicalListItemNode.d.ts +11 -0
- package/LexicalListNode.d.ts +11 -0
- package/formatList.d.ts +52 -0
- package/package.json +3 -3
- package/utils.d.ts +43 -0
package/LexicalList.prod.js
CHANGED
|
@@ -8,28 +8,28 @@
|
|
|
8
8
|
function r(a){a=a.getParent();q(a)||m(40);let b=a;for(;null!==b;)b=b.getParent(),q(b)&&(a=b);return a}function t(a){let b=[];a=a.getChildren().filter(p);for(let c=0;c<a.length;c++){let d=a[c],e=d.getFirstChild();q(e)?b=b.concat(t(e)):b.push(d)}return b}function u(a){return p(a)&&q(a.getFirstChild())}function v(a){for(;null==a.getNextSibling()&&null==a.getPreviousSibling();){let b=a.getParent();if(null==b||!p(a)&&!q(a))break;a=b}a.remove()}function w(a){return y().append(a)}
|
|
9
9
|
function z(a,b){return p(a)&&(0===b.length||1===b.length&&a.is(b[0])&&0===a.getChildrenSize())}function B(a,b){a.splice(a.getChildrenSize(),0,b)}
|
|
10
10
|
function C(a,b){if(q(a))return a;let c=a.getPreviousSibling(),d=a.getNextSibling(),e=y();e.setFormat(a.getFormatType());e.setIndent(a.getIndent());B(e,a.getChildren());if(q(c)&&b===c.getListType())return c.append(e),a.remove(),q(d)&&b===d.getListType()&&(B(c,d.getChildren()),d.remove()),c;if(q(d)&&b===d.getListType())return d.getFirstChildOrThrow().insertBefore(e),a.remove(),d;b=D(b);b.append(e);a.replace(b);E(b);return b}
|
|
11
|
-
function E(a,b){a=b||a.getChildren();if(void 0!==a)for(b=0;b<a.length;b++){let f=a[b];if(p(f)){let g=f.getValue();var c=f,d=c.getParent(),e=1;null!=d&&(q(d)?e=d.getStart():m(44));c=c.getPreviousSiblings();for(d=0;d<c.length;d++){let l=c[d];p(l)&&!q(l.getFirstChild())&&e++}g!==e&&f.setValue(e)}}}
|
|
12
|
-
function
|
|
13
|
-
class
|
|
14
|
-
priority:0})}}static importJSON(a){let b=new
|
|
15
|
-
|
|
16
|
-
E(a),b;if(q(a)&&a.getListType()===c.getListType()){c=a;a=a.getChildren();for(d=a.length-1;0<=d;d--)c=a[d],this.insertAfter(c,b);return c}c.insertAfter(a,b);if(0!==d.length){let e=D(c.getListType());d.forEach(f=>e.append(f));a.insertAfter(e,b)}return a}remove(a){let b=this.
|
|
17
|
-
b.append(f));var c=this.getParentOrThrow(),d=c.getParentOrThrow();let e=p(d);1===c.getChildrenSize()?e?(c.remove(),d.select()):(c.insertBefore(b),c.remove(),c=a.anchor,a=a.focus,d=b.getKey(),"element"===
|
|
18
|
-
|
|
19
|
-
|
|
11
|
+
function F(a,b){var c=a.getLastChild();let d=b.getFirstChild();c&&d&&u(c)&&u(d)&&(F(c.getFirstChild(),d.getFirstChild()),d.remove());c=b.getChildren();0<c.length&&(a.append(...c),E(a));b.remove()}function E(a,b){a=b||a.getChildren();if(void 0!==a)for(b=0;b<a.length;b++){let f=a[b];if(p(f)){let g=f.getValue();var c=f,d=c.getParent(),e=1;null!=d&&(q(d)?e=d.getStart():m(44));c=c.getPreviousSiblings();for(d=0;d<c.length;d++){let l=c[d];p(l)&&!q(l.getFirstChild())&&e++}g!==e&&f.setValue(e)}}}
|
|
12
|
+
function G(a){if(!u(a)){var b=a.getParent(),c=b?b.getParent():void 0,d=c?c.getParent():void 0;if(q(d)&&p(c)&&q(b)){var e=b?b.getFirstChild():void 0,f=b?b.getLastChild():void 0;if(a.is(e))c.insertBefore(a),b.isEmpty()&&c.remove();else if(a.is(f))c.insertAfter(a),b.isEmpty()&&c.remove();else{var g=b.getListType();e=y();let l=D(g);e.append(l);a.getPreviousSiblings().forEach(x=>l.append(x));f=y();g=D(g);f.append(g);B(g,a.getNextSiblings());c.insertBefore(e);c.insertAfter(f);c.replace(a)}E(b);E(d)}}}
|
|
13
|
+
class H extends h.ElementNode{static getType(){return"listitem"}static clone(a){return new H(a.__value,a.__checked,a.__key)}constructor(a,b,c){super(c);this.__value=void 0===a?1:a;this.__checked=b}createDOM(a){let b=document.createElement("li"),c=this.getParent();q(c)&&"check"===c.getListType()&&I(b,this,null);b.value=this.__value;J(b,a.theme,this);return b}updateDOM(a,b,c){let d=this.getParent();q(d)&&"check"===d.getListType()&&I(b,this,a);b.value=this.__value;J(b,c.theme,this);return!1}static transform(){return a=>
|
|
14
|
+
{let b=a.getParent();q(b)&&(E(b),"check"!==b.getListType()&&null!=a.getChecked()&&a.setChecked(void 0))}}static importDOM(){return{li:()=>({conversion:K,priority:0})}}static importJSON(a){let b=new H(a.value,a.checked);b.setFormat(a.format);b.getWritable().__indent=a.indent;b.setDirection(a.direction);return b}exportJSON(){return{...super.exportJSON(),checked:this.getChecked(),type:"listitem",value:this.getValue(),version:1}}append(...a){for(let b=0;b<a.length;b++){let c=a[b];if(h.$isElementNode(c)&&
|
|
15
|
+
this.canMergeWith(c)){let d=c.getChildren();this.append(...d);c.remove()}else super.append(c)}return this}replace(a,b){if(p(a))return super.replace(a);this.setIndent(0);let c=this.getParentOrThrow();if(!q(c))return a;if(c.__first===this.getKey())c.insertBefore(a);else if(c.__last===this.getKey())c.insertAfter(a);else{let d=D(c.getListType()),e=this.getNextSibling();for(;e;){let f=e;e=e.getNextSibling();d.append(f)}c.insertAfter(a);a.insertAfter(d)}b&&this.getChildren().forEach(d=>{a.append(d)});this.remove();
|
|
16
|
+
0===c.getChildrenSize()&&c.remove();return a}insertAfter(a,b=!0){var c=this.getParentOrThrow();q(c)||m(39);var d=this.getNextSiblings();if(p(a))return b=super.insertAfter(a,b),a=a.getParentOrThrow(),q(a)&&E(a),b;if(q(a)&&a.getListType()===c.getListType()){c=a;a=a.getChildren();for(d=a.length-1;0<=d;d--)c=a[d],this.insertAfter(c,b);return c}c.insertAfter(a,b);if(0!==d.length){let e=D(c.getListType());d.forEach(f=>e.append(f));a.insertAfter(e,b)}return a}remove(a){let b=this.getPreviousSibling(),c=
|
|
17
|
+
this.getNextSibling();super.remove(a);b&&c&&u(b)&&u(c)?(F(b.getFirstChild(),c.getFirstChild()),c.remove()):c&&(a=c.getParent(),q(a)&&E(a))}insertNewAfter(a,b=!0){a=y(null==this.__checked?void 0:!1);this.insertAfter(a,b);return a}collapseAtStart(a){let b=h.$createParagraphNode();this.getChildren().forEach(f=>b.append(f));var c=this.getParentOrThrow(),d=c.getParentOrThrow();let e=p(d);1===c.getChildrenSize()?e?(c.remove(),d.select()):(c.insertBefore(b),c.remove(),c=a.anchor,a=a.focus,d=b.getKey(),"element"===
|
|
18
|
+
c.type&&c.getNode().is(this)&&c.set(d,c.offset,"element"),"element"===a.type&&a.getNode().is(this)&&a.set(d,a.offset,"element")):(c.insertBefore(b),this.remove());return!0}getValue(){return this.getLatest().__value}setValue(a){this.getWritable().__value=a}getChecked(){return this.getLatest().__checked}setChecked(a){this.getWritable().__checked=a}toggleChecked(){this.setChecked(!this.__checked)}getIndent(){var a=this.getParent();if(null===a)return this.getLatest().__indent;a=a.getParentOrThrow();let b=
|
|
19
|
+
0;for(;p(a);)a=a.getParentOrThrow().getParentOrThrow(),b++;return b}setIndent(a){if(!("number"===typeof a&&-1<a))throw Error("Invalid indent value.");let b=this.getIndent();for(;b!==a;)if(b<a){a:{var c=new Set;if(u(this)||c.has(this.getKey()))break a;let g=this.getParent();var d=this.getNextSibling(),e=this.getPreviousSibling();if(u(d)&&u(e)){if(e=e.getFirstChild(),q(e)){e.append(this);var f=d.getFirstChild();q(f)&&(f=f.getChildren(),B(e,f),d.remove(),c.add(d.getKey()));E(e)}}else u(d)?(d=d.getFirstChild(),
|
|
20
|
+
q(d)&&(c=d.getFirstChild(),null!==c&&c.insertBefore(this),E(d))):u(e)?(d=e.getFirstChild(),q(d)&&(d.append(this),E(d))):q(g)&&(c=y(),f=D(g.getListType()),c.append(f),f.append(this),e?e.insertAfter(c):d?d.insertBefore(c):g.append(c),E(f));q(g)&&E(g)}b++}else G(this),b--;return this}insertBefore(a){if(p(a)){let b=this.getParentOrThrow();if(q(b)){let c=this.getNextSiblings();E(b,c)}}return super.insertBefore(a)}canInsertAfter(a){return p(a)}canReplaceWith(a){return p(a)}canMergeWith(a){return h.$isParagraphNode(a)||
|
|
20
21
|
p(a)}extractWithChild(a,b){if(!h.$isRangeSelection(b))return!1;a=b.anchor.getNode();let c=b.focus.getNode();return this.isParentOf(a)&&this.isParentOf(c)&&this.getTextContent().length===b.getTextContent().length}isParentRequired(){return!0}createParentElementNode(){return D("bullet")}}
|
|
21
|
-
function
|
|
22
|
-
...d)}function
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
function
|
|
28
|
-
function
|
|
29
|
-
let Q=h.createCommand("INSERT_UNORDERED_LIST_COMMAND"),R=h.createCommand("INSERT_ORDERED_LIST_COMMAND"),S=h.createCommand("INSERT_CHECK_LIST_COMMAND"),T=h.createCommand("REMOVE_LIST_COMMAND");exports.$createListItemNode=y;exports.$createListNode=D;exports.$getListDepth=n;
|
|
22
|
+
function J(a,b,c){let d=[],e=[];var f=(b=b.list)?b.listitem:void 0;if(b&&b.nested)var g=b.nested.listitem;void 0!==f&&(f=f.split(" "),d.push(...f));if(b){f=c.getParent();f=q(f)&&"check"===f.getListType();let l=c.getChecked();f&&!l||e.push(b.listitemUnchecked);f&&l||e.push(b.listitemChecked);f&&d.push(l?b.listitemChecked:b.listitemUnchecked)}void 0!==g&&(g=g.split(" "),c.getChildren().some(l=>q(l))?d.push(...g):e.push(...g));0<e.length&&k.removeClassNamesFromElement(a,...e);0<d.length&&k.addClassNamesToElement(a,
|
|
23
|
+
...d)}function I(a,b,c){q(b.getFirstChild())?(a.removeAttribute("role"),a.removeAttribute("tabIndex"),a.removeAttribute("aria-checked")):(a.setAttribute("role","checkbox"),a.setAttribute("tabIndex","-1"),c&&b.__checked===c.__checked||a.setAttribute("aria-checked",b.getChecked()?"true":"false"))}function K(a){a=k.isHTMLElement(a)&&"true"===a.getAttribute("aria-checked");return{node:y(a)}}function y(a){return h.$applyNodeReplacement(new H(void 0,a))}function p(a){return a instanceof H}
|
|
24
|
+
class L extends h.ElementNode{static getType(){return"list"}static clone(a){return new L(a.__listType||N[a.__tag],a.__start,a.__key)}constructor(a,b,c){super(c);this.__listType=a=N[a]||a;this.__tag="number"===a?"ol":"ul";this.__start=b}getTag(){return this.__tag}getListType(){return this.__listType}getStart(){return this.__start}createDOM(a){let b=document.createElement(this.__tag);1!==this.__start&&b.setAttribute("start",String(this.__start));b.__lexicalListType=this.__listType;O(b,a.theme,this);
|
|
25
|
+
return b}updateDOM(a,b,c){if(a.__tag!==this.__tag)return!0;O(b,c.theme,this);return!1}static importDOM(){return{ol:()=>({conversion:P,priority:0}),ul:()=>({conversion:P,priority:0})}}static importJSON(a){let b=D(a.listType,a.start);b.setFormat(a.format);b.setIndent(a.indent);b.setDirection(a.direction);return b}exportDOM(a){({element:a}=super.exportDOM(a));a&&(1!==this.__start&&a.setAttribute("start",String(this.__start)),"check"===this.__listType&&a.setAttribute("__lexicalListType","check"));return{element:a}}exportJSON(){return{...super.exportJSON(),
|
|
26
|
+
listType:this.getListType(),start:this.getStart(),tag:this.getTag(),type:"list",version:1}}canBeEmpty(){return!1}canIndent(){return!1}append(...a){for(let c=0;c<a.length;c++){var b=a[c];if(p(b))super.append(b);else{let d=y();q(b)?d.append(b):h.$isElementNode(b)?(b=h.$createTextNode(b.getTextContent()),d.append(b)):d.append(b);super.append(d)}}E(this);return this}extractWithChild(a){return p(a)}}
|
|
27
|
+
function O(a,b,c){let d=[],e=[];var f=b.list;if(void 0!==f){let l=f[`${c.__tag}Depth`]||[];b=n(c)-1;let x=b%l.length;var g=l[x];let M=f[c.__tag],A;f=f.nested;void 0!==f&&f.list&&(A=f.list);void 0!==M&&d.push(M);if(void 0!==g)for(g=g.split(" "),d.push(...g),g=0;g<l.length;g++)g!==x&&e.push(c.__tag+g);void 0!==A&&(c=A.split(" "),1<b?d.push(...c):e.push(...c))}0<e.length&&k.removeClassNamesFromElement(a,...e);0<d.length&&k.addClassNamesToElement(a,...d)}
|
|
28
|
+
function Q(a){let b=[];for(let d=0;d<a.length;d++){var c=a[d];p(c)?(b.push(c),c=c.getChildren(),1<c.length&&c.forEach(e=>{q(e)&&b.push(w(e))})):b.push(w(c))}return b}function P(a){let b=a.nodeName.toLowerCase(),c=null;"ol"===b?c=D("number",a.start):"ul"===b&&(c=k.isHTMLElement(a)&&"check"===a.getAttribute("__lexicallisttype")?D("check"):D("bullet"));return{after:Q,node:c}}let N={ol:"number",ul:"bullet"};function D(a,b=1){return h.$applyNodeReplacement(new L(a,b))}
|
|
29
|
+
function q(a){return a instanceof L}let R=h.createCommand("INSERT_UNORDERED_LIST_COMMAND"),S=h.createCommand("INSERT_ORDERED_LIST_COMMAND"),T=h.createCommand("INSERT_CHECK_LIST_COMMAND"),U=h.createCommand("REMOVE_LIST_COMMAND");exports.$createListItemNode=y;exports.$createListNode=D;exports.$getListDepth=n;
|
|
30
30
|
exports.$handleListInsertParagraph=function(){var a=h.$getSelection();if(!h.$isRangeSelection(a)||!a.isCollapsed())return!1;a=a.anchor.getNode();if(!p(a)||""!==a.getTextContent())return!1;var b=r(a),c=a.getParent();q(c)||m(40);let d=c.getParent(),e;if(h.$isRootOrShadowRoot(d))e=h.$createParagraphNode(),b.insertAfter(e);else if(p(d))e=y(),d.insertAfter(e);else return!1;e.select();b=a.getNextSiblings();if(0<b.length){let f=D(c.getListType());h.$isParagraphNode(e)?e.insertAfter(f):(c=y(),c.append(f),
|
|
31
|
-
e.insertAfter(c));b.forEach(g=>{g.remove();f.append(g)})}v(a);return!0};exports.$isListItemNode=p;exports.$isListNode=q;exports.INSERT_CHECK_LIST_COMMAND=
|
|
31
|
+
e.insertAfter(c));b.forEach(g=>{g.remove();f.append(g)})}v(a);return!0};exports.$isListItemNode=p;exports.$isListNode=q;exports.INSERT_CHECK_LIST_COMMAND=T;exports.INSERT_ORDERED_LIST_COMMAND=S;exports.INSERT_UNORDERED_LIST_COMMAND=R;exports.ListItemNode=H;exports.ListNode=L;exports.REMOVE_LIST_COMMAND=U;
|
|
32
32
|
exports.insertList=function(a,b){a.update(()=>{var c=h.$getSelection();if(h.$isRangeSelection(c)||h.DEPRECATED_$isGridSelection(c)){var d=c.getNodes();c=c.anchor.getNode();var e=c.getParent();if(z(c,d))d=D(b),h.$isRootOrShadowRoot(e)?(c.replace(d),e=y(),h.$isElementNode(c)&&(e.setFormat(c.getFormatType()),e.setIndent(c.getIndent())),d.append(e)):p(c)&&(c=c.getParentOrThrow(),B(d,c.getChildren()),c.replace(d));else for(c=new Set,e=0;e<d.length;e++){var f=d[e];if(h.$isElementNode(f)&&f.isEmpty()&&!c.has(f.getKey()))C(f,
|
|
33
33
|
b);else if(h.$isLeafNode(f))for(f=f.getParent();null!=f;){let l=f.getKey();if(q(f)){if(!c.has(l)){var g=D(b);B(g,f.getChildren());f.replace(g);E(g);c.add(l)}break}else{g=f.getParent();if(h.$isRootOrShadowRoot(g)&&!c.has(l)){c.add(l);C(f,b);break}f=g}}}}})};
|
|
34
|
-
exports.removeList=function(a){a.update(()=>{let b=h.$getSelection();if(h.$isRangeSelection(b)){var c=new Set,d=b.getNodes(),e=b.anchor.getNode();if(z(e,d))c.add(r(e));else for(e=0;e<d.length;e++){var f=d[e];h.$isLeafNode(f)&&(f=k.$getNearestNodeOfType(f,
|
|
34
|
+
exports.removeList=function(a){a.update(()=>{let b=h.$getSelection();if(h.$isRangeSelection(b)){var c=new Set,d=b.getNodes(),e=b.anchor.getNode();if(z(e,d))c.add(r(e));else for(e=0;e<d.length;e++){var f=d[e];h.$isLeafNode(f)&&(f=k.$getNearestNodeOfType(f,H),null!=f&&c.add(r(f)))}for(let g of c){c=g;d=t(g);for(let l of d)d=h.$createParagraphNode(),B(d,l.getChildren()),c.insertAfter(d),c=d,l.__key===b.anchor.key&&b.anchor.set(d.getKey(),0,"element"),l.__key===b.focus.key&&b.focus.set(d.getKey(),0,"element"),
|
|
35
35
|
l.remove();g.remove()}}})}
|
package/LexicalListItemNode.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export declare class ListItemNode extends ElementNode {
|
|
|
24
24
|
constructor(value?: number, checked?: boolean, key?: NodeKey);
|
|
25
25
|
createDOM(config: EditorConfig): HTMLElement;
|
|
26
26
|
updateDOM(prevNode: ListItemNode, dom: HTMLElement, config: EditorConfig): boolean;
|
|
27
|
+
static transform(): (node: LexicalNode) => void;
|
|
27
28
|
static importDOM(): DOMConversionMap | null;
|
|
28
29
|
static importJSON(serializedNode: SerializedListItemNode): ListItemNode;
|
|
29
30
|
exportJSON(): SerializedListItemNode;
|
|
@@ -48,5 +49,15 @@ export declare class ListItemNode extends ElementNode {
|
|
|
48
49
|
isParentRequired(): true;
|
|
49
50
|
createParentElementNode(): ElementNode;
|
|
50
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* Creates a new List Item node, passing true/false will convert it to a checkbox input.
|
|
54
|
+
* @param checked - Is the List Item a checkbox and, if so, is it checked? undefined/null: not a checkbox, true/false is a checkbox and checked/unchecked, respectively.
|
|
55
|
+
* @returns The new List Item.
|
|
56
|
+
*/
|
|
51
57
|
export declare function $createListItemNode(checked?: boolean): ListItemNode;
|
|
58
|
+
/**
|
|
59
|
+
* Checks to see if the node is a ListItemNode.
|
|
60
|
+
* @param node - The node to be checked.
|
|
61
|
+
* @returns true if the node is a ListItemNode, false otherwise.
|
|
62
|
+
*/
|
|
52
63
|
export declare function $isListItemNode(node: LexicalNode | null | undefined): node is ListItemNode;
|
package/LexicalListNode.d.ts
CHANGED
|
@@ -40,5 +40,16 @@ export declare class ListNode extends ElementNode {
|
|
|
40
40
|
append(...nodesToAppend: LexicalNode[]): this;
|
|
41
41
|
extractWithChild(child: LexicalNode): boolean;
|
|
42
42
|
}
|
|
43
|
+
/**
|
|
44
|
+
* Creates a ListNode of listType.
|
|
45
|
+
* @param listType - The type of list to be created. Can be 'number', 'bullet', or 'check'.
|
|
46
|
+
* @param start - Where an ordered list starts its count, start = 1 if left undefined.
|
|
47
|
+
* @returns The new ListNode
|
|
48
|
+
*/
|
|
43
49
|
export declare function $createListNode(listType: ListType, start?: number): ListNode;
|
|
50
|
+
/**
|
|
51
|
+
* Checks to see if the node is a ListNode.
|
|
52
|
+
* @param node - The node to be checked.
|
|
53
|
+
* @returns true if the node is a ListNode, false otherwise.
|
|
54
|
+
*/
|
|
44
55
|
export declare function $isListNode(node: LexicalNode | null | undefined): node is ListNode;
|
package/formatList.d.ts
CHANGED
|
@@ -8,9 +8,61 @@
|
|
|
8
8
|
import { LexicalEditor, LexicalNode } from 'lexical';
|
|
9
9
|
import { ListItemNode, ListNode } from './';
|
|
10
10
|
import { ListType } from './LexicalListNode';
|
|
11
|
+
/**
|
|
12
|
+
* Inserts a new ListNode. If the selection's anchor node is an empty ListItemNode and is a child of
|
|
13
|
+
* the root/shadow root, it will replace the ListItemNode with a ListNode and the old ListItemNode.
|
|
14
|
+
* Otherwise it will replace its parent with a new ListNode and re-insert the ListItemNode and any previous children.
|
|
15
|
+
* If the selection's anchor node is not an empty ListItemNode, it will add a new ListNode or merge an existing ListNode,
|
|
16
|
+
* unless the the node is a leaf node, in which case it will attempt to find a ListNode up the branch and replace it with
|
|
17
|
+
* a new ListNode, or create a new ListNode at the nearest root/shadow root.
|
|
18
|
+
* @param editor - The lexical editor.
|
|
19
|
+
* @param listType - The type of list, "number" | "bullet" | "check".
|
|
20
|
+
*/
|
|
11
21
|
export declare function insertList(editor: LexicalEditor, listType: ListType): void;
|
|
22
|
+
/**
|
|
23
|
+
* A recursive function that goes through each list and their children, including nested lists,
|
|
24
|
+
* appending list2 children after list1 children and updating ListItemNode values.
|
|
25
|
+
* @param list1 - The first list to be merged.
|
|
26
|
+
* @param list2 - The second list to be merged.
|
|
27
|
+
*/
|
|
28
|
+
export declare function mergeLists(list1: ListNode, list2: ListNode): void;
|
|
29
|
+
/**
|
|
30
|
+
* Searches for the nearest ancestral ListNode and removes it. If selection is an empty ListItemNode
|
|
31
|
+
* it will remove the whole list, including the ListItemNode. For each ListItemNode in the ListNode,
|
|
32
|
+
* removeList will also generate new ParagraphNodes in the removed ListNode's place. Any child node
|
|
33
|
+
* inside a ListItemNode will be appended to the new ParagraphNodes.
|
|
34
|
+
* @param editor - The lexical editor.
|
|
35
|
+
*/
|
|
12
36
|
export declare function removeList(editor: LexicalEditor): void;
|
|
37
|
+
/**
|
|
38
|
+
* Takes the value of a child ListItemNode and makes it the value the ListItemNode
|
|
39
|
+
* should be if it isn't already. If only certain children should be updated, they
|
|
40
|
+
* can be passed optionally in an array.
|
|
41
|
+
* @param list - The list whose children are updated.
|
|
42
|
+
* @param children - An array of the children to be updated.
|
|
43
|
+
*/
|
|
13
44
|
export declare function updateChildrenListItemValue(list: ListNode, children?: Array<LexicalNode>): void;
|
|
45
|
+
/**
|
|
46
|
+
* Adds an empty ListNode/ListItemNode chain at listItemNode, so as to
|
|
47
|
+
* create an indent effect. Won't indent ListItemNodes that have a ListNode as
|
|
48
|
+
* a child, but does merge sibling ListItemNodes if one has a nested ListNode.
|
|
49
|
+
* @param listItemNode - The ListItemNode to be indented.
|
|
50
|
+
*/
|
|
14
51
|
export declare function $handleIndent(listItemNode: ListItemNode): void;
|
|
52
|
+
/**
|
|
53
|
+
* Removes an indent by removing an empty ListNode/ListItemNode chain. An indented ListItemNode
|
|
54
|
+
* has a great grandparent node of type ListNode, which is where the ListItemNode will reside
|
|
55
|
+
* within as a child.
|
|
56
|
+
* @param listItemNode - The ListItemNode to remove the indent (outdent).
|
|
57
|
+
*/
|
|
15
58
|
export declare function $handleOutdent(listItemNode: ListItemNode): void;
|
|
59
|
+
/**
|
|
60
|
+
* Attempts to insert a ParagraphNode at selection and selects the new node. The selection must contain a ListItemNode
|
|
61
|
+
* or a node that does not already contain text. If its grandparent is the root/shadow root, it will get the ListNode
|
|
62
|
+
* (which should be the parent node) and insert the ParagraphNode as a sibling to the ListNode. If the ListNode is
|
|
63
|
+
* nested in a ListItemNode instead, it will add the ParagraphNode after the grandparent ListItemNode.
|
|
64
|
+
* Throws an invariant if the selection is not a child of a ListNode.
|
|
65
|
+
* @returns true if a ParagraphNode was inserted succesfully, false if there is no selection
|
|
66
|
+
* or the selection does not contain a ListItemNode or the node already holds text.
|
|
67
|
+
*/
|
|
16
68
|
export declare function $handleListInsertParagraph(): boolean;
|
package/package.json
CHANGED
|
@@ -8,13 +8,13 @@
|
|
|
8
8
|
"list"
|
|
9
9
|
],
|
|
10
10
|
"license": "MIT",
|
|
11
|
-
"version": "0.
|
|
11
|
+
"version": "0.9.1",
|
|
12
12
|
"main": "LexicalList.js",
|
|
13
13
|
"peerDependencies": {
|
|
14
|
-
"lexical": "0.
|
|
14
|
+
"lexical": "0.9.1"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@lexical/utils": "0.
|
|
17
|
+
"@lexical/utils": "0.9.1"
|
|
18
18
|
},
|
|
19
19
|
"repository": {
|
|
20
20
|
"type": "git",
|
package/utils.d.ts
CHANGED
|
@@ -7,11 +7,54 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import type { LexicalNode } from 'lexical';
|
|
9
9
|
import { ListItemNode, ListNode } from './';
|
|
10
|
+
/**
|
|
11
|
+
* Checks the depth of listNode from the root node.
|
|
12
|
+
* @param listNode - The ListNode to be checked.
|
|
13
|
+
* @returns The depth of the ListNode.
|
|
14
|
+
*/
|
|
10
15
|
export declare function $getListDepth(listNode: ListNode): number;
|
|
16
|
+
/**
|
|
17
|
+
* Finds the nearest ancestral ListNode and returns it, throws an invariant if listItem is not a ListItemNode.
|
|
18
|
+
* @param listItem - The node to be checked.
|
|
19
|
+
* @returns The ListNode found.
|
|
20
|
+
*/
|
|
11
21
|
export declare function $getTopListNode(listItem: LexicalNode): ListNode;
|
|
22
|
+
/**
|
|
23
|
+
* Checks if listItem has no child ListNodes and has no ListItemNode ancestors with siblings.
|
|
24
|
+
* @param listItem - the ListItemNode to be checked.
|
|
25
|
+
* @returns true if listItem has no child ListNode and no ListItemNode ancestors with siblings, false otherwise.
|
|
26
|
+
*/
|
|
12
27
|
export declare function $isLastItemInList(listItem: ListItemNode): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* A recursive Depth-First Search (Postorder Traversal) that finds all of a node's children
|
|
30
|
+
* that are of type ListItemNode and returns them in an array.
|
|
31
|
+
* @param node - The ListNode to start the search.
|
|
32
|
+
* @returns An array containing all nodes of type ListItemNode found.
|
|
33
|
+
*/
|
|
13
34
|
export declare function $getAllListItems(node: ListNode): Array<ListItemNode>;
|
|
35
|
+
/**
|
|
36
|
+
* Checks to see if the passed node is a ListItemNode and has a ListNode as a child.
|
|
37
|
+
* @param node - The node to be checked.
|
|
38
|
+
* @returns true if the node is a ListItemNode and has a ListNode child, false otherwise.
|
|
39
|
+
*/
|
|
14
40
|
export declare function isNestedListNode(node: LexicalNode | null | undefined): boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Traverses up the tree and returns the first ListItemNode found.
|
|
43
|
+
* @param node - Node to start the search.
|
|
44
|
+
* @returns The first ListItemNode found, or null if none exist.
|
|
45
|
+
*/
|
|
15
46
|
export declare function findNearestListItemNode(node: LexicalNode): ListItemNode | null;
|
|
47
|
+
/**
|
|
48
|
+
* Takes a deeply nested ListNode or ListItemNode and traverses up the branch to delete the first
|
|
49
|
+
* ancestral ListNode (which could be the root ListNode) or ListItemNode with siblings, essentially
|
|
50
|
+
* bringing the deeply nested node up the branch once. Would remove sublist if it has siblings.
|
|
51
|
+
* Should not break ListItem -> List -> ListItem chain as empty List/ItemNodes should be removed on .remove().
|
|
52
|
+
* @param sublist - The nested ListNode or ListItemNode to be brought up the branch.
|
|
53
|
+
*/
|
|
16
54
|
export declare function $removeHighestEmptyListParent(sublist: ListItemNode | ListNode): void;
|
|
55
|
+
/**
|
|
56
|
+
* Wraps a node into a ListItemNode.
|
|
57
|
+
* @param node - The node to be wrapped into a ListItemNode
|
|
58
|
+
* @returns The ListItemNode which the passed node is wrapped in.
|
|
59
|
+
*/
|
|
17
60
|
export declare function wrapInListItem(node: LexicalNode): ListItemNode;
|