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

Methods

append

append(...nodesToAppend): ListNode

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

ListNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListNode.ts:187


canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

lexical-list/src/LexicalListNode.ts:179


canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

lexical-list/src/LexicalListNode.ts:183


createDOM

createDOM(config, _editor?): HTMLElement

Parameters

NameType
configEditorConfig
_editor?LexicalEditor

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-list/src/LexicalListNode.ts:97


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

lexical-list/src/LexicalListNode.ts:153


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

lexical-list/src/LexicalListNode.ts:168


extractWithChild

extractWithChild(child): boolean

Parameters

NameType
childLexicalNode

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-list/src/LexicalListNode.ts:210


getListType

getListType(): ListType

Returns

ListType

Defined in

lexical-list/src/LexicalListNode.ts:87


getStart

getStart(): number

Returns

number

Defined in

lexical-list/src/LexicalListNode.ts:91


getTag

getTag(): ListNodeTagType

Returns

ListNodeTagType

Defined in

lexical-list/src/LexicalListNode.ts:77


setListType

setListType(type): void

Parameters

NameType
typeListType

Returns

void

Defined in

lexical-list/src/LexicalListNode.ts:81


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeListNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-list/src/LexicalListNode.ts:111


clone

Static clone(node): ListNode

Parameters

NameType
nodeListNode

Returns

ListNode

Overrides

ElementNode.clone

Defined in

lexical-list/src/LexicalListNode.ts:63


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-list/src/LexicalListNode.ts:59


importDOM

Static importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

lexical-list/src/LexicalListNode.ts:132


importJSON

Static importJSON(serializedNode): ListNode

Parameters

NameType
serializedNodeSerializedListNode

Returns

ListNode

Overrides

ElementNode.importJSON

Defined in

lexical-list/src/LexicalListNode.ts:145


transform

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

Returns

fn

▸ (node): void

Parameters
NameType
nodeLexicalNode
Returns

void

Overrides

ElementNode.transform

Defined in

lexical-list/src/LexicalListNode.ts:125