tiptap/docs/api/nodes/table.md
2021-09-16 14:41:25 +02:00

4.0 KiB
Raw Blame History

Table

Version Downloads

Nothing is as much fun as a good old HTML table. The Table extension enables you to add this holy grail of WYSIWYG editing to your editor.

Dont forget to add a spacer.gif. (Just joking. If you dont know what that is, dont listen.)

Installation

# with npm
npm install @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell

# with Yarn
yarn add @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell

This extension requires the TableRow, TableHeader and TableCell nodes.

Settings

Option Type Default Description
HTMLAttributes Object {} Custom HTML attributes that should be added to the rendered HTML tag.
resizable Boolean false
handleWidth Number 5
cellMinWidth Number 25
View View TableView
lastColumnResizable Boolean true
allowTableNodeSelection Boolean false

Commands

Command Parameters Description
insertTable { rows = 3, cols = 3, withHeaderRow = true }
addColumnBefore
addColumnAfter
deleteColumn
addRowBefore
addRowAfter
deleteRow
deleteTable
mergeCells
splitCell
toggleHeaderColumn
toggleHeaderRow
toggleHeaderCell
mergeOrSplit
setCellAttribute name, value
goToNextCell
goToPreviousCell
fixTables

Source code

packages/extension-table/

Usage