DataTables logo
≡

Tristate checkbox

Provide a tristate checkbox to allow three values to be represented.

This plugin integrates with the jQuery Tristate plug-in to provide the ability to use a single checkbox input to represent three different states. Another way of doing this would be with radio, but this plugin can be useful due to how compact it is.

Use

This plug-in can be obtained and used in multiple different ways.

Browser

This plug-in is available on the DataTables CDN:

JS

The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.

Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.

NPM

The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins package. To use this plug-in, first install the plug-ins package:

npm install datatables.net-plugins

Then import datatables.net, any other DataTables extensions you need, plus the plug-in:

import DataTable from 'datatables.net';
import 'datatables.net-plugins/editorFields/editor.tristate.mjs';

Example

var editor = new DataTable.Editor({
  table: '#myTable',
  fields: [
    {
      label: 'State:',
      name: 'state',
      type: 'tristate',
      options: {
        checked: '1',
        unchecked: '',
        indeterminate: '-',
      },
    },
  ],
});

Version control

If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!