React Data Grid Clipboard

Table of contents

• Overview
• Copy & Cut
  • End-user usage
  • Context menu
  • Trigger copy & cut programmatically
  • Hooks
• Paste
  • End-user usage
  • Context menu
  • Trigger paste programmatically
  • Hooks
• Limitations
• Related keyboard shortcuts
• Related API reference

Overview

The clipboard offers Copy & Cut and Paste functionality, enabling you to copy & cut cell data from Handsontable and paste it to the system clipboard. This can be achieved either via shortcut keys or by triggering a copy & cut or paste programmatically.

Copy & Cut

Copy & Cut actions allow exporting data from Handsontable to the system clipboard. The CopyPaste plugin copies and cuts data as a text/plain and a text/html MIME-type.

End-user usage

Available keyboard shortcuts:

• Ctrl/Cmd + C - copies the content of the last cell in the selected range
• Ctrl/Cmd + X - cuts the content of the last cell in the selected range

Available options in the browser's toolbar:

• Edit > Copy - copies the content of the last cell in the selected range
• Edit > Cut - cuts the content of the last cell in the selected range

Context menu

When the context menu is enabled, it includes default items, including copy & cut options.

• Copy - as a predefined key copy
• Cut - as a predefined key cut

You can use them in the same way as the rest of the predefined items in the context menu. These operations are executed by document.execCommand().

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 = () => { return ( <HotTable data={Handsontable.helper.createSpreadsheetData(5, 5)} rowHeaders={true} colHeaders={true} contextMenu={['copy', 'cut']} height="auto" licenseKey="non-commercial-and-evaluation" /> ); }; 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>

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 = () => {
  return (
    <HotTable
      data={Handsontable.helper.createSpreadsheetData(5, 5)}
      rowHeaders={true}
      colHeaders={true}
      contextMenu={['copy', 'cut']}
      height="auto"
      licenseKey="non-commercial-and-evaluation"
    />
  );
};

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

Trigger copy & cut programmatically

TIP

To use the Handsontable API, you'll need access to the Handsontable instance. You can do that by utilizing a reference to the HotTable component, and reading its hotInstance property.

For more information, see the Instance Methods page.

First, select a cell range to copy or cut.

hot.selectCell(1, 1);

Then use one of the following commands:

• document.execCommand('copy')
• document.execCommand('cut')

The CopyPaste plugin listens to the browser's copy and cut events. If triggered, our implementation will copy or cut the selected data to the system clipboard.

import { useEffect, useRef } 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 copyBtnClickCallback = function() { document.execCommand('copy'); }; const cutBtnClickCallback = function() { document.execCommand('cut'); }; let copyBtnMousedownCallback; let cutBtnMousedownCallback; useEffect(() => { const hot = hotRef.current.hotInstance; copyBtnMousedownCallback = function() { hot.selectCell(1, 1); }; cutBtnMousedownCallback = function() { hot.selectCell(1, 1); }; }); return ( <> <HotTable ref={hotRef} rowHeaders={true} colHeaders={true} data={Handsontable.helper.createSpreadsheetData(5, 5)} outsideClickDeselects={false} height="auto" licenseKey="non-commercial-and-evaluation" /> <div className="controls"> <button id="copy" onMouseDown={(...args) => copyBtnMousedownCallback(...args)} onClick={(...args) => copyBtnClickCallback(...args)} > Select and copy cell B2 </button> <button id="cut" onMouseDown={(...args) => cutBtnMousedownCallback(...args)} onClick={(...args) => cutBtnClickCallback(...args)} > Select and cut cell B2 </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>

import { useEffect, useRef } 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 copyBtnClickCallback = function() {
    document.execCommand('copy');
  };
  const cutBtnClickCallback = function() {
    document.execCommand('cut');
  };
  let copyBtnMousedownCallback;
  let cutBtnMousedownCallback;

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

    copyBtnMousedownCallback = function() {
      hot.selectCell(1, 1);
    };
    cutBtnMousedownCallback = function() {
      hot.selectCell(1, 1);
    };
  });

  return (
    <>
      <HotTable
        ref={hotRef}
        rowHeaders={true}
        colHeaders={true}
        data={Handsontable.helper.createSpreadsheetData(5, 5)}
        outsideClickDeselects={false}
        height="auto"
        licenseKey="non-commercial-and-evaluation"
      />
      <div className="controls">
        <button
          id="copy"
          onMouseDown={(...args) => copyBtnMousedownCallback(...args)}
          onClick={(...args) => copyBtnClickCallback(...args)}
        >
          Select and copy cell B2
        </button>
        <button
          id="cut"
          onMouseDown={(...args) => cutBtnMousedownCallback(...args)}
          onClick={(...args) => cutBtnClickCallback(...args)}
        >
          Select and cut cell B2
        </button>
      </div>
    </>
  );
};

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

Note: Not all selection-related Handsontable methods result in it gaining focus. Make sure your table instance is focused by calling isListening() before copying or pasting data.

Hooks

The CopyPaste plugin exposes the following hooks to manipulate data during copy or cut operations:

• beforeCopy
• afterCopy
• beforeCut
• afterCut

Examples of how to use them are provided in their descriptions.

Paste

The Paste action allows the importing of data from external sources using the user's system clipboard. The CopyPaste firstly looks for text/html in the system clipboard, followed by text/plain.

End-user usage

Available keyboard shortcuts:

• Ctrl/Cmd + V - paste the content into the last cell in the selected range

Available options in the browser's toolbar:

• Edit > Paste - paste the content into the last cell in the selected range

Context menu

Due to security reasons, modern browsers disallow reading from the system clipboard. Learn more (opens new window)

Trigger paste programmatically

Due to security reasons, modern browsers disallow reading from the system clipboard. Learn more (opens new window)

Hooks

The CopyPaste plugin exposes the following hooks to manipulate data during the pasting operation:

• beforePaste
• afterPaste

Examples of how to use them are provided in their descriptions.

Limitations

1. The CopyPaste plugin doesn't copy, cut or paste cells' appearance.
2. The data copied from Handsontable will always remain as plain text. For example, if you copy a checked checkbox, the input will be kept as a value of 'true'.
3. document.execCommand can be called only during an immediate-execute event, such as a MouseEvent or a KeyboardEvent.

Related keyboard shortcuts

Windows	macOS	Action	Excel	Sheets
Ctrl + X	Cmd + X	Cut the contents of the selected cells to the system clipboard	✓	✓
Ctrl + C	Cmd + C	Copy the contents of the selected cells to the system clipboard	✓	✓
Ctrl + V	Cmd + V	Paste from the system clipboard	✓	✓

Related API reference

• Configuration options:
  • copyPaste
  • copyable
  • skipColumnOnPaste
  • skipRowOnPaste
• Core methods:
  • getCopyableData()
  • getCopyableText()
• Hooks:
  • afterCopy
  • afterCopyLimit
  • afterCut
  • afterPaste
  • beforeCopy
  • beforeCut
  • beforePaste
  • modifyCopyableRange
• Plugins:
  • CopyPaste