React Data Grid Selection

Overview
Basic configuration
Selecting ranges
Getting data from the selected ranges
Modifying the selected cells
Styling the selection area
Jumping across the grid's edges
Related keyboard shortcuts
Related API reference

Overview

Selection enables you to select a single cell or ranges of cells within Handsontable. Once selected, you can retrieve data from the cell, edit the cell's contents, or change the style of the cell.

Basic configuration

With this feature, you can select single cells or ranges of cells across a grid. Easily retrieve the coordinates of the selected cells to clear or change the cells' content.

Use Cmd on Mac or Ctrl on Windows to select non-adjacent ranges of cells.

Selecting ranges

There are different modes in which you can use this plugin. Choose between selecting a single cell, a range of adjacent cells, and multiple non-adjacent ranges of cells.

Possible values of selectionMode:

single - A single cell can be selected.
range - Multiple cells within a single range can be selected.
multiple - Multiple non-contiguous ranges of cells can be selected.

import { useRef, useEffect } from 'react';
import Handsontable from 'handsontable';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.min.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = () => {
  const hotRef = useRef(null);

  let selectOptionChangeCallback;

  useEffect(() => {
    const hot = hotRef.current.hotInstance;

    selectOptionChangeCallback = event => {
      const value = event.target.value;
      const first = value.split(' ')[0].toLowerCase();

      hot.updateSettings({
        selectionMode: first
      });
    };
  });

  return (
    <>
      <HotTable
        ref={hotRef}
        data={Handsontable.helper.createSpreadsheetData(10, 10)}
        width="auto"
        height="auto"
        colWidths={100}
        rowHeights={23}
        rowHeaders={true}
        colHeaders={true}
        selectionMode="multiple" // 'single', 'range' or 'multiple',
        licenseKey="non-commercial-and-evaluation"
      />
      <div className="controls">
        <select
          id="selectOption"
          style={{width: 'auto', marginTop: 16}}
          onChange={(...args) => selectOptionChangeCallback(...args)}
          defaultValue="multiple"
        >
          <option value="single">Single selection</option>
          <option value="range">Range selection</option>
          <option value="multiple">Multiple ranges selection</option>
        </select>
      </div>
    </>
  );
};

ReactDOM.render(<ExampleComponent />, document.getElementById('example1'));

<script src="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.js"></script>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.css" /> 
<script src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@handsontable/react@12.1/dist/react-handsontable.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/fixer.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/helpers.js"></script>

<div id="example1" class="hot "></div>

Getting data from the selected ranges

To retrieve the selected cells as an array of arrays, you use the getSelected() or getSelectedRange() methods.

import { useRef, useEffect, useState } from 'react';
import Handsontable from 'handsontable';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.min.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = () => {
  const hotRef = useRef(null);
  const [output, setOutput] = useState('');

  let getButtonClickCallback;

  useEffect(() => {
    const hot = hotRef.current.hotInstance;

    getButtonClickCallback = event => {
      const selected = hot.getSelected() || [];
      const data = [];

      for (let i = 0; i < selected.length; i += 1) {
        const item = selected[i];

        data.push(hot.getData(...item));
      }

      setOutput(JSON.stringify(data));
    };
  });

  return (
    <>
      <HotTable
        ref={hotRef}
        data={Handsontable.helper.createSpreadsheetData(10, 10)}
        width="auto"
        height="auto"
        colWidths={100}
        rowHeights={23}
        rowHeaders={true}
        colHeaders={true}
        outsideClickDeselects={false}
        selectionMode="multiple" // 'single', 'range' or 'multiple',
        licenseKey="non-commercial-and-evaluation"
      />
      <output className="console" id="output">{output}</output>
      <div className="controls">
        <button
          id="getButton"
          onClick={(...args) => getButtonClickCallback(...args)}
        >
          Get data
        </button>
      </div>
    </>
  );
};

ReactDOM.render(<ExampleComponent />, document.getElementById('example2'));

<script src="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.js"></script>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.css" /> 
<script src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@handsontable/react@12.1/dist/react-handsontable.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/fixer.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/helpers.js"></script>

<div id="example2" class="hot "></div>

Modifying the selected cells

You may want to delete, format, or otherwise change the selected cells. For example, you can change a value or add CSS classes to the selected cells using the demo below.

import { useRef, useEffect } from 'react';
import Handsontable from 'handsontable';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.min.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = () => {
  const hotRef = useRef(null);

  let buttonClickCallback;

  useEffect(() => {
    const hot = hotRef.current.hotInstance;

    buttonClickCallback = event => {
      const selected = hot.getSelected() || [];
      const target = event.target.id;

      hot.suspendRender();

      for (let index = 0; index < selected.length; index += 1) {
        const [row1, column1, row2, column2] = selected[index];
        const startRow = Math.max(Math.min(row1, row2), 0);
        const endRow = Math.max(row1, row2);
        const startCol = Math.max(Math.min(column1, column2), 0);
        const endCol = Math.max(column1, column2);

        for (let rowIndex = startRow; rowIndex <= endRow; rowIndex += 1) {
          for (let columnIndex = startCol; columnIndex <= endCol; columnIndex += 1) {
            hot.setDataAtCell(rowIndex, columnIndex, 'data changed');
            hot.setCellMeta(rowIndex, columnIndex, 'className', 'c-red');
          }
        }
      }

      hot.render();
      hot.resumeRender();
    };
  });

  return (
    <>
      <HotTable
        ref={hotRef}
        data={Handsontable.helper.createSpreadsheetData(10, 10)}
        width="auto"
        height={272}
        colWidths={100}
        rowHeights={23}
        rowHeaders={true}
        colHeaders={true}
        outsideClickDeselects={false}
        selectionMode="multiple" // 'single', 'range' or 'multiple',
        licenseKey="non-commercial-and-evaluation"
      />
      <div className="controls">
        <button id="set-data-action" onClick={(...args) => buttonClickCallback(...args)}>Change selected data and change the CSS class of the cell</button>
      </div>
    </>
  );
};

ReactDOM.render(<ExampleComponent />, document.getElementById('example3'));

<script src="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.js"></script>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.css" /> 
<script src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@handsontable/react@12.1/dist/react-handsontable.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/fixer.js"></script>
<script src="https://handsontable.com/docs/12.1/scripts/helpers.js"></script>

<div id="example3" class="hot "></div>

.c-red {
  color: red;
}

import { useRef, useEffect } from 'react';
import Handsontable from 'handsontable';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.min.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = () => {
  const hotRef = useRef(null);

  let buttonClickCallback;

  useEffect(() => {
    const hot = hotRef.current.hotInstance;

    buttonClickCallback = event => {
      const selected = hot.getSelected() || [];
      const target = event.target.id;

      hot.suspendRender();

      for (let index = 0; index < selected.length; index += 1) {
        const [row1, column1, row2, column2] = selected[index];
        const startRow = Math.max(Math.min(row1, row2), 0);
        const endRow = Math.max(row1, row2);
        const startCol = Math.max(Math.min(column1, column2), 0);
        const endCol = Math.max(column1, column2);

        for (let rowIndex = startRow; rowIndex <= endRow; rowIndex += 1) {
          for (let columnIndex = startCol; columnIndex <= endCol; columnIndex += 1) {
            hot.setDataAtCell(rowIndex, columnIndex, 'data changed');
            hot.setCellMeta(rowIndex, columnIndex, 'className', 'c-red');
          }
        }
      }

      hot.render();
      hot.resumeRender();
    };
  });

  return (
    <>
      <HotTable
        ref={hotRef}
        data={Handsontable.helper.createSpreadsheetData(10, 10)}
        width="auto"
        height={272}
        colWidths={100}
        rowHeights={23}
        rowHeaders={true}
        colHeaders={true}
        outsideClickDeselects={false}
        selectionMode="multiple" // 'single', 'range' or 'multiple',
        licenseKey="non-commercial-and-evaluation"
      />
      <div className="controls">
        <button id="set-data-action" onClick={(...args) => buttonClickCallback(...args)}>Change selected data and change the CSS class of the cell</button>
      </div>
    </>
  );
};

ReactDOM.render(<ExampleComponent />, document.getElementById('example3'));

Styling the selection area

The background color can be easily changed using CSS styles. The main, light blue background color is defined in the .area class.

For non-adjacent selection, multiple classes are making each level a bit darker. These classes are called area-1, area-2, etc.

Unfortunately, there is no easy way to change the border color of the selection.

Jumping across the grid's edges

When you use keyboard navigation, and you cross an edge of the grid, you can set cell selection to jump to the opposite edge.

Jumping across vertical edges

To enable jumping across the left and right edges:

Set the autoWrapRow configuration option to true.

To jump across a vertical edge:

When cell selection is on a row's first cell, press the left arrow key.
When cell selection is on a row's last cell, press the right arrow key, or press Tab.

Jumping across horizontal edges

To enable jumping across the top and bottom edges:

Set the autoWrapCol configuration option to true.

To jump across a horizontal edge:

When cell selection is on a column's first cell, press the up arrow key.
When cell selection is on a column's last cell, press the down arrow key, or press Enter.

Windows	macOS	Action	Excel	Sheets
`Ctrl` + `A`	`Cmd` + `A`	Select all cells and headers	✓	✓
`Ctrl` + `Shift` + `↑`	`Cmd` + `Shift` + `↑`	Extend the selection to the first cell of the current column^**	✓	✓
`Ctrl` + `Shift` + `↓`	`Cmd` + `Shift` + `↓`	Extend the selection to the last cell of the current column^**	✓	✓
`Ctrl` + `Shift` + `←`	`Cmd` + `Shift` + `←`	Extend the selection to the leftmost cell of the current row^**	✓	✓
`Ctrl` + `Shift` + `→`	`Cmd` + `Shift` + `→`	Extend the selection to the rightmost cell of the current row^**	✓	✓
`Shift` + Arrow keys	`Shift` + Arrow keys	Extend the selection by one cell	✓	✓
`Shift` + `Home`	`Shift` + `Home`	Extend the selection to the first non-frozen cell of the current row^*	✓	✗
`Shift` + `End`	`Shift` + `End`	Extend the selection to the last non-frozen cell of the current row^*	✗	✗
`Shift` + `Page Up`	`Shift` + `Page Up`	Extend the selection by one screen up	✓	✓
`Shift` + `Page Down`	`Shift` + `Page Down`	Extend the selection by one screen down	✓	✓
`Ctrl` + `Enter`	`Cmd` + `Enter`	Fill the selected range of cells with the value of the active cell	✗	✓
`Delete`	`Delete`	Clear the contents of the selected cells	✓	✓
`Backspace`	`Backspace`	Clear the contents of the selected cells	✓	✓

^* This action depends on your layout direction.
^** In case of multiple selection layers, only the last selection layer gets extended.

← Clipboard Merge cells →