Class: ListNode

@lexical/list.ListNode

Hierarchy

• ElementNode

  ↳ ListNode

Constructors

constructor

• new ListNode(listType?, start?, key?): ListNode

Parameters

Name	Type	Default value
listType	ListType	'number'
start	number	1
key?	string	undefined

Returns

ListNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-list/src/LexicalListNode.ts:83

Methods

afterCloneFrom

▸ afterCloneFrom(prevNode): void

Perform any state updates on the clone of prevNode that are not already handled by the constructor call in the static clone method. If you have state to update in your clone that is not handled directly by the constructor, it is advisable to override this method but it is required to include a call to super.afterCloneFrom(prevNode) in your implementation. This is only intended to be called by $cloneWithProperties function or via a super call.

Parameters

Name	Type
prevNode	this

Returns

void

Example

class ClassesTextNode extends TextNode {
  // Not shown: static getType, static importJSON, exportJSON, createDOM, updateDOM
  __classes = new Set<string>();
  static clone(node: ClassesTextNode): ClassesTextNode {
    // The inherited TextNode constructor is used here, so
    // classes is not set by this method.
    return new ClassesTextNode(node.__text, node.__key);
  }
  afterCloneFrom(node: this): void {
    // This calls TextNode.afterCloneFrom and LexicalNode.afterCloneFrom
    // for necessary state updates
    super.afterCloneFrom(node);
    this.__addClasses(node.__classes);
  }
  // This method is a private implementation detail, it is not
  // suitable for the public API because it does not call getWritable
  __addClasses(classNames: Iterable<string>): this {
    for (const className of classNames) {
      this.__classes.add(className);
    }
    return this;
  }
  addClass(...classNames: string[]): this {
    return this.getWritable().__addClasses(classNames);
  }
  removeClass(...classNames: string[]): this {
    const node = this.getWritable();
    for (const className of classNames) {
      this.__classes.delete(className);
    }
    return this;
  }
  getClasses(): Set<string> {
    return this.getLatest().__classes;
  }
}

Overrides

ElementNode.afterCloneFrom

Defined in

packages/lexical-list/src/LexicalListNode.ts:91

---

canBeEmpty

▸ canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

packages/lexical-list/src/LexicalListNode.ts:180

---

canIndent

▸ canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

packages/lexical-list/src/LexicalListNode.ts:184

---

createDOM

▸ createDOM(config, _editor?): HTMLElement

Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.

This method must return exactly one HTMLElement. Nested elements are not supported.

Do not attempt to update the Lexical EditorState during this phase of the update lifecycle.

Parameters

Name	Type	Description
config	EditorConfig	allows access to things like the EditorTheme (to apply classes) during reconciliation.
_editor?	LexicalEditor	allows access to the editor for context during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-list/src/LexicalListNode.ts:125

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

packages/lexical-list/src/LexicalListNode.ts:156

---

exportJSON

▸ exportJSON(): SerializedListNode

Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.

Returns

SerializedListNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-list/src/LexicalListNode.ts:171

---

extractWithChild

▸ extractWithChild(child): boolean

Parameters

Name	Type
child	LexicalNode

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-list/src/LexicalListNode.ts:210

---

getListType

▸ getListType(): ListType

Returns

ListType

Defined in

packages/lexical-list/src/LexicalListNode.ts:109

---

getStart

▸ getStart(): number

Returns

number

Defined in

packages/lexical-list/src/LexicalListNode.ts:113

---

getTag

▸ getTag(): ListNodeTagType

Returns

ListNodeTagType

Defined in

packages/lexical-list/src/LexicalListNode.ts:98

---

setListType

▸ setListType(type): this

Parameters

Name	Type
type	ListType

Returns

this

Defined in

packages/lexical-list/src/LexicalListNode.ts:102

---

setStart

▸ setStart(start): this

Parameters

Name	Type
start	number

Returns

this

Defined in

packages/lexical-list/src/LexicalListNode.ts:117

---

splice

▸ splice(start, deleteCount, nodesToInsert): this

Parameters

Name	Type
start	number
deleteCount	number
nodesToInsert	LexicalNode[]

Returns

this

Overrides

ElementNode.splice

Defined in

packages/lexical-list/src/LexicalListNode.ts:188

---

updateDOM

▸ updateDOM(prevNode, dom, config): boolean

Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.

Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.

Parameters

Name	Type
prevNode	this
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-list/src/LexicalListNode.ts:139

---

updateFromJSON

▸ updateFromJSON(serializedNode): this

Update this LexicalNode instance from serialized JSON. It's recommended to implement as much logic as possible in this method instead of the static importJSON method, so that the functionality can be inherited in subclasses.

The LexicalUpdateJSON utility type should be used to ignore any type, version, or children properties in the JSON so that the extended JSON from subclasses are acceptable parameters for the super call.

If overridden, this method must call super.

Parameters

Name	Type
serializedNode	LexicalUpdateJSON<SerializedListNode>

Returns

this

Example

class MyTextNode extends TextNode {
  // ...
  static importJSON(serializedNode: SerializedMyTextNode): MyTextNode {
    return $createMyTextNode()
      .updateFromJSON(serializedNode);
  }
  updateFromJSON(
    serializedNode: LexicalUpdateJSON<SerializedMyTextNode>,
  ): this {
    return super.updateFromJSON(serializedNode)
      .setMyProperty(serializedNode.myProperty);
  }
}

Overrides

ElementNode.updateFromJSON

Defined in

packages/lexical-list/src/LexicalListNode.ts:149