Skip to main content

Class: ListNode

@lexical/list.ListNode

Hierarchy

Constructors

constructor

new ListNode(listType, start, key?)

Parameters

NameType
listTypeListType
startnumber
key?string

Overrides

ElementNode.constructor

Defined in

lexical-list/src/LexicalListNode.ts:68

Methods

append

append(...nodesToAppend): ListNode

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

ListNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListNode.ts:173


canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

lexical-list/src/LexicalListNode.ts:165


canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

lexical-list/src/LexicalListNode.ts:169


createDOM

createDOM(config, _editor?): HTMLElement

Parameters

NameType
configEditorConfig
_editor?LexicalEditor

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-list/src/LexicalListNode.ts:90


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

lexical-list/src/LexicalListNode.ts:139


exportJSON

exportJSON(): SerializedListNode

Returns

SerializedListNode

Overrides

ElementNode.exportJSON

Defined in

lexical-list/src/LexicalListNode.ts:154


extractWithChild

extractWithChild(child): boolean

Parameters

NameType
childLexicalNode

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-list/src/LexicalListNode.ts:197


getListType

getListType(): ListType

Returns

ListType

Defined in

lexical-list/src/LexicalListNode.ts:80


getStart

getStart(): number

Returns

number

Defined in

lexical-list/src/LexicalListNode.ts:84


getTag

getTag(): ListNodeTagType

Returns

ListNodeTagType

Defined in

lexical-list/src/LexicalListNode.ts:76


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeListNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-list/src/LexicalListNode.ts:104


clone

Static clone(node): ListNode

Parameters

NameType
nodeListNode

Returns

ListNode

Overrides

ElementNode.clone

Defined in

lexical-list/src/LexicalListNode.ts:62


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-list/src/LexicalListNode.ts:58


importDOM

Static importDOM(): null | DOMConversionMap<HTMLElement>

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical-list/src/LexicalListNode.ts:118


importJSON

Static importJSON(serializedNode): ListNode

Parameters

NameType
serializedNodeSerializedListNode

Returns

ListNode

Overrides

ElementNode.importJSON

Defined in

lexical-list/src/LexicalListNode.ts:131