copyHtml5
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. In most cases this will just be automatically available on the users clipboard, but if your browser doesn't support the required APIs for that 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.
If your table has a header or footer with multiple rows, these will all be included in the export. If the header or footer contains colspan or rowspan cells, they will be filled in by an empty string, since this is a plain text export and has no way to represent cells that span over others.
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, in addition to those options which are available for all buttons (e.g. buttons.buttons.text):
action
- Type:
function - Default: Unset
Display a dialogue box that the user can use to copy table data to clipboard
className
- Type:
string - Default:
buttons-copy buttons-html5
The button's class name. See buttons.buttons.className for details.
copySuccess
- Type:
boolean - Default:
true - Since: 3.1.2
Indicate if the message should be displayed or not when the copy is complete.
customize
- Type:
function - Default:
undefined - Since: 1.1.1
Function that can be used to modify the contents of the exported data. The function takes two parameters, the data as configured by the button and the button's configuration object. The value that the function returns is the value that will be used for the export.
This can be particularly useful if you wish to add a company header or footer, description data or any other information to the exported data.
As of Buttons 1.5.2 this function is passed three parameters:
- The data to be copied as a string
- The button configuration object
- A DataTables API instance for the table the button belongs to.
exportOptions
- Type:
object - Default:
{}
Select the data to be gathered from the DataTable for export. This includes options for which columns, rows, ordering and search. Please see the buttons.exportData() method for full details - the object given by this parameter is passed directly into that action to gather the required data.
fieldBoundary
- Type:
string - Default: ``
The character(s) used to enclose each field in the plain text representation of the table that is copied to the system's clipboard. This is automatically added at the start and end of each cell's data.
fieldSeparator
- Type:
string - Default:
\t
The character(s) used to separate fields in the plain text representation of the table that is copied to the system's clipboard.
footer
- Type:
boolean - Default:
true
Indicate if the table footer should be included in the exported data or not. Please note that the default for this parameter was updated in Buttons 3.0 to be true. In earlier versions it was false.
header
- Type:
boolean - Default:
true
Indicate if the table header should be included in the exported data or not.
messageBottom
Message to be shown at the bottom of the table, or the caption tag if displayed at the bottom of the table.
messageTop
Message to be shown at the top of the table, or the caption tag if displayed at the top of the table.
newline
- Type:
string - Default:
\n
The character(s) used to separate the lines of data. Please note that on Windows clients the default is \r\n. All other platforms have a default or \n only.
text
- Type:
string - Default:
Copy
The button's display text. The text can be configured using this option (see buttons.buttons.text) or the buttons.copy option of the DataTables language object.
title
Title of the table that will be included in the exported data. Please see buttons.exportInfo() for all options relating to this parameter.
Examples
DataTables initialisation: Use the Html copy button:
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['copyHtml5']
}
}
});DataTables initialisation: Use the copy button type to alias the HTML button options.:
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['copy']
}
}
});DataTables initialisation: Use the exportOptions to copy only the current DataTable page:
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'copyHtml5',
text: 'Copy current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});DataTables initialisation: Use the language object to set the information displayed when activated:
new DataTable('#myTable', {
language: {
buttons: {
copyTitle: 'Data copied',
copyKeys: 'Use your keyboard or menu to select the copy command'
}
},
layout: {
topStart: {
buttons: ['copyHtml5']
}
}
});