React Data Grid: Clipboard
You can copy and paste items to and from the grid using the system clipboard.
Copy to clipboard operation can be done in the following ways:
- Select 'Copy' from the context menu that appears when you right click over a cell.
- Press keys Ctrl+C while focus is on the grid.
- Use the API methods: copySelectedRowsToClipboard(includeHeaders) and copySelectedRangeToClipboard(includeHeaders)
The API calls take a boolean value
includeHeaders which when true, will include column headers in what is copied.
Headers can also be included when copying to clipboard using Ctrl+C by setting:
gridOptions.copyHeadersToClipboard = true.
Performing multiple Ctrl+<left click> operations followed by Ctrl+C will not preserve original cell layout but rather copy them vertically to the clipboard.
Paste to clipboard can only be done in the following ways:
- Press keys Ctrl+V while focus in on the grid with a single cell selected. The paste will then proceed starting at the selected cell if multiple cells are to be pasted.
- Press keys Ctrl+V while focus in on the grid with a range of cells selected. If the selected range being pasted is larger than copied range, it will repeat if it fits evenly, otherwise it will just copy the cells into the start of the range.
The copy operation will copy selected ranges, selected rows, or the currently focused cell, based on this order:
- If range selected (via range selection), copy range.
- Else if rows selected (via row selection), copy rows.
- Else copy focused cell.
You can copy multiple ranges in range selection by holding down Ctrl to select multiple ranges and then copy.
Pasting is on by default as long as cells are editable (non-editable cells cannot be modified, even with a paste operation). To turn paste operations off, set grid property
The colDef has a property
suppressPaste where you can specify to not allowing clipboard paste for a particular cell. This can be a boolean or a function (use a function to specify for a particular cell, or boolean for the whole column).
boolean | SuppressPasteCallback
Pasting is on by default as long as cells are editable (non-editable cells cannot be modified, even with a paste operation). Set to
The following events are relevant to clipboard operations:
pasteStart: Paste event has started.
pasteEnd: Paste event has ended.
cellValueChanged: A cells value has changed. Typically happens after editing but also if cell value is changed as a result of paste operation.
For a paste operation the events will be fired as:
If the application is doing work each time it receives a
cellValueChanged, you can use the
pasteEnd events to suspend the applications work and then do the work for all cells impacted by the paste operation after the paste operation.
There are no events for paste to clipboard as this does not update the grids data.
Below you can:
- Copy with the Context Menu or Ctrl+C.
- Paste with Ctrl+V.
- Copy with the provided buttons.
- Notice for paste that events
cellValueChangedare logged to the console.
- Buttons 'Toggle Paste On' and 'Toggle Paste Off' turn pasting on and off.
The example has both row click selection and range selection enabled. You probably won't do this in your application as it's confusing, it's done below just to demonstrate them side by side.
When row click selection and range selection are enabled the shortcut would copy the selected row, not the
selected range, if you wish to let the range take precedence, then you can add this to your gridOptions
If you want to do the copy to clipboard yourself (ie not use the grids clipboard interaction) then implement the callback
sendToClipboard(params). Use this if you are in a non-standard web container that has a bespoke API for interacting with the clipboard. The callback gets the data to go into the clipboard, it's your job to call the bespoke API.
The example below shows using
sendToClipboard(params), but rather than using the clipboard, demonstrates the callback by just printing the data to the console.
It is possible to process clipboard data before pasting it into the grid. This can be done either on individual cells or the whole paste operation.
The interfaces and parameters for processing individual cells are as follows:
Allows you to process cells for the clipboard. Handy if for example you have
Allows you to process header values for the clipboard.
Allows you to process cells from the clipboard. Handy if for example you have number fields, and want to block non-numbers from getting into the grid.
These three callbacks above are demonstrated in the example below. Note the following:
- When cells are copied to the clipboard, values are prefixed with 'C-'. Cells can be copied by dragging a range with the mouse and hitting Ctrl+C.
- When cells are pasted from the clipboard, values are prefixed with 'Z-'. Cells can be pasted by hitting Ctrl+V.
- When headers are copied to the clipboard, values are prefixed with 'H-'. Headers can be copied by using the context menu.
The interface and parameters for processing the whole paste operation is as follows:
Allows complete control of the paste operation, including cancelling the operation (so nothing happens) or replacing the data with other data.
In summary the
processDataFromClipboard takes a 2d array of data that was taken from the clipboard and the method returns a 2d array of data to be used. For the method to have no impact, it should return the 2d array it was provided. The method is free to return back anything it wants, as long as it is a 2d array of strings.
The example below demonstrates
processDataFromClipboard. Note the following:
- Pasting data that is copied from cells in the 'Green' highlighted column works as normal. Note that it uses
processDataFromClipboardreturning the 2d array it was provided with.
- Pasting any data from cells in the 'Red' highlighted column will result in 2x2 cells getting pasted with contents
[ ['Orange', 'Orange'], ['Grey', 'Grey'] ]. To see this, copy and paste some 'Red' cells from column F. This is achieved by
processDataFromClipboardreturning the same 2d array always regardless of the data from the clipboard.
- Pasting any data where a cell starts with 'Yellow' will result in the paste operation getting cancelled. To see this, copy and paste some 'Yellow' cells from column G. This is achieved by
By default, the grid will use
\t (tab) as the field deliminator. This is to keep the copy / paste compatible with Excel. If you want another deliminator then use the property
If instead of using the Clipboard service to copy/paste the contents from a cell, you just want to manually select the text and use the operating system copy/paste. You should set
enableCellTextSelection=true in the gridOptions. It's important to mention that this config should be combined with
ensureDomOrder=true also in the gridOptions.
This is not an enterprise config and can be used at any time to enable cell text selection.
The example below demonstrates:
- Uses CSV by setting
clipboardDeliminator=','. To test, copy to clipboard, then paste into a text editor.
- Does not allow paste into the 'silver' column by setting