remove

Since: Editor 1.5.0

A button that will delete one or more rows using Editor.
Please note - this property requires the Editor extension for DataTables.

Description

The remove button type is provided by Editor to give the ability to easily remove one or more selected rows in a DataTable through a pre-defined button that will call the remove() method to trigger data deletion.

It uses the Select extension for DataTables to determine what data is selected in the DataTable, and provide that information to the remove() method to delete that data.

All of the options available for the remove() method's form options are available through the button options (namely formButtons, formMessage and formTitle).

This button requires that the editor option must be set, which tells the button which Editor instance to operate on when activated. In this way multiple Editor instances could be attached to a single DataTable if required.

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):

Name	Type	Default
`editor`
The Editor instance that this button should operate on when activated.
`formButtons`
The form control buttons to show in the Editor form when activated by the `remove` button (i.e. submit, cancel, etc). The value given here is passed directly to the `buttons()` method - please refer to the documentation for that method and also the `button-options` data type.
`formMessage`
The message to show in the remove form. This can either be a simple string or a function that will compute a string to show when the button is activated. The value given here is passed directly to the `message()` method. Please refer to the documentation for that method for full details of the options available.
`formOptions`
Form options to configure the behaviour of the form - see `form-options` for full details. The options specified here will take precedence over any configured by `formOptions.main`.
`formTitle`
The title to give the remove form. This can either be a simple string or a function that will compute a string to show when the button is activated. The value given here is passed directly to the `title()` method. Please refer to the documentation for that method for full details of the options available.

Examples

A single, simple remove button for the Editor instance myEditor:

new DataTable('#myTable', {
	buttons: [
		{
			extend: 'remove',
			editor: myEditor
		}
	]
});

Create, edit and remove buttons, all with default options:

new DataTable('#myTable', {
	buttons: [
		{ extend: 'create', editor: myEditor },
		{ extend: 'edit', editor: myEditor },
		{ extend: 'remove', editor: myEditor }
	]
});

A remove button with a cancel button:

new DataTable('#myTable', {
	buttons: [
		{
			extend: 'remove',
			editor: myEditor,
			formButtons: [
				{
					label: 'Cancel',
					fn: function () {
						this.close();
					}
				},
				'Delete data'
			]
		}
	]
});

Delete button with a custom message based on the selected data:

new DataTable('#myTable', {
	buttons: [
		{
			extend: 'edit',
			editor: myEditor,
			formMessage: function (editor, dt) {
				var rows = dt
					.rows({ selected: true })
					.data()
					.map(function (rowData) {
						return rowData.first_name;
					});

				return (
					'Are you sure you want to delete the data for users ' +
					rows.join(', ') +
					'?'
				);
			}
		}
	]
});