Class: ListItemNode

@lexical/list.ListItemNode

Hierarchy

• ParagraphNode

  ↳ ListItemNode

Constructors

constructor

• new ListItemNode(value?, checked?, key?): ListItemNode

Parameters

Name	Type
value?	number
checked?	boolean
key?	string

Returns

ListItemNode

Overrides

ParagraphNode.constructor

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:67

Methods

append

▸ append(...nodes): this

Parameters

Name	Type
...nodes	LexicalNode[]

Returns

this

Overrides

ParagraphNode.append

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:155

---

canMergeWhenEmpty

▸ canMergeWhenEmpty(): true

Returns

true

Overrides

ParagraphNode.canMergeWhenEmpty

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:411

---

canMergeWith

▸ canMergeWith(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Overrides

ParagraphNode.canMergeWith

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:384

---

collapseAtStart

▸ collapseAtStart(): boolean

Returns

boolean

Overrides

ParagraphNode.collapseAtStart

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:274

---

createDOM

▸ createDOM(config): 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 lifecyle.

Parameters

Name	Type	Description
config	EditorConfig	allows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

HTMLElement

Overrides

ParagraphNode.createDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:73

---

createParentElementNode

▸ createParentElementNode(): ElementNode

Returns

ElementNode

Overrides

ParagraphNode.createParentElementNode

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:407

---

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

ParagraphNode.exportDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:137

---

exportJSON

▸ exportJSON(): SerializedListItemNode

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

SerializedListItemNode

Overrides

ParagraphNode.exportJSON

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:145

---

extractWithChild

▸ extractWithChild(child, selection): boolean

Parameters

Name	Type
child	LexicalNode
selection	BaseSelection

Returns

boolean

Overrides

ParagraphNode.extractWithChild

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:388

---

getChecked

▸ getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:317

---

getIndent

▸ getIndent(): number

Returns

number

Overrides

ParagraphNode.getIndent

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:339

---

getValue

▸ getValue(): number

Returns

number

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:306

---

insertAfter

▸ insertAfter(node, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
node	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Overrides

ParagraphNode.insertAfter

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:215

---

insertNewAfter

▸ insertNewAfter(selection, restoreSelection?): ParagraphNode | ListItemNode

Parameters

Name	Type	Default value
selection	RangeSelection	undefined
restoreSelection	boolean	true

Returns

ParagraphNode | ListItemNode

Overrides

ParagraphNode.insertNewAfter

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:257

---

isParentRequired

▸ isParentRequired(): true

Returns

true

Overrides

ParagraphNode.isParentRequired

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:403

---

remove

▸ remove(preserveEmptyParent?): void

Parameters

Name	Type
preserveEmptyParent?	boolean

Returns

void

Overrides

ParagraphNode.remove

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:241

---

replace

▸ replace<N>(replaceWithNode, includeChildren?): N

Type parameters

Name	Type
N	extends LexicalNode

Parameters

Name	Type
replaceWithNode	N
includeChildren?	boolean

Returns

N

Overrides

ParagraphNode.replace

Defined in

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

---

setChecked

▸ setChecked(checked?): void

Parameters

Name	Type
checked?	boolean

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:330

---

setIndent

▸ setIndent(indent): this

Parameters

Name	Type
indent	number

Returns

this

Overrides

ParagraphNode.setIndent

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:356

---

setValue

▸ setValue(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:312

---

toggleChecked

▸ toggleChecked(): void

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:335

---

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

ParagraphNode.updateDOM

Defined in

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

---

clone

▸ clone(node): ListItemNode

Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.

Parameters

Name	Type
node	ListItemNode

Returns

ListItemNode

Overrides

ParagraphNode.clone

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:63

---

getType

▸ getType(): string

Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.

Returns

string

Overrides

ParagraphNode.getType

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:59

---

importDOM

▸ importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ParagraphNode.importDOM

Defined in

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

---

importJSON

▸ importJSON(serializedNode): ListItemNode

Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.

Parameters

Name	Type
serializedNode	SerializedListItemNode

Returns

ListItemNode

Overrides

ParagraphNode.importJSON

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:122

---

transform

▸ transform(): (node: LexicalNode) => void

Returns

fn

▸ (node): void

Parameters

Name	Type
node	LexicalNode

Returns

void

Overrides

ParagraphNode.transform

Defined in

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