Class: TableNode

@lexical/table.TableNode

Hierarchy

• ElementNode

  ↳ TableNode

Constructors

constructor

• new TableNode(key?): TableNode

Parameters

Name	Type
key?	string

Returns

TableNode

Overrides

ElementNode.constructor

Defined in

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

Properties

__colWidths

• Optional __colWidths: readonly number[]

Defined in

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

---

__frozenColumnCount

• __frozenColumnCount: number

Defined in

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

---

__frozenRowCount

• __frozenRowCount: number

Defined in

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

Methods

afterCloneFrom

▸ afterCloneFrom(prevNode): void

Perform any state updates on the clone of prevNode that are not already handled by the constructor call in the static clone method. If you have state to update in your clone that is not handled directly by the constructor, it is advisable to override this method but it is required to include a call to super.afterCloneFrom(prevNode) in your implementation. This is only intended to be called by $cloneWithProperties function or via a super call.

Parameters

Name	Type
prevNode	this

Returns

void

Example

class ClassesTextNode extends TextNode {
  // Not shown: static getType, static importJSON, exportJSON, createDOM, updateDOM
  __classes = new Set<string>();
  static clone(node: ClassesTextNode): ClassesTextNode {
    // The inherited TextNode constructor is used here, so
    // classes is not set by this method.
    return new ClassesTextNode(node.__text, node.__key);
  }
  afterCloneFrom(node: this): void {
    // This calls TextNode.afterCloneFrom and LexicalNode.afterCloneFrom
    // for necessary state updates
    super.afterCloneFrom(node);
    this.__addClasses(node.__classes);
  }
  // This method is a private implementation detail, it is not
  // suitable for the public API because it does not call getWritable
  __addClasses(classNames: Iterable<string>): this {
    for (const className of classNames) {
      this.__classes.add(className);
    }
    return this;
  }
  addClass(...classNames: string[]): this {
    return this.getWritable().__addClasses(classNames);
  }
  removeClass(...classNames: string[]): this {
    const node = this.getWritable();
    for (const className of classNames) {
      this.__classes.delete(className);
    }
    return this;
  }
  getClasses(): Set<string> {
    return this.getLatest().__classes;
  }
}

Overrides

ElementNode.afterCloneFrom

Defined in

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

---

canBeEmpty

▸ canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

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

---

canIndent

▸ canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

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

---

canSelectBefore

▸ canSelectBefore(): true

Returns

true

Defined in

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

---

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

Name	Type	Description
config	EditorConfig	allows access to things like the EditorTheme (to apply classes) during reconciliation.
editor?	LexicalEditor	allows access to the editor for context during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

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

---

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

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

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

---

exportJSON

▸ exportJSON(): SerializedTableNode

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

SerializedTableNode

Overrides

ElementNode.exportJSON

Defined in

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

---

extractWithChild

▸ extractWithChild(child, selection, destination): boolean

Parameters

Name	Type
child	LexicalNode
selection	null | BaseSelection
destination	"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

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

---

getCellNodeFromCords

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

Parameters

Name	Type
x	number
y	number
table	TableDOMTable

Returns

null | TableCellNode

Defined in

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

---

getCellNodeFromCordsOrThrow

▸ getCellNodeFromCordsOrThrow(x, y, table): TableCellNode

Parameters

Name	Type
x	number
y	number
table	TableDOMTable

Returns

TableCellNode

Defined in

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

---

getColWidths

▸ getColWidths(): undefined | readonly number[]

Returns

undefined | readonly number[]

Defined in

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

---

getColumnCount

▸ getColumnCount(): number

Returns

number

Defined in

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

---

getCordsFromCellNode

▸ getCordsFromCellNode(tableCellNode, table): Object

Parameters

Name	Type
tableCellNode	TableCellNode
table	TableDOMTable

Returns

Object

Name	Type
x	number
y	number

Defined in

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

---

getDOMCellFromCords

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

Parameters

Name	Type
x	number
y	number
table	TableDOMTable

Returns

null | TableDOMCell

Defined in

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

---

getDOMCellFromCordsOrThrow

▸ getDOMCellFromCordsOrThrow(x, y, table): TableDOMCell

Parameters

Name	Type
x	number
y	number
table	TableDOMTable

Returns

TableDOMCell

Defined in

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

---

getDOMSlot

▸ getDOMSlot(element): ElementDOMSlot

Parameters

Name	Type
element	HTMLElement

Returns

ElementDOMSlot

Overrides

ElementNode.getDOMSlot

Defined in

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

---

getFrozenColumns

▸ getFrozenColumns(): number

Returns

number

Defined in

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

---

getFrozenRows

▸ getFrozenRows(): number

Returns

number

Defined in

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

---

getRowStriping

▸ getRowStriping(): boolean

Returns

boolean

Defined in

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

---

isShadowRoot

▸ isShadowRoot(): boolean

Returns

boolean

Overrides

ElementNode.isShadowRoot

Defined in

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

---

setColWidths

▸ setColWidths(colWidths): this

Parameters

Name	Type
colWidths	undefined | readonly number[]

Returns

this

Defined in

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

---

setFrozenColumns

▸ setFrozenColumns(columnCount): this

Parameters

Name	Type
columnCount	number

Returns

this

Defined in

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

---

setFrozenRows

▸ setFrozenRows(rowCount): this

Parameters

Name	Type
rowCount	number

Returns

this

Defined in

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

---

setRowStriping

▸ setRowStriping(newRowStriping): this

Parameters

Name	Type
newRowStriping	boolean

Returns

this

Defined in

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

---

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

Name	Type
prevNode	this
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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

---

updateFromJSON

▸ updateFromJSON(serializedNode): this

Update this LexicalNode instance from serialized JSON. It's recommended to implement as much logic as possible in this method instead of the static importJSON method, so that the functionality can be inherited in subclasses.

The LexicalUpdateJSON utility type should be used to ignore any type, version, or children properties in the JSON so that the extended JSON from subclasses are acceptable parameters for the super call.

If overridden, this method must call super.

Parameters

Name	Type
serializedNode	LexicalUpdateJSON<SerializedTableNode>

Returns

this

Example

class MyTextNode extends TextNode {
  // ...
  static importJSON(serializedNode: SerializedMyTextNode): MyTextNode {
    return $createMyTextNode()
      .updateFromJSON(serializedNode);
  }
  updateFromJSON(
    serializedNode: LexicalUpdateJSON<SerializedMyTextNode>,
  ): this {
    return super.updateFromJSON(serializedNode)
      .setMyProperty(serializedNode.myProperty);
  }
}

Overrides

ElementNode.updateFromJSON

Defined in

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

---

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

Name	Type
node	TableNode

Returns

TableNode

Overrides

ElementNode.clone

Defined in

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

---

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

---

importDOM

▸ importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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

---

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

Name	Type
serializedNode	SerializedTableNode

Returns

TableNode

Overrides

ElementNode.importJSON

Defined in

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