Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
1 contributor

Users who have contributed to this file

90 lines (71 sloc) 2.58 KB

Clipboard πŸ“Ž

Copy to clipboard

Press keys Cmd(Ctrl) + c while focus or selection is on the grid. The copy operation will copy selected ranges or the currently focused cell. The grid use \t(tab) as the deliminator, copy and paste are easily compatible with Excel.

clipboard_copy

copyOptions

CopyOptions can be specified by grid option or by column. You can modify which values are copied through copyOptions.

import Grid from 'tui-grid';

const grid = new Grid({
  //...options
  copyOptions: {
    useFormattedValue: true,
    useListItemText: true,
    customValue: 'custom'
  }
});

// or

const grid = new Grid({
  //...options
  columns: [
    {
      name: 'type',
      editor: 'text',
      copyOptions: {
        useFormattedValue: true,
        useListItem,
        customValue: (value, rowAttrs, column) => `Column name is ${column.name}`
      }
    }
  ]
})
property type action
customValue string / function Copy string value or changed values through function
useListItemText boolean Copy select or checkbox cell values to text rather than value of listItem
useFormattedValue boolean Copy text with formatter in cell

If multiple copy options are used, It has the following this order.

  1. customValue
  2. useListItemText
  3. useFormattedValue
  4. original data

Example of using customValue

const columns = [
  {
    name: 'release',
    copyOptions: {
      customValue: (value, rowAttrs, column) => `Column name is ${column.name}`
    }
  },
  //...
];
const grid = new Grid({
  el: document.getElementById('wrapper'),
  columns,
  //... options
});

paste_custom

copyToClipboard()

You can use the copyToClipboard() method to copy the selected of focused area. As well as the key event, the copy operation can be also used by calling the API. When you want to copy rather than the key event, you can use the copyToClipboard() method.

const grid = new Grid ({ ... });
grid.copyToClipboard();

Paste from clipboard

Press keys Cmd(Ctrl) + v while focus or selection is on the grid. The value is changed only when using the Cell Editor.

clipboard_paste

Example

You can see the example that clipboard here.

You can’t perform that action at this time.