Skip to main content

Module: @lexical/table

Classes​

Type Aliases​

Cell​

Ƭ Cell: Object

Type declaration​

NameType
elemHTMLElement
highlightedboolean
xnumber
ynumber

Defined in​

lexical-table/src/LexicalTableSelection.ts:40

HTMLTableElementWithWithTableSelectionState​

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

Defined in​

lexical-table/src/LexicalTableSelectionHelpers.ts:986

InsertTableCommandPayload​

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

Defined in​

lexical-table/src/index.ts:89

InsertTableCommandPayloadHeaders​

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

Defined in​

lexical-table/src/index.ts:82

Variables​

INSERT_TABLE_COMMAND​

• Const INSERT_TABLE_COMMAND: LexicalCommand<InsertTableCommandPayload>

Defined in​

lexical-table/src/index.ts:95

TableCellHeaderStates​

• Const TableCellHeaderStates: Object

Type declaration​

NameType
BOTHnumber
COLUMNnumber
NO_STATUSnumber
ROWnumber

Defined in​

lexical-table/src/LexicalTableCellNode.ts:28

Functions​

$createTableCellNode​

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

Parameters​

NameTypeDefault value
headerStatenumberundefined
colSpannumber1
width?numberundefined

Returns​

TableCellNode

Defined in​

lexical-table/src/LexicalTableCellNode.ts:222

$createTableNode​

▸ $createTableNode(): TableNode

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableNode.ts:219

$createTableNodeWithDimensions​

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

Parameters​

NameTypeDefault value
rowCountnumberundefined
columnCountnumberundefined
includeHeadersInsertTableCommandPayloadHeaderstrue

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:30

$createTableRowNode​

▸ $createTableRowNode(height?): TableRowNode

Parameters​

NameType
height?number

Returns​

TableRowNode

Defined in​

lexical-table/src/LexicalTableRowNode.ts:91

$deleteTableColumn​

▸ $deleteTableColumn(tableNode, targetIndex): TableNode

Parameters​

NameType
tableNodeTableNode
targetIndexnumber

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:274

$getElementGridForTableNode​

▸ $getElementGridForTableNode(editor, tableNode): Grid

Parameters​

NameType
editorLexicalEditor
tableNodeTableNode

Returns​

Grid

Defined in​

lexical-table/src/LexicalTableNode.ts:202

$getTableCellNodeFromLexicalNode​

▸ $getTableCellNodeFromLexicalNode(startingNode): TableCellNode | null

Parameters​

NameType
startingNodeLexicalNode

Returns​

TableCellNode | null

Defined in​

lexical-table/src/LexicalTableUtils.ts:66

$getTableColumnIndexFromTableCellNode​

▸ $getTableColumnIndexFromTableCellNode(tableCellNode): number

Parameters​

NameType
tableCellNodeTableCellNode

Returns​

number

Defined in​

lexical-table/src/LexicalTableUtils.ts:110

$getTableNodeFromLexicalNodeOrThrow​

▸ $getTableNodeFromLexicalNodeOrThrow(startingNode): TableNode

Parameters​

NameType
startingNodeLexicalNode

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:90

$getTableRowIndexFromTableCellNode​

▸ $getTableRowIndexFromTableCellNode(tableCellNode): number

Parameters​

NameType
tableCellNodeTableCellNode

Returns​

number

Defined in​

lexical-table/src/LexicalTableUtils.ts:102

$getTableRowNodeFromTableCellNodeOrThrow​

▸ $getTableRowNodeFromTableCellNodeOrThrow(startingNode): TableRowNode

Parameters​

NameType
startingNodeLexicalNode

Returns​

TableRowNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:78

$insertTableColumn​

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

Parameters​

NameTypeDefault value
tableNodeTableNodeundefined
targetIndexnumberundefined
shouldInsertAfterbooleantrue
columnCountnumberundefined
gridGridundefined

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:220

$insertTableRow​

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

Parameters​

NameTypeDefault value
tableNodeTableNodeundefined
targetIndexnumberundefined
shouldInsertAfterbooleantrue
rowCountnumberundefined
gridGridundefined

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:153

$isTableCellNode​

▸ $isTableCellNode(node): node is TableCellNode

Parameters​

NameType
nodeundefined | null | LexicalNode

Returns​

node is TableCellNode

Defined in​

lexical-table/src/LexicalTableCellNode.ts:230

$isTableNode​

▸ $isTableNode(node): node is TableNode

Parameters​

NameType
nodeundefined | null | LexicalNode

Returns​

node is TableNode

Defined in​

lexical-table/src/LexicalTableNode.ts:223

$isTableRowNode​

▸ $isTableRowNode(node): node is TableRowNode

Parameters​

NameType
nodeundefined | null | LexicalNode

Returns​

node is TableRowNode

Defined in​

lexical-table/src/LexicalTableRowNode.ts:95

$removeTableRowAtIndex​

▸ $removeTableRowAtIndex(tableNode, indexToDelete): TableNode

Parameters​

NameType
tableNodeTableNode
indexToDeletenumber

Returns​

TableNode

Defined in​

lexical-table/src/LexicalTableUtils.ts:138

applyTableHandlers​

▸ applyTableHandlers(tableNode, tableElement, editor): TableSelection

Parameters​

NameType
tableNodeTableNode
tableElementHTMLTableElementWithWithTableSelectionState
editorLexicalEditor

Returns​

TableSelection

Defined in​

lexical-table/src/LexicalTableSelectionHelpers.ts:59

getCellFromTarget​

▸ getCellFromTarget(node): Cell | null

Parameters​

NameType
nodeNode

Returns​

Cell | null

Defined in​

lexical-table/src/LexicalTableSelectionHelpers.ts:1002

getTableSelectionFromTableElement​

▸ getTableSelectionFromTableElement(tableElement): TableSelection | null

Parameters​

NameType
tableElementHTMLTableElementWithWithTableSelectionState

Returns​

TableSelection | null

Defined in​

lexical-table/src/LexicalTableSelectionHelpers.ts:996