madetech/slate-edit-table

Slate plugin for table edition

slate-edit-table

A Slate plugin to handle table edition.

Install

npm install slate-edit-table

Features

• Pressing Up and Down, move the cursor to next/previous row
• Pressing Enter, insert a new row
• Pressing Tab, move the select to next cell
• Pressing Shift+Tab, move the select to previous cell

Simple Usage

import EditTable from 'slate-edit-table'

const plugins = [
  EditTable()
]

Arguments

• [typeTable: String] — type for table
• [typeRow: String] — type for the rows.
• [typeCell: String] — type for the cells.

Utilities and Transform

slate-edit-table exports utilities and transforms:

utils.isSelectionInTable

plugin.utils.isSelectionInTable(state: State) => Boolean

Return true if selection is inside a table.

transforms.insertTable

plugin.transforms.insertTable(transform: Transform, columns: Number?, rows: Number?) => Transform

Insert a new empty table.

transforms.insertRow

plugin.transforms.insertRow(transform: Transform, at: Number?) => Transform

Insert a new row after the current one or at the specific index (at).

transforms.insertColumn

plugin.transforms.insertColumn(transform: Transform, at: Number?) => Transform

Insert a new column after the current one or at the specific index (at).

transforms.removeTable

plugin.transforms.removeTable(transform: Transform) => Transform

Remove current table.

transforms.removeRow

plugin.transforms.removeRow(transform: Transform, at: Number?) => Transform

Remove current row or the one at a specific index (at).

transforms.removeColumn

plugin.transforms.removeColumn(transform: Transform, at: Number?) => Transform

Remove current column or the one at a specific index (at).

transforms.moveSelection

plugin.transforms.moveSelection(transform: Transform, column: Number, row: Number) => Transform

Move the selection to a specific position in the table.

transforms.moveSelectionBy

plugin.transforms.moveSelectionBy(transform: Transform, column: Number, row: Number) => Transform

Move the selection by the given amount of columns and rows.

transforms.setColumnAlign

plugin.transforms.setColumnAlign(transform: Transform, align: String, at: Number) => Transform

Sets column alignment for a given column (at), in the current table. align defaults to center, at is optional and defaults to current cursor position.