Skip to content

Type Editor


Type Editor / @type-editor/tables / cellselection/draw-cell-selection / drawCellSelection

Function: drawCellSelection()

ts
function drawCellSelection(state): DecorationSource;

Defined in: tables/src/cellselection/draw-cell-selection.ts:23

Creates decorations to visually highlight selected cells in the editor.

This function is typically used as part of a ProseMirror plugin's decorations to apply the 'selectedCell' CSS class to all cells within a CellSelection.

Parameters

ParameterTypeDescription
statePmEditorStateThe current editor state.

Returns

DecorationSource

A DecorationSource containing node decorations for selected cells, or null if the current selection is not a CellSelection.

Example

typescript
// In a plugin's props.decorations:
decorations: (state) => drawCellSelection(state);