Class: TableNode
@lexical/table.TableNode
Hierarchy
-
↳
TableNode
Constructors
constructor
• new TableNode(key?): TableNode
Parameters
| Name | Type |
|---|---|
key? | string |
Returns
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:158
Properties
__colWidths
• Optional __colWidths: number[] | readonly number[]
Defined in
packages/lexical-table/src/LexicalTableNode.ts:114
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
Defined in
packages/lexical-table/src/LexicalTableNode.ts:136
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:262
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:383
canSelectBefore
▸ canSelectBefore(): true
Returns
true
Defined in
packages/lexical-table/src/LexicalTableNode.ts:379
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
Defined in
packages/lexical-table/src/LexicalTableNode.ts:186
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
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:229
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
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:163
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:337
getCellNodeFromCordsOrThrow
▸ getCellNodeFromCordsOrThrow(x, y, table): TableCellNode
Parameters
| Name | Type |
|---|---|
x | number |
y | number |
table | TableDOMTable |
Returns
Defined in
packages/lexical-table/src/LexicalTableNode.ts:357
getColWidths
▸ getColWidths(): undefined | number[] | readonly number[]
Returns
undefined | number[] | readonly number[]
Defined in
packages/lexical-table/src/LexicalTableNode.ts:120
getColumnCount
▸ getColumnCount(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableNode.ts:387
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:270
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:299
getDOMCellFromCordsOrThrow
▸ getDOMCellFromCordsOrThrow(x, y, table): TableDOMCell
Parameters
| Name | Type |
|---|---|
x | number |
y | number |
table | TableDOMTable |
Returns
Defined in
packages/lexical-table/src/LexicalTableNode.ts:323
getDOMSlot
▸ getDOMSlot(element): ElementDOMSlot
Parameters
| Name | Type |
|---|---|
element | HTMLElement |
Returns
Overrides
ElementNode.getDOMSlot
Defined in
packages/lexical-table/src/LexicalTableNode.ts:173
getRowStriping
▸ getRowStriping(): boolean
Returns
boolean
Defined in
packages/lexical-table/src/LexicalTableNode.ts:371
isShadowRoot
▸ isShadowRoot(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:266
setColWidths
▸ setColWidths(colWidths): this
Parameters
| Name | Type |
|---|---|
colWidths | readonly number[] |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableNode.ts:125
setRowStriping
▸ setRowStriping(newRowStriping): void
Parameters
| Name | Type |
|---|---|
newRowStriping | boolean |
Returns
void
Defined in
packages/lexical-table/src/LexicalTableNode.ts:375
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 | TableNode |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:217
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
Overrides
Defined in
packages/lexical-table/src/LexicalTableNode.ts:132
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
Defined in
packages/lexical-table/src/LexicalTableNode.ts:116
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-table/src/LexicalTableNode.ts:142
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 |