Skip to main content

Class: TableRowNode

@lexical/table.TableRowNode

Hierarchy

Constructors

constructor

new TableRowNode(height?, key?): TableRowNode

Parameters

NameType
height?number
key?string

Returns

TableRowNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:58

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:110


canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:114


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-table/src/LexicalTableRowNode.ts:72


exportJSON

exportJSON(): SerializedTableRowNode

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

SerializedTableRowNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:63


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionnull | BaseSelection
destination"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:84


getHeight

getHeight(): undefined | number

Returns

undefined | number

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:102


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Overrides

ElementNode.isShadowRoot

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:92


setHeight

setHeight(height): undefined | null | number

Parameters

NameType
heightnumber

Returns

undefined | null | number

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:96


updateDOM

updateDOM(prevNode): 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
prevNodeTableRowNode

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:106


clone

clone(node): TableRowNode

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
nodeTableRowNode

Returns

TableRowNode

Overrides

ElementNode.clone

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:41


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-table/src/LexicalTableRowNode.ts:37


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:45


importJSON

importJSON(serializedNode): TableRowNode

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
serializedNodeSerializedTableRowNode

Returns

TableRowNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:54