Class: ListNode

@lexical/list.ListNode

Hierarchy

• ElementNode

  ↳ ListNode

Constructors

constructor

• new ListNode(listType, start, key?)

Parameters

Name	Type
listType	ListType
start	number
key?	string

Overrides

ElementNode.constructor

Defined in

lexical-list/src/LexicalListNode.ts:67

Methods

append

▸ append(...nodesToAppend): ListNode

Parameters

Name	Type
...nodesToAppend	LexicalNode[]

Returns

ListNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListNode.ts:164

---

canBeEmpty

▸ canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

lexical-list/src/LexicalListNode.ts:156

---

canIndent

▸ canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

lexical-list/src/LexicalListNode.ts:160

---

createDOM

▸ createDOM(config, _editor?): HTMLElement

Parameters

Name	Type
config	EditorConfig
_editor?	LexicalEditor

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-list/src/LexicalListNode.ts:89

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

lexical-list/src/LexicalListNode.ts:130

---

exportJSON

▸ exportJSON(): SerializedListNode

Returns

SerializedListNode

Overrides

ElementNode.exportJSON

Defined in

lexical-list/src/LexicalListNode.ts:145

---

extractWithChild

▸ extractWithChild(child): boolean

Parameters

Name	Type
child	LexicalNode

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-list/src/LexicalListNode.ts:188

---

getListType

▸ getListType(): ListType

Returns

ListType

Defined in

lexical-list/src/LexicalListNode.ts:79

---

getStart

▸ getStart(): number

Returns

number

Defined in

lexical-list/src/LexicalListNode.ts:83

---

getTag

▸ getTag(): ListNodeTagType

Returns

ListNodeTagType

Defined in

lexical-list/src/LexicalListNode.ts:75

---

updateDOM

▸ updateDOM(prevNode, dom, config): boolean

Parameters

Name	Type
prevNode	ListNode
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-list/src/LexicalListNode.ts:103

---

clone

▸ Static clone(node): ListNode

Parameters

Name	Type
node	ListNode

Returns

ListNode

Overrides

ElementNode.clone

Defined in

lexical-list/src/LexicalListNode.ts:61

---

getType

▸ Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-list/src/LexicalListNode.ts:57

---

importDOM

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

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical-list/src/LexicalListNode.ts:117