Always shown checkbox

This example shows a column with checkboxes that are always displayed and will cause a database update when their state is toggled via a click or keyboard action. Although these checkboxes are not actually part of the Editor controlled elements, we can use the Editor API (specifically the edit(), set() and submit() methods) to have Editor perform the action. This can make for very fast editing when working with items that need to be toggled frequently.

A blog post is available that explains in detail how this example is constructed.

First name	Last name	Phone	City	Zip	Active

Javascript
HTML
CSS
Ajax
Server-side script
Comments

The Javascript shown below is used to initialise the table shown in this example:

var editor = new DataTable.Editor({
	ajax: '../php/checkbox.php',
	fields: [
		{
			label: 'Active:',
			name: 'active',
			type: 'checkbox',
			separator: '|',
			options: [{ label: '', value: 1 }]
		},
		{
			label: 'First name:',
			name: 'first_name'
		},
		{
			label: 'Last name:',
			name: 'last_name'
		},
		{
			label: 'Phone:',
			name: 'phone'
		},
		{
			label: 'City:',
			name: 'city'
		},
		{
			label: 'Zip:',
			name: 'zip'
		}
	],
	table: '#example'
});

$('#example').DataTable({
	ajax: '../php/checkbox.php',
	columns: [
		{ data: 'first_name' },
		{ data: 'last_name' },
		{ data: 'phone' },
		{ data: 'city' },
		{ data: 'zip' },
		{
			data: 'active',
			render: function (data, type, row) {
				if (type === 'display') {
					return '<input type="checkbox" class="editor-active">';
				}
				return data;
			},
			className: 'dt-body-center'
		}
	],
	layout: {
		topStart: {
			buttons: [
				{ extend: 'create', editor: editor },
				{ extend: 'edit', editor: editor },
				{ extend: 'remove', editor: editor }
			]
		}
	},
	select: {
		style: 'os',
		selector: 'td:not(:last-child)' // no row selection on last column
	},
	rowCallback: function (row, data) {
		// Set the checked state of the checkbox in the table
		$('input.editor-active', row).prop('checked', data.active == 1);
	}
});

$('#example').on('change', 'input.editor-active', function () {
	editor
		.edit($(this).closest('tr'), false)
		.set('active', $(this).prop('checked') ? 1 : 0)
		.submit();
});

const editor = new DataTable.Editor({
	ajax: '../php/checkbox.php',
	fields: [
		{
			label: 'Active:',
			name: 'active',
			type: 'checkbox',
			separator: '|',
			options: [{ label: '', value: 1 }]
		},
		{
			label: 'First name:',
			name: 'first_name'
		},
		{
			label: 'Last name:',
			name: 'last_name'
		},
		{
			label: 'Phone:',
			name: 'phone'
		},
		{
			label: 'City:',
			name: 'city'
		},
		{
			label: 'Zip:',
			name: 'zip'
		}
	],
	table: '#example'
});

const table = new DataTable('#example', {
	ajax: '../php/checkbox.php',
	columns: [
		{ data: 'first_name' },
		{ data: 'last_name' },
		{ data: 'phone' },
		{ data: 'city' },
		{ data: 'zip' },
		{
			data: 'active',
			render: (data, type, row) =>
				type === 'display'
					? '<input type="checkbox" class="editor-active">'
					: data,
			className: 'dt-body-center'
		}
	],
	layout: {
		topStart: {
			buttons: [
				{ extend: 'create', editor: editor },
				{ extend: 'edit', editor: editor },
				{ extend: 'remove', editor: editor }
			]
		}
	},
	select: {
		style: 'os',
		selector: 'td:not(:last-child)' // no row selection on last column
	},
	rowCallback: function (row, data) {
		// Set the checked state of the checkbox in the table
		row.querySelector('input.editor-active').checked = data.active == 1;
	}
});

table.on('change', 'input.editor-active', function () {
	editor
		.edit(this.closest('tr'), false)
		.set('active', this.checked ? 1 : 0)
		.submit();
});

In addition to the above code, the following Javascript library files are loaded for use in this example:

The HTML shown below is the raw HTML table element, before it has been enhanced by DataTables:

This example uses a little bit of additional CSS beyond what is loaded from the library files (below), in order to correctly display the table. The additional CSS used is shown below:

The following CSS library files are loaded for use in this example to provide the styling of the table:

This table loads data by Ajax. The latest data that has been loaded is shown below. This data will update automatically as any additional data is loaded.

The script used to perform the server-side interaction for this demo is shown below. This server uses PHP, so the PHP script is shown, however our download packages include the equivalent script for other platforms, including .NET and Node.js. Server-side scripts can be written in any language, using the protocol described in the Editor documentation.

Always shown checkbox

Other examples

Simple initialisation

Advanced initialisation

DataTables as an input

Dates and time

DataTables extensions

Inline editing

Bubble editing

API

Standalone

Styling

Plug-ins

DataTables