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:109
Methods
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:280
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:284
collapseAtStart
▸ collapseAtStart(): true
Returns
true
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:276
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
| Name | Type | Description |
|---|---|---|
config | EditorConfig | allows access to things like the EditorTheme (to apply classes) during reconciliation. |
Returns
HTMLElement
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:123
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:150
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:180
getBackgroundColor
▸ getBackgroundColor(): null | string
Returns
null | string
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:234
getColSpan
▸ getColSpan(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:192
getHeaderStyles
▸ getHeaderStyles(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:220
getRowSpan
▸ getRowSpan(): number
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:201
getTag
▸ getTag(): string
Returns
string
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:210
getWidth
▸ getWidth(): undefined | number
Returns
undefined | number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:230
hasHeader
▸ hasHeader(): boolean
Returns
boolean
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:258
hasHeaderState
▸ hasHeaderState(headerState): boolean
Parameters
| Name | Type |
|---|---|
headerState | number |
Returns
boolean
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:254
isShadowRoot
▸ isShadowRoot(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:272
setBackgroundColor
▸ setBackgroundColor(newBackgroundColor): void
Parameters
| Name | Type |
|---|---|
newBackgroundColor | null | string |
Returns
void
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:238
setColSpan
▸ setColSpan(colSpan): this
Parameters
| Name | Type |
|---|---|
colSpan | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:196
setHeaderStyles
▸ setHeaderStyles(headerState): number
Parameters
| Name | Type |
|---|---|
headerState | number |
Returns
number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:214
setRowSpan
▸ setRowSpan(rowSpan): this
Parameters
| Name | Type |
|---|---|
rowSpan | number |
Returns
this
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:205
setWidth
▸ setWidth(width): undefined | null | number
Parameters
| Name | Type |
|---|---|
width | number |
Returns
undefined | null | number
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:224
toggleHeaderStyle
▸ toggleHeaderStyle(headerStateToToggle): TableCellNode
Parameters
| Name | Type |
|---|---|
headerStateToToggle | number |
Returns
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:242
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 | TableCellNode |
Returns
boolean
Overrides
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:262
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:71
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:67
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-table/src/LexicalTableCellNode.ts:83
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 |