Class: ListItemNode

@lexical/list.ListItemNode

Hierarchy

• ElementNode

  ↳ ListItemNode

Constructors

constructor

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

Parameters

Name	Type
value?	number
checked?	boolean
key?	string

Overrides

ElementNode.constructor

Defined in

lexical-list/src/LexicalListItemNode.ts:72

Methods

append

▸ append(...nodes): ListItemNode

Parameters

Name	Type
...nodes	LexicalNode[]

Returns

ListItemNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListItemNode.ts:143

---

canInsertAfter

▸ canInsertAfter(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Overrides

ElementNode.canInsertAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:398

---

canMergeWith

▸ canMergeWith(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Overrides

ElementNode.canMergeWith

Defined in

lexical-list/src/LexicalListItemNode.ts:406

---

canReplaceWith

▸ canReplaceWith(replacement): boolean

Parameters

Name	Type
replacement	LexicalNode

Returns

boolean

Overrides

ElementNode.canReplaceWith

Defined in

lexical-list/src/LexicalListItemNode.ts:402

---

collapseAtStart

▸ collapseAtStart(selection): true

Parameters

Name	Type
selection	RangeSelection

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

lexical-list/src/LexicalListItemNode.ts:284

---

createDOM

▸ createDOM(config): HTMLElement

Parameters

Name	Type
config	EditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-list/src/LexicalListItemNode.ts:78

---

createParentElementNode

▸ createParentElementNode(): ElementNode

Returns

ElementNode

Overrides

ElementNode.createParentElementNode

Defined in

lexical-list/src/LexicalListItemNode.ts:432

---

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

ElementNode.exportJSON

Defined in

lexical-list/src/LexicalListItemNode.ts:133

---

extractWithChild

▸ extractWithChild(child, selection): boolean

Parameters

Name	Type
child	LexicalNode
selection	RangeSelection | NodeSelection | GridSelection

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-list/src/LexicalListItemNode.ts:410

---

getChecked

▸ getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

lexical-list/src/LexicalListItemNode.ts:334

---

getIndent

▸ getIndent(): number

Returns

number

Overrides

ElementNode.getIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:349

---

getValue

▸ getValue(): number

Returns

number

Defined in

lexical-list/src/LexicalListItemNode.ts:323

---

insertAfter

▸ insertAfter(node, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
node	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Overrides

ElementNode.insertAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:197

---

insertBefore

▸ insertBefore(nodeToInsert): LexicalNode

Parameters

Name	Type
nodeToInsert	LexicalNode

Returns

LexicalNode

Overrides

ElementNode.insertBefore

Defined in

lexical-list/src/LexicalListItemNode.ts:385

---

insertNewAfter

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

Parameters

Name	Type	Default value
_	RangeSelection	undefined
restoreSelection	boolean	true

Returns

ParagraphNode | ListItemNode

Overrides

ElementNode.insertNewAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:272

---

isParentRequired

▸ isParentRequired(): true

Returns

true

Overrides

ElementNode.isParentRequired

Defined in

lexical-list/src/LexicalListItemNode.ts:428

---

remove

▸ remove(preserveEmptyParent?): void

Parameters

Name	Type
preserveEmptyParent?	boolean

Returns

void

Overrides

ElementNode.remove

Defined in

lexical-list/src/LexicalListItemNode.ts:250

---

replace

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

Type parameters

Name	Type
N	extends LexicalNode<N>

Parameters

Name	Type
replaceWithNode	N
includeChildren?	boolean

Returns

N

Overrides

ElementNode.replace

Defined in

lexical-list/src/LexicalListItemNode.ts:159

---

setChecked

▸ setChecked(checked?): void

Parameters

Name	Type
checked?	boolean

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:340

---

setIndent

▸ setIndent(indent): ListItemNode

Parameters

Name	Type
indent	number

Returns

ListItemNode

Overrides

ElementNode.setIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:366

---

setValue

▸ setValue(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:329

---

toggleChecked

▸ toggleChecked(): void

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:345

---

updateDOM

▸ updateDOM(prevNode, dom, config): boolean

Parameters

Name	Type
prevNode	ListItemNode
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-list/src/LexicalListItemNode.ts:89

---

clone

▸ Static clone(node): ListItemNode

Parameters

Name	Type
node	ListItemNode

Returns

ListItemNode

Overrides

ElementNode.clone

Defined in

lexical-list/src/LexicalListItemNode.ts:68

---

getType

▸ Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-list/src/LexicalListItemNode.ts:64

---

importDOM

▸ Static importDOM(): null | DOMConversionMap<HTMLElement>

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical-list/src/LexicalListItemNode.ts:117

---

importJSON

▸ Static importJSON(serializedNode): ListItemNode

Parameters

Name	Type
serializedNode	SerializedListItemNode

Returns

ListItemNode

Overrides

ElementNode.importJSON

Defined in

lexical-list/src/LexicalListItemNode.ts:126

---

transform

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

Returns

fn

▸ (node): void

Parameters

Name	Type
node	LexicalNode

Returns

void

Overrides

ElementNode.transform

Defined in

lexical-list/src/LexicalListItemNode.ts:105