Class: TableCellNode
@lexical/table.TableCellNode
Hierarchy
-
↳
TableCellNode
Constructors
constructor
• new TableCellNode(headerState?
, colSpan?
, width?
, key?
): TableCellNode
Parameters
Name | Type | Default value |
---|---|---|
headerState | number | TableCellHeaderStates.NO_STATUS |
colSpan | number | 1 |
width? | number | undefined |
key? | string | undefined |
Returns
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:117
Methods
afterCloneFrom
▸ afterCloneFrom(node
): 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 |
---|---|
node | 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/LexicalTableCellNode.ts:82
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:290
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:294
collapseAtStart
▸ collapseAtStart(): true
Returns
true
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:286
createDOM
▸ createDOM(config
): HTMLTableCellElement
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. |
Returns
HTMLTableCellElement
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:131
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/LexicalTableCellNode.ts:156
exportJSON
▸ exportJSON(): SerializedTableCellNode
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/LexicalTableCellNode.ts:184
getBackgroundColor
▸ getBackgroundColor(): null
| string
Returns
null
| string
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:242
getColSpan
▸ getColSpan(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:195
getHeaderStyles
▸ getHeaderStyles(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:228
getRowSpan
▸ getRowSpan(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:205
getTag
▸ getTag(): "td"
| "th"
Returns
"td"
| "th"
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:215
getWidth
▸ getWidth(): undefined
| number
Returns
undefined
| number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:238
hasHeader
▸ hasHeader(): boolean
Returns
boolean
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:268
hasHeaderState
▸ hasHeaderState(headerState
): boolean
Parameters
Name | Type |
---|---|
headerState | number |
Returns
boolean
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:264
isShadowRoot
▸ isShadowRoot(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:282
setBackgroundColor
▸ setBackgroundColor(newBackgroundColor
): this
Parameters
Name | Type |
---|---|
newBackgroundColor | null | string |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:246
setColSpan
▸ setColSpan(colSpan
): this
Parameters
Name | Type |
---|---|
colSpan | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:199
setHeaderStyles
▸ setHeaderStyles(headerState
, mask?
): this
Parameters
Name | Type | Default value |
---|---|---|
headerState | number | undefined |
mask | number | TableCellHeaderStates.BOTH |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:219
setRowSpan
▸ setRowSpan(rowSpan
): this
Parameters
Name | Type |
---|---|
rowSpan | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:209
setWidth
▸ setWidth(width
): this
Parameters
Name | Type |
---|---|
width | undefined | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:232
toggleHeaderStyle
▸ toggleHeaderStyle(headerStateToToggle
): this
Parameters
Name | Type |
---|---|
headerStateToToggle | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:252
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
Name | Type |
---|---|
prevNode | this |
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:272
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 <SerializedTableCellNode > |
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
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:105
clone
▸ clone(node
): TableCellNode
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 | TableCellNode |
Returns
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:73
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/LexicalTableCellNode.ts:69
importDOM
▸ importDOM(): null
| DOMConversionMap
Returns
null
| DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:88
importJSON
▸ importJSON(serializedNode
): TableCellNode
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 | SerializedTableCellNode |