ClipboardSettings

Configures clipboard copy, paste, and cut functionality for the grid. Controls whether users can copy, paste, and cut cell/row data to and from the clipboard.

Props

The following table outlines the props for the ClipboardSettings:

NameTypeDefaultDescription
allowCut
boolean
true

Enables or disables cut operations in the grid. When true, users can cut selected cells/rows using Ctrl+X. When false, cut operations are blocked while copy and paste remain functional if enabled. Requires enabled to be true and editSettings.allowDelete to be enabled for cut to work

allowPaste
boolean
true

Enables or disables paste operations in the grid. When true, users can paste clipboard data using Ctrl+V. When false, paste operations are blocked while copy and cut remain functional if enabled. Requires enabled to be true and editSettings.allowEdit to be enabled for paste to work.

allowRowCopy
boolean
false

When true, row selection takes precedence over focused cell. Copy/Cut/Paste operate on selected rows.

copyWithHeaders
boolean
false

Includes column headers in clipboard copy output by default. When true, plain copy operations include headers, while the existing shortcut for copy with headers still works as before.

enabled
boolean
true

Enables or disables all clipboard operations (copy, paste, cut) in the grid. When enabled, users can copy, paste, and cut selected cells/rows. When disabled, all clipboard operations are completely blocked. Individual operations can be controlled via allowCut and allowPaste properties.