Skip to main content

Class: TableNode

@lexical/table.TableNode

Hierarchy

Constructors

constructor

new TableNode(key?): TableNode

Parameters

NameType
key?string

Returns

TableNode

Overrides

ElementNode.constructor

Defined in

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

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

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


canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

packages/lexical-table/src/LexicalTableNode.ts:228


canSelectBefore

canSelectBefore(): true

Returns

true

Defined in

packages/lexical-table/src/LexicalTableNode.ts:224


createDOM

createDOM(config, editor?): 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.
editor?LexicalEditorallows access to the editor for context during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-table/src/LexicalTableNode.ts:70


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-table/src/LexicalTableNode.ts:82


exportJSON

exportJSON(): SerializedElementNode

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

SerializedElementNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-table/src/LexicalTableNode.ts:62


getCellNodeFromCords

getCellNodeFromCords(x, y, table): null | TableCellNode

Parameters

NameType
xnumber
ynumber
tableTableDOMTable

Returns

null | TableCellNode

Defined in

packages/lexical-table/src/LexicalTableNode.ts:190


getCellNodeFromCordsOrThrow

getCellNodeFromCordsOrThrow(x, y, table): TableCellNode

Parameters

NameType
xnumber
ynumber
tableTableDOMTable

Returns

TableCellNode

Defined in

packages/lexical-table/src/LexicalTableNode.ts:210


getCordsFromCellNode

getCordsFromCellNode(tableCellNode, table): Object

Parameters

NameType
tableCellNodeTableCellNode
tableTableDOMTable

Returns

Object

NameType
xnumber
ynumber

Defined in

packages/lexical-table/src/LexicalTableNode.ts:122


getDOMCellFromCords

getDOMCellFromCords(x, y, table): null | TableDOMCell

Parameters

NameType
xnumber
ynumber
tableTableDOMTable

Returns

null | TableDOMCell

Defined in

packages/lexical-table/src/LexicalTableNode.ts:152


getDOMCellFromCordsOrThrow

getDOMCellFromCordsOrThrow(x, y, table): TableDOMCell

Parameters

NameType
xnumber
ynumber
tableTableDOMTable

Returns

TableDOMCell

Defined in

packages/lexical-table/src/LexicalTableNode.ts:176


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Overrides

ElementNode.isShadowRoot

Defined in

packages/lexical-table/src/LexicalTableNode.ts:118


updateDOM

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

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-table/src/LexicalTableNode.ts:78


clone

clone(node): TableNode

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
nodeTableNode

Returns

TableNode

Overrides

ElementNode.clone

Defined in

packages/lexical-table/src/LexicalTableNode.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/LexicalTableNode.ts:37


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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


importJSON

importJSON(_serializedNode): TableNode

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
_serializedNodeSerializedTableNode

Returns

TableNode

Overrides

ElementNode.importJSON

Defined in

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