Skip to main content

Class: TableCellNode

@lexical/table.TableCellNode

Hierarchy

Constructors

constructor

new TableCellNode(headerState?, colSpan?, width?, key?): TableCellNode

Parameters

NameTypeDefault value
headerStatenumberTableCellHeaderStates.NO_STATUS
colSpannumber1
width?numberundefined
key?stringundefined

Returns

TableCellNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:109

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:280


canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:284


collapseAtStart

collapseAtStart(): true

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:276


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:123


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

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

SerializedTableCellNode

Overrides

ElementNode.exportJSON

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

NameType
headerStatenumber

Returns

boolean

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:254


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Overrides

ElementNode.isShadowRoot

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:272


setBackgroundColor

setBackgroundColor(newBackgroundColor): void

Parameters

NameType
newBackgroundColornull | string

Returns

void

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:238


setColSpan

setColSpan(colSpan): this

Parameters

NameType
colSpannumber

Returns

this

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:196


setHeaderStyles

setHeaderStyles(headerState): number

Parameters

NameType
headerStatenumber

Returns

number

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:214


setRowSpan

setRowSpan(rowSpan): this

Parameters

NameType
rowSpannumber

Returns

this

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:205


setWidth

setWidth(width): undefined | null | number

Parameters

NameType
widthnumber

Returns

undefined | null | number

Defined in

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


toggleHeaderStyle

toggleHeaderStyle(headerStateToToggle): TableCellNode

Parameters

NameType
headerStateToTogglenumber

Returns

TableCellNode

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:242


updateDOM

updateDOM(prevNode): boolean

Parameters

NameType
prevNodeTableCellNode

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:262


clone

clone(node): TableCellNode

Parameters

NameType
nodeTableCellNode

Returns

TableCellNode

Overrides

ElementNode.clone

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:71


getType

getType(): string

Returns

string

Overrides

ElementNode.getType

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

Parameters

NameType
serializedNodeSerializedTableCellNode

Returns

TableCellNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-table/src/LexicalTableCellNode.ts:96