Skip to main content

Class: ListItemNode

@lexical/list.ListItemNode

Hierarchy

Constructors

constructor

new ListItemNode(value?, checked?, key?)

Parameters

NameType
value?number
checked?boolean
key?string

Overrides

ElementNode.constructor

Defined in

lexical-list/src/LexicalListItemNode.ts:71

Methods

append

append(...nodes): ListItemNode

Parameters

NameType
...nodesLexicalNode[]

Returns

ListItemNode

Overrides

ElementNode.append

Defined in

lexical-list/src/LexicalListItemNode.ts:137


canInsertAfter

canInsertAfter(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Overrides

ElementNode.canInsertAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:387


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Overrides

ElementNode.canMergeWith

Defined in

lexical-list/src/LexicalListItemNode.ts:395


canReplaceWith

canReplaceWith(replacement): boolean

Parameters

NameType
replacementLexicalNode

Returns

boolean

Overrides

ElementNode.canReplaceWith

Defined in

lexical-list/src/LexicalListItemNode.ts:391


collapseAtStart

collapseAtStart(selection): true

Parameters

NameType
selectionRangeSelection

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

lexical-list/src/LexicalListItemNode.ts:277


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

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


exportJSON

exportJSON(): SerializedListItemNode

Returns

SerializedListItemNode

Overrides

ElementNode.exportJSON

Defined in

lexical-list/src/LexicalListItemNode.ts:127


extractWithChild

extractWithChild(child, selection): boolean

Parameters

NameType
childLexicalNode
selectionRangeSelection | NodeSelection | GridSelection

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-list/src/LexicalListItemNode.ts:399


getChecked

getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

lexical-list/src/LexicalListItemNode.ts:327


getIndent

getIndent(): number

Returns

number

Overrides

ElementNode.getIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:342


getValue

getValue(): number

Returns

number

Defined in

lexical-list/src/LexicalListItemNode.ts:316


insertAfter

insertAfter(node, restoreSelection?): LexicalNode

Parameters

NameTypeDefault value
nodeLexicalNodeundefined
restoreSelectionbooleantrue

Returns

LexicalNode

Overrides

ElementNode.insertAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:199


insertBefore

insertBefore(nodeToInsert): LexicalNode

Parameters

NameType
nodeToInsertLexicalNode

Returns

LexicalNode

Overrides

ElementNode.insertBefore

Defined in

lexical-list/src/LexicalListItemNode.ts:374


insertNewAfter

insertNewAfter(_, restoreSelection?): ParagraphNode | ListItemNode

Parameters

NameTypeDefault value
_RangeSelectionundefined
restoreSelectionbooleantrue

Returns

ParagraphNode | ListItemNode

Overrides

ElementNode.insertNewAfter

Defined in

lexical-list/src/LexicalListItemNode.ts:265


isParentRequired

isParentRequired(): true

Returns

true

Overrides

ElementNode.isParentRequired

Defined in

lexical-list/src/LexicalListItemNode.ts:417


remove

remove(preserveEmptyParent?): void

Parameters

NameType
preserveEmptyParent?boolean

Returns

void

Overrides

ElementNode.remove

Defined in

lexical-list/src/LexicalListItemNode.ts:252


replace

replace<N>(replaceWithNode, includeChildren?): N

Type parameters

NameType
Nextends LexicalNode<N>

Parameters

NameType
replaceWithNodeN
includeChildren?boolean

Returns

N

Overrides

ElementNode.replace

Defined in

lexical-list/src/LexicalListItemNode.ts:153


setChecked

setChecked(checked?): void

Parameters

NameType
checked?boolean

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:333


setIndent

setIndent(indent): ListItemNode

Parameters

NameType
indentnumber

Returns

ListItemNode

Overrides

ElementNode.setIndent

Defined in

lexical-list/src/LexicalListItemNode.ts:359


setValue

setValue(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:322


toggleChecked

toggleChecked(): void

Returns

void

Defined in

lexical-list/src/LexicalListItemNode.ts:338


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeListItemNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-list/src/LexicalListItemNode.ts:91


clone

Static clone(node): ListItemNode

Parameters

NameType
nodeListItemNode

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


importJSON

Static importJSON(serializedNode): ListItemNode

Parameters

NameType
serializedNodeSerializedListItemNode

Returns

ListItemNode

Overrides

ElementNode.importJSON

Defined in

lexical-list/src/LexicalListItemNode.ts:119