Class: ListNode

@lexical/list.ListNode

Hierarchy

• ElementNode

  ↳ ListNode

Constructors

constructor

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

Parameters

Name	Type
listType	ListType
start	number
key?	string

Returns

ListNode

Overrides

ElementNode.constructor

Defined in

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

Methods

append

▸ append(...nodesToAppend): this

Parameters

Name	Type
...nodesToAppend	LexicalNode[]

Returns

this

Overrides

ElementNode.append

Defined in

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

---

canBeEmpty

▸ canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

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

---

canIndent

▸ canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

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

---

createDOM

▸ createDOM(config, _editor?): HTMLElement

Parameters

Name	Type
config	EditorConfig
_editor?	LexicalEditor

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

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

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

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

---

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

---

extractWithChild

▸ extractWithChild(child): boolean

Parameters

Name	Type
child	LexicalNode

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

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

---

getListType

▸ getListType(): ListType

Returns

ListType

Defined in

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

---

getStart

▸ getStart(): number

Returns

number

Defined in

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

---

getTag

▸ getTag(): ListNodeTagType

Returns

ListNodeTagType

Defined in

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

---

setListType

▸ setListType(type): void

Parameters

Name	Type
type	ListType

Returns

void

Defined in

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

---

updateDOM

▸ updateDOM(prevNode, dom, config): boolean

Parameters

Name	Type
prevNode	ListNode
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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

---

clone

▸ clone(node): ListNode

Parameters

Name	Type
node	ListNode

Returns

ListNode

Overrides

ElementNode.clone

Defined in

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

---

getType

▸ getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

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

---

importDOM

▸ importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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

---

importJSON

▸ importJSON(serializedNode): ListNode

Parameters

Name	Type
serializedNode	SerializedListNode

Returns

ListNode

Overrides

ElementNode.importJSON

Defined in

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

---

transform

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

Returns

fn

▸ (node): void

Parameters

Name	Type
node	LexicalNode

Returns

void

Overrides

ElementNode.transform

Defined in

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