copyHtml5

Since: Buttons 1.0.0

Copy table data to clipboard button (HTML). Please note - this property requires the Buttons extension for DataTables.

Description

This button provides a simple copy-to-clipboard action to the end user, copied the table's data to the system clipboard.

As of Buttons 1.1.0, in browsers that support the required functionality the table's content will be immediately copied to the system clipboard when the button is clicked up. Browsers that provide this ability are:

  • Chrome 42+
  • Firefox 41+
  • IE9+
  • Opera 29+

In older browsers (and Safari), or with older versions of Buttons, a message is shown to the end user inviting them to use their keyboard or the Edit menu to copy the table's data. The copy is done from an almost completely hidden textarea element so the end user won't see it, but the browser is still above to give the textarea focus and select the text.

When the user activates the copy command the dialogue box is dismissed. They can also click on the box or press escape to dismiss it without performing the copy action.

There are a number of language strings that can be set to configure the messages shown to the end user - these are set in the buttons property of the language configuration option of the DataTable (see below for examples) - these are, including the default values:

{
    copy: 'Copy',
    copySuccess: {
        1: "Copied one row to clipboard",
        _: "Copied %d rows to clipboard"
    },
    copyTitle: 'Copy to clipboard',
    copyKeys: 'Press <i>ctrl</i> or <i>\u2318</i> + <i>C</i> to copy the table data<br>to your system clipboard.<br><br>To cancel, click this message or press escape.'
}

Please note that the html5 part of this button type's name is for consistency with the other HTML5 export buttons, but unlike its companion buttons it doesn't actually require HTML5 APIs. It will work for all DataTables supported browsers.

Options

This button can have the following options set in its configuration object to customise its actions and display:

Examples

DataTables initialisation: Use the Flash copy button:

$('#myTable').DataTable( {
	buttons: [
		'copyHtml5'
	]
} );

DataTables initialisation: Use the copy button type to automatically select between the Flash and HTML button options.:

$('#myTable').DataTable( {
	buttons: [
		'copy'
	]
} );

DataTables initialisation: Use the exportOptions to copy only the current DataTable page:

$('#myTable').DataTable( {
	buttons: [
		{
			extend: 'copyHtml5',
			text: 'Copy current page',
			exportOptions: {
				modifier: {
					page: 'current'
				}
			}
		}
	]
} );

DataTables initialisation: Use the language object to set the information displayed when activated:

$('#myTable').DataTable( {
	language: 
		buttons: {
			copyTitle: 'Data copied',
			copyKeys: 'Use your keyboard or menu to select the copy command'
		}
	},
	buttons: [
		'copyHtml5'
	]
} );