plugins/HighlightOnly

Wraps a plugin so that it only activates its tdStyle and tdClassName when the cell is highlighted, unless a column is configured otherwise.

Options

Plugins can configure explicit overrides using the highlight property within their column-based configuration. highlight can be set to 'always' to ensure the plugin is run for that column regardless of highlight.

For example, column.plugins.heatmap.highlight = 'always' will disable HighlightOnly for the column if HighlightOnly is applied to a plugin with id heatmap.

  • onRowHighlight {Boolean} set to true means apply the plugin on row highlight
  • onColumnHighlight {Boolean} set to true means apply the plugin on column highlight
Source:
Example
<TacoTable plugins={[HighlightOnly(HeatmapPlugin, { onRowHighlight: true, onColumnHighlight: true })]} ... />

Methods

(inner) HighlightOnly(Plugin, options) → {Object}

Parameters:
Name Type Description
Plugin Object

The Plugin definition (e.g. HeatmapPlugin)
options Object

The options for HighlightOnly
Source:
Returns:

A new plugin that wraps Plugin's tdStyle and tdClassName

Type
Object