Skip to main content

Class: ListItemNode

@lexical/list.ListItemNode

Hierarchy

Constructors

constructor

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

Parameters

NameType
value?number
checked?boolean
key?string

Returns

ListItemNode

Overrides

ElementNode.constructor

Defined in

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

Methods

append

append(...nodes): this

Parameters

NameType
...nodesLexicalNode[]

Returns

this

Overrides

ElementNode.append

Defined in

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


canMergeWhenEmpty

canMergeWhenEmpty(): true

Determines whether this node, when empty, can merge with a first block of nodes being inserted.

This method is specifically called in RangeSelection.insertNodes to determine merging behavior during nodes insertion.

Returns

true

Example

// In a ListItemNode or QuoteNode implementation:
canMergeWhenEmpty(): true {
return true;
}

Overrides

ElementNode.canMergeWhenEmpty

Defined in

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


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Overrides

ElementNode.canMergeWith

Defined in

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


collapseAtStart

collapseAtStart(selection): true

Parameters

NameType
selectionRangeSelection

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

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


createDOM

createDOM(config): HTMLElement

Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.

This method must return exactly one HTMLElement. Nested elements are not supported.

Do not attempt to update the Lexical EditorState during this phase of the update lifecyle.

Parameters

NameTypeDescription
configEditorConfigallows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

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


createParentElementNode

createParentElementNode(): ElementNode

The creation logic for any required parent. Should be implemented if isParentRequired returns true.

Returns

ElementNode

Overrides

ElementNode.createParentElementNode

Defined in

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


exportDOM

exportDOM(editor): DOMExportOutput

Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

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


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


extractWithChild

extractWithChild(child, selection): boolean

Parameters

NameType
childLexicalNode
selectionBaseSelection

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

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


getChecked

getChecked(): undefined | boolean

Returns

undefined | boolean

Defined in

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


getIndent

getIndent(): number

Returns

number

Overrides

ElementNode.getIndent

Defined in

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


getValue

getValue(): number

Returns

number

Defined in

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


insertAfter

insertAfter(node, restoreSelection?): LexicalNode

Inserts a node after this LexicalNode (as the next sibling).

Parameters

NameTypeDefault valueDescription
nodeLexicalNodeundefinedThe node to insert after this one.
restoreSelectionbooleantrueWhether or not to attempt to resolve the selection to the appropriate place after the operation is complete.

Returns

LexicalNode

Overrides

ElementNode.insertAfter

Defined in

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


insertNewAfter

insertNewAfter(_, restoreSelection?): ParagraphNode | ListItemNode

Parameters

NameTypeDefault value
_RangeSelectionundefined
restoreSelectionbooleantrue

Returns

ParagraphNode | ListItemNode

Overrides

ElementNode.insertNewAfter

Defined in

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


isParentRequired

isParentRequired(): true

Whether or not this node has a required parent. Used during copy + paste operations to normalize nodes that would otherwise be orphaned. For example, ListItemNodes without a ListNode parent or TextNodes with a ParagraphNode parent.

Returns

true

Overrides

ElementNode.isParentRequired

Defined in

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


remove

remove(preserveEmptyParent?): void

Removes this LexicalNode from the EditorState. If the node isn't re-inserted somewhere, the Lexical garbage collector will eventually clean it up.

Parameters

NameTypeDescription
preserveEmptyParent?booleanIf falsy, the node's parent will be removed if it's empty after the removal operation. This is the default behavior, subject to other node heuristics such as ElementNode#canBeEmpty

Returns

void

Overrides

ElementNode.remove

Defined in

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


replace

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

Replaces this LexicalNode with the provided node, optionally transferring the children of the replaced node to the replacing node.

Type parameters

NameType
Nextends LexicalNode

Parameters

NameTypeDescription
replaceWithNodeNThe node to replace this one with.
includeChildren?booleanWhether or not to transfer the children of this node to the replacing node.

Returns

N

Overrides

ElementNode.replace

Defined in

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


setChecked

setChecked(checked?): void

Parameters

NameType
checked?boolean

Returns

void

Defined in

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


setIndent

setIndent(indent): this

Parameters

NameType
indentnumber

Returns

this

Overrides

ElementNode.setIndent

Defined in

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


setValue

setValue(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

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


toggleChecked

toggleChecked(): void

Returns

void

Defined in

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


updateDOM

updateDOM(prevNode, dom, config): boolean

Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.

Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.

Parameters

NameType
prevNodeListItemNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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


clone

clone(node): ListItemNode

Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.

Parameters

NameType
nodeListItemNode

Returns

ListItemNode

Overrides

ElementNode.clone

Defined in

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


getType

getType(): string

Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.

Returns

string

Overrides

ElementNode.getType

Defined in

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


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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


importJSON

importJSON(serializedNode): ListItemNode

Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.

Parameters

NameType
serializedNodeSerializedListItemNode

Returns

ListItemNode

Overrides

ElementNode.importJSON

Defined in

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


transform

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

Registers the returned function as a transform on the node during Editor initialization. Most such use cases should be addressed via the LexicalEditor.registerNodeTransform API.

Experimental - use at your own risk.

Returns

fn

▸ (node): void

Parameters
NameType
nodeLexicalNode
Returns

void

Overrides

ElementNode.transform

Defined in

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