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

packages/lexical-list/src/LexicalListItemNode.ts:69

Methods

append

append(...nodes): ListItemNode

Parameters

NameType
...nodesLexicalNode[]

Returns

ListItemNode

Overrides

ElementNode.append

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:153


canInsertAfter

canInsertAfter(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Overrides

ElementNode.canInsertAfter

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:372


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Overrides

ElementNode.canMergeWith

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:380


canReplaceWith

canReplaceWith(replacement): boolean

Parameters

NameType
replacementLexicalNode

Returns

boolean

Overrides

ElementNode.canReplaceWith

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:376


collapseAtStart

collapseAtStart(selection): true

Parameters

NameType
selectionRangeSelection

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:271


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:75


createParentElementNode

createParentElementNode(): ElementNode

Returns

ElementNode

Overrides

ElementNode.createParentElementNode

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:403


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:135


exportJSON

exportJSON(): SerializedListItemNode

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

SerializedListItemNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:143


extractWithChild

extractWithChild(child, selection): boolean

Parameters

NameType
childLexicalNode
selectionBaseSelection

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:384


getChecked

getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:321


getIndent

getIndent(): number

Returns

number

Overrides

ElementNode.getIndent

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:336


getValue

getValue(): number

Returns

number

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:310


insertAfter

insertAfter(node, restoreSelection?): LexicalNode

Parameters

NameTypeDefault value
nodeLexicalNodeundefined
restoreSelectionbooleantrue

Returns

LexicalNode

Overrides

ElementNode.insertAfter

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:213


insertNewAfter

insertNewAfter(_, restoreSelection?): ParagraphNode | ListItemNode

Parameters

NameTypeDefault value
_RangeSelectionundefined
restoreSelectionbooleantrue

Returns

ParagraphNode | ListItemNode

Overrides

ElementNode.insertNewAfter

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:259


isParentRequired

isParentRequired(): true

Returns

true

Overrides

ElementNode.isParentRequired

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:399


remove

remove(preserveEmptyParent?): void

Parameters

NameType
preserveEmptyParent?boolean

Returns

void

Overrides

ElementNode.remove

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:243


replace

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

Type parameters

NameType
Nextends LexicalNode

Parameters

NameType
replaceWithNodeN
includeChildren?boolean

Returns

N

Overrides

ElementNode.replace

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:169


setChecked

setChecked(checked?): void

Parameters

NameType
checked?boolean

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:327


setIndent

setIndent(indent): ListItemNode

Parameters

NameType
indentnumber

Returns

ListItemNode

Overrides

ElementNode.setIndent

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:353


setValue

setValue(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:316


toggleChecked

toggleChecked(): void

Returns

void

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:332


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeListItemNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:86


clone

Static clone(node): ListItemNode

Parameters

NameType
nodeListItemNode

Returns

ListItemNode

Overrides

ElementNode.clone

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:65


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:61


importDOM

Static importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:117


importJSON

Static importJSON(serializedNode): ListItemNode

Parameters

NameType
serializedNodeSerializedListItemNode

Returns

ListItemNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:126


transform

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

Returns

fn

▸ (node): void

Parameters
NameType
nodeLexicalNode
Returns

void

Overrides

ElementNode.transform

Defined in

packages/lexical-list/src/LexicalListItemNode.ts:102