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:71

Methods

append

▸ append(...nodes): ListItemNode

Parameters

Name	Type
...nodes	LexicalNode[]

Returns

ListItemNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListItemNode.ts:119

---

canInsertAfter

▸ canInsertAfter(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Overrides

ElementNode.canInsertAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:369

---

canMergeWith

▸ canMergeWith(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Overrides

ElementNode.canMergeWith

Defined in

lexical-list/src/LexicalListItemNode.ts:377

---

canReplaceWith

▸ canReplaceWith(replacement): boolean

Parameters

Name	Type
replacement	LexicalNode

Returns

boolean

Overrides

ElementNode.canReplaceWith

Defined in

lexical-list/src/LexicalListItemNode.ts:373

---

collapseAtStart

▸ collapseAtStart(selection): true

Parameters

Name	Type
selection	RangeSelection

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

lexical-list/src/LexicalListItemNode.ts:259

---

createDOM

▸ createDOM(config): HTMLElement

Parameters

Name	Type
config	EditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-list/src/LexicalListItemNode.ts:77

---

createParentElementNode

▸ createParentElementNode(): ElementNode

Returns

ElementNode

Overrides

ElementNode.createParentElementNode

Defined in

lexical-list/src/LexicalListItemNode.ts:403

---

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:381

---

getChecked

▸ getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

lexical-list/src/LexicalListItemNode.ts:309

---

getIndent

▸ getIndent(): number

Returns

number

Overrides

ElementNode.getIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:324

---

getValue

▸ getValue(): number

Returns

number

Defined in

lexical-list/src/LexicalListItemNode.ts:298

---

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:181

---

insertBefore

▸ insertBefore(nodeToInsert): LexicalNode

Parameters

Name	Type
nodeToInsert	LexicalNode

Returns

LexicalNode

Overrides

ElementNode.insertBefore

Defined in

lexical-list/src/LexicalListItemNode.ts:356

---

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:247

---

isParentRequired

▸ isParentRequired(): true

Returns

true

Overrides

ElementNode.isParentRequired

Defined in

lexical-list/src/LexicalListItemNode.ts:399

---

remove

▸ remove(preserveEmptyParent?): void

Parameters

Name	Type
preserveEmptyParent?	boolean

Returns

void

Overrides

ElementNode.remove

Defined in

lexical-list/src/LexicalListItemNode.ts:234

---

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:135

---

setChecked

▸ setChecked(checked?): void

Parameters

Name	Type
checked?	boolean

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:315

---

setIndent

▸ setIndent(indent): ListItemNode

Parameters

Name	Type
indent	number

Returns

ListItemNode

Overrides

ElementNode.setIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:341

---

setValue

▸ setValue(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:304

---

toggleChecked

▸ toggleChecked(): void

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:320

---

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:91

---

clone

▸ Static clone(node): ListItemNode

Parameters

Name	Type
node	ListItemNode

Returns

ListItemNode

Overrides

ElementNode.clone

Defined in

lexical-list/src/LexicalListItemNode.ts:67

---

getType

▸ Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-list/src/LexicalListItemNode.ts:63

---

importDOM

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

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical-list/src/LexicalListItemNode.ts:110