React Data Grid Clipboard

Copy data from selected cells to the clipboard, using the Ctrl / Cmd + C shortcut or the context menu. Control the clipboard with Handsontable's API.

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

To let the end user copy the contents of column headers, see the Copy with headers section.

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().

    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.

      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:

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

      Copy with headers

      Let the end user copy the contents of column headers, by enabling additional context menu items:

      Context menu item Copied area
      Copy with header copy_with_headers
      Copy with group header copy_with_group_headers
      Copy header only copy_headers_only

      Right-click on a cell to try it out:

        To add the context menu items, configure the CopyPaste plugin with these options:

        copyPaste: {
          copyColumnHeaders: true,
          copyColumnGroupHeaders: true,
          copyColumnHeadersOnly: true,
        }
        

        To copy column headers programmatically, call the copyPaste.copy() method with these arguments:

        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.

        // access the `CopyPaste` plugin instance
        const copyPastePlugin = hot.getPlugin('copyPaste');
        
        // select some cells
        hot.selectCell(1, 1);
        
        // copy the selected cells along with their nearest column headers
        copyPastePlugin.copy('with-column-headers');
        
        // copy the selected cells along with all their related columns headers
        copyPastePlugin.copy('with-all-column-headers');
        
        // copy the column headers nearest to the selected cells
        // (without copying the cells themselves)
        copyPastePlugin.copy('column-headers-only');
        

        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:

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

        Known 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.
        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