Module: @lexical/table

Classes

• TableCellNode
• TableNode
• TableObserver
• TableRowNode
• TableSelection

Type Aliases

HTMLTableElementWithWithTableSelectionState

Ƭ HTMLTableElementWithWithTableSelectionState: HTMLTableElement & Record<typeof LEXICAL_ELEMENT_KEY, TableObserver>

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:944

---

InsertTableCommandPayload

Ƭ InsertTableCommandPayload: Readonly<{ columns: string ; includeHeaders?: InsertTableCommandPayloadHeaders ; rows: string }>

Defined in

packages/lexical-table/src/LexicalTableCommands.ts:20

---

InsertTableCommandPayloadHeaders

Ƭ InsertTableCommandPayloadHeaders: Readonly<{ columns: boolean ; rows: boolean }> | boolean

Defined in

packages/lexical-table/src/LexicalTableCommands.ts:13

---

SerializedTableCellNode

Ƭ SerializedTableCellNode: Spread<{ backgroundColor?: null | string ; colSpan?: number ; headerState: TableCellHeaderState ; rowSpan?: number ; width?: number }, SerializedElementNode>

Defined in

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

---

SerializedTableNode

Ƭ SerializedTableNode: SerializedElementNode

Defined in

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

---

SerializedTableRowNode

Ƭ SerializedTableRowNode: Spread<{ height?: number }, SerializedElementNode>

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:25

---

TableDOMCell

Ƭ TableDOMCell: Object

Type declaration

Name	Type
elem	HTMLElement
hasBackgroundColor	boolean
highlighted	boolean
x	number
y	number

Defined in

packages/lexical-table/src/LexicalTableObserver.ts:43

---

TableMapType

Ƭ TableMapType: TableMapValueType[][]

Defined in

packages/lexical-table/src/LexicalTableSelection.ts:40

---

TableMapValueType

Ƭ TableMapValueType: Object

Type declaration

Name	Type
cell	TableCellNode
startColumn	number
startRow	number

Defined in

packages/lexical-table/src/LexicalTableSelection.ts:35

---

TableSelectionShape

Ƭ TableSelectionShape: Object

Type declaration

Name	Type
fromX	number
fromY	number
toX	number
toY	number

Defined in

packages/lexical-table/src/LexicalTableSelection.ts:28

Variables

INSERT_TABLE_COMMAND

• Const INSERT_TABLE_COMMAND: LexicalCommand<InsertTableCommandPayload>

Defined in

packages/lexical-table/src/LexicalTableCommands.ts:26

---

TableCellHeaderStates

• Const TableCellHeaderStates: Object

Type declaration

Name	Type
BOTH	number
COLUMN	number
NO_STATUS	number
ROW	number

Defined in

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

Functions

$computeTableMap

▸ $computeTableMap(grid, cellA, cellB): [TableMapType, TableMapValueType, TableMapValueType]

Parameters

Name	Type
grid	TableNode
cellA	TableCellNode
cellB	TableCellNode

Returns

[TableMapType, TableMapValueType, TableMapValueType]

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:724

---

$computeTableMapSkipCellCheck

▸ $computeTableMapSkipCellCheck(grid, cellA, cellB): [TableMapType, TableMapValueType | null, TableMapValueType | null]

Parameters

Name	Type
grid	TableNode
cellA	null | TableCellNode
cellB	null | TableCellNode

Returns

[TableMapType, TableMapValueType | null, TableMapValueType | null]

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:739

---

$createTableCellNode

▸ $createTableCellNode(headerState, colSpan?, width?): TableCellNode

Parameters

Name	Type	Default value
headerState	number	undefined
colSpan	number	1
width?	number	undefined

Returns

TableCellNode

Defined in

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

---

$createTableNode

▸ $createTableNode(): TableNode

Returns

TableNode

Defined in

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

---

$createTableNodeWithDimensions

▸ $createTableNodeWithDimensions(rowCount, columnCount, includeHeaders?): TableNode

Parameters

Name	Type	Default value
rowCount	number	undefined
columnCount	number	undefined
includeHeaders	InsertTableCommandPayloadHeaders	true

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:39

---

$createTableRowNode

▸ $createTableRowNode(height?): TableRowNode

Parameters

Name	Type
height?	number

Returns

TableRowNode

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:122

---

$createTableSelection

▸ $createTableSelection(): TableSelection

Returns

TableSelection

Defined in

packages/lexical-table/src/LexicalTableSelection.ts:347

---

$deleteTableColumn

▸ $deleteTableColumn(tableNode, targetIndex): TableNode

Parameters

Name	Type
tableNode	TableNode
targetIndex	number

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:476

---

$deleteTableColumn__EXPERIMENTAL

▸ $deleteTableColumn__EXPERIMENTAL(): void

Returns

void

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:575

---

$deleteTableRow__EXPERIMENTAL

▸ $deleteTableRow__EXPERIMENTAL(): void

Returns

void

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:499

---

$findCellNode

▸ $findCellNode(node): null | TableCellNode

Parameters

Name	Type
node	LexicalNode

Returns

null | TableCellNode

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:1331

---

$findTableNode

▸ $findTableNode(node): null | TableNode

Parameters

Name	Type
node	LexicalNode

Returns

null | TableNode

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:1336

---

$getElementForTableNode

▸ $getElementForTableNode(editor, tableNode): TableDOMTable

Parameters

Name	Type
editor	LexicalEditor
tableNode	TableNode

Returns

TableDOMTable

Defined in

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

---

$getNodeTriplet

▸ $getNodeTriplet(source): [TableCellNode, TableRowNode, TableNode]

Parameters

Name	Type
source	LexicalNode | PointType | TableCellNode

Returns

[TableCellNode, TableRowNode, TableNode]

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:798

---

$getTableCellNodeFromLexicalNode

▸ $getTableCellNodeFromLexicalNode(startingNode): TableCellNode | null

Parameters

Name	Type
startingNode	LexicalNode

Returns

TableCellNode | null

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:81

---

$getTableCellNodeRect

▸ $getTableCellNodeRect(tableCellNode): { colSpan: number ; columnIndex: number ; rowIndex: number ; rowSpan: number } | null

Parameters

Name	Type
tableCellNode	TableCellNode

Returns

{ colSpan: number ; columnIndex: number ; rowIndex: number ; rowSpan: number } | null

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:832

---

$getTableColumnIndexFromTableCellNode

▸ $getTableColumnIndexFromTableCellNode(tableCellNode): number

Parameters

Name	Type
tableCellNode	TableCellNode

Returns

number

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:125

---

$getTableNodeFromLexicalNodeOrThrow

▸ $getTableNodeFromLexicalNodeOrThrow(startingNode): TableNode

Parameters

Name	Type
startingNode	LexicalNode

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:105

---

$getTableRowIndexFromTableCellNode

▸ $getTableRowIndexFromTableCellNode(tableCellNode): number

Parameters

Name	Type
tableCellNode	TableCellNode

Returns

number

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:117

---

$getTableRowNodeFromTableCellNodeOrThrow

▸ $getTableRowNodeFromTableCellNodeOrThrow(startingNode): TableRowNode

Parameters

Name	Type
startingNode	LexicalNode

Returns

TableRowNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:93

---

$insertTableColumn

▸ $insertTableColumn(tableNode, targetIndex, shouldInsertAfter?, columnCount, table): TableNode

Parameters

Name	Type	Default value
tableNode	TableNode	undefined
targetIndex	number	undefined
shouldInsertAfter	boolean	true
columnCount	number	undefined
table	TableDOMTable	undefined

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:317

---

$insertTableColumn__EXPERIMENTAL

▸ $insertTableColumn__EXPERIMENTAL(insertAfter?): void

Parameters

Name	Type	Default value
insertAfter	boolean	true

Returns

void

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:376

---

$insertTableRow

▸ $insertTableRow(tableNode, targetIndex, shouldInsertAfter?, rowCount, table): TableNode

Parameters

Name	Type	Default value
tableNode	TableNode	undefined
targetIndex	number	undefined
shouldInsertAfter	boolean	true
rowCount	number	undefined
table	TableDOMTable	undefined

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:168

---

$insertTableRow__EXPERIMENTAL

▸ $insertTableRow__EXPERIMENTAL(insertAfter?): void

Parameters

Name	Type	Default value
insertAfter	boolean	true

Returns

void

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:248

---

$isTableCellNode

▸ $isTableCellNode(node): node is TableCellNode

Parameters

Name	Type
node	undefined | null | LexicalNode

Returns

node is TableCellNode

Defined in

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

---

$isTableNode

▸ $isTableNode(node): node is TableNode

Parameters

Name	Type
node	undefined | null | LexicalNode

Returns

node is TableNode

Defined in

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

---

$isTableRowNode

▸ $isTableRowNode(node): node is TableRowNode

Parameters

Name	Type
node	undefined | null | LexicalNode

Returns

node is TableRowNode

Defined in

packages/lexical-table/src/LexicalTableRowNode.ts:126

---

$isTableSelection

▸ $isTableSelection(x): x is TableSelection

Parameters

Name	Type
x	unknown

Returns

x is TableSelection

Defined in

packages/lexical-table/src/LexicalTableSelection.ts:343

---

$removeTableRowAtIndex

▸ $removeTableRowAtIndex(tableNode, indexToDelete): TableNode

Parameters

Name	Type
tableNode	TableNode
indexToDelete	number

Returns

TableNode

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:153

---

$unmergeCell

▸ $unmergeCell(): void

Returns

void

Defined in

packages/lexical-table/src/LexicalTableUtils.ts:666

---

applyTableHandlers

▸ applyTableHandlers(tableNode, tableElement, editor, hasTabHandler): TableObserver

Parameters

Name	Type
tableNode	TableNode
tableElement	HTMLTableElementWithWithTableSelectionState
editor	LexicalEditor
hasTabHandler	boolean

Returns

TableObserver

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:89

---

getDOMCellFromTarget

▸ getDOMCellFromTarget(node): TableDOMCell | null

Parameters

Name	Type
node	Node

Returns

TableDOMCell | null

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:960

---

getTableObserverFromTableElement

▸ getTableObserverFromTableElement(tableElement): TableObserver | null

Parameters

Name	Type
tableElement	HTMLTableElementWithWithTableSelectionState

Returns

TableObserver | null

Defined in

packages/lexical-table/src/LexicalTableSelectionHelpers.ts:954