jQuery DataTables: How to add a checkbox column

Example

Client-side processing mode with Ajax sourced data

Example below shows a data table in client-side processing mode where data is received from the server using Ajax.

Name Position Office Extn. Start date Salary
Name Position Office Extn. Start date Salary

Data submitted to the server:


$(document).ready(function (){
   var table = $('#example').DataTable({
      'ajax': {
         'url': '/lab/articles/jquery-datatables-how-to-add-a-checkbox-column/ids-arrays.txt' 
      },
      'columnDefs': [{
         'targets': 0,
         'searchable': false,
         'orderable': false,
         'className': 'dt-body-center',
         'render': function (data, type, full, meta){
             return '<input type="checkbox" name="id[]" value="' + $('<div/>').text(data).html() + '">';
         }
      }],
      'order': [[1, 'asc']]
   });

   // Handle click on "Select all" control
   $('#example-select-all').on('click', function(){
      // Get all rows with search applied
      var rows = table.rows({ 'search': 'applied' }).nodes();
      // Check/uncheck checkboxes for all rows in the table
      $('input[type="checkbox"]', rows).prop('checked', this.checked);
   });

   // Handle click on checkbox to set state of "Select all" control
   $('#example tbody').on('change', 'input[type="checkbox"]', function(){
      // If checkbox is not checked
      if(!this.checked){
         var el = $('#example-select-all').get(0);
         // If "Select all" control is checked and has 'indeterminate' property
         if(el && el.checked && ('indeterminate' in el)){
            // Set visual state of "Select all" control 
            // as 'indeterminate'
            el.indeterminate = true;
         }
      }
   });

   // Handle form submission event
   $('#frm-example').on('submit', function(e){
      var form = this;

      // Iterate over all checkboxes in the table
      table.$('input[type="checkbox"]').each(function(){
         // If checkbox doesn't exist in DOM
         if(!$.contains(document, this)){
            // If checkbox is checked
            if(this.checked){
               // Create a hidden element 
               $(form).append(
                  $('<input>')
                     .attr('type', 'hidden')
                     .attr('name', this.name)
                     .val(this.value)
               );
            }
         } 
      });
   });

});

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

//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js
//cdn.datatables.net/1.10.7/js/jquery.dataTables.min.js

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

//cdn.datatables.net/1.10.7/css/jquery.dataTables.min.css

Edit on jsFiddle

Highlights

Javascript

  • Columns definition

          'columnDefs': [{
             'targets': 0,
             'searchable':false,
             'orderable':false,
             'className': 'dt-body-center',
             'render': function (data, type, full, meta){
                 return '<input type="checkbox" name="id[]" value="' + $('<div/>').text(data).html() + '">';
             }
          }],
    

    Option columnsDef is used to define appearance and behavior of the first column ('targets': 0).

    Searching and ordering of the column is not needed so this functionality is disabled with searchable and orderable options.

    To center checkbox in the cell, internal DataTables CSS class dt-body-center is used.

    Option render is used to prepare the checkbox control for being displayed in each cell of the first column. We use a trick with $('<div/>').text(data).html() to encode HTML entities that could be present in the data.

    Another trick here is to give input element a name with square brackets (id[]), this will make handling of list of checked checkboxes easier on the server-side. For example, PHP will convert all these parameters to an array, see PHP FAQ: How do I get all the results from a select multiple HTML tag for more information.

  • Initial sorting order

          'order': [[1, 'asc']],
    

    By default, DataTables sorts table by first column in ascending order. By using order option we select another column to perform initial sort.

  • “Select/deselect all” control

       // Handle click on "Select all" control
       $('#example-select-all').on('click', function(){
          // Get all rows with search applied
          var rows = table.rows({ 'search': 'applied' }).nodes();
          // Check/uncheck checkboxes for all rows in the table
          $('input[type="checkbox"]', rows).prop('checked', this.checked);
       });
    

    We attach event handler to handle clicks on “Select all” control. To retrieve all checkboxes that are present in the table taking into account currently applied filter, we use rows() method using appropriate selector-modifier.

       // Handle click on checkbox to set state of "Select all" control
       $('#example tbody').on('change', 'input[type="checkbox"]', function(){
          // If checkbox is not checked
          if(!this.checked){
             var el = $('#example-select-all').get(0);
             // If "Select all" control is checked and has 'indeterminate' property
             if(el && el.checked && ('indeterminate' in el)){
                // Set visual state of "Select all" control 
                // as 'indeterminate'
                el.indeterminate = true;
             }
          }
       });
    

    The purpose of the event handler above is to detect when one of the checkboxes in the table is unchecked when “Select all” control was checked. When that happens, we can set “Select all” control to a special state indeterminate to indicate that not all checkboxes are checked.

  • Form submission

       // Handle form submission event
       $('#frm-example').on('submit', function(e){
          var form = this;
    
          // Iterate over all checkboxes in the table
          table.$('input[type="checkbox"]').each(function(){
             // If checkbox doesn't exist in DOM
             if(!$.contains(document, this)){
                // If checkbox is checked
                if(this.checked){
                   // Create a hidden element 
                   $(form).append(
                      $('<input>')
                         .attr('type', 'hidden')
                         .attr('name', this.name)
                         .val(this.value)
                   );
                }
             } 
          });
       });
    

    When table is enhanced by jQuery DataTables plug-in, only visible elements exist in DOM. That is why by default form submits checkboxes from current page only.

    To submit checkboxes from all pages we need to retrieve them with $() API method. Then for each checkbox not present in DOM we add a hidden element to the form with the same name and value. This allows all the data to be submitted.

    It’s even more simple if form submission is performed via Ajax. In that case URL-encoded data for submission can be produced using the code below:

    var data = table.$('input[type="checkbox"]').serialize();

Server-side processing

Please note that the example and code above will work for client-side processing mode only.

In server-side processing mode ('serverSide':true) elements <input type="checkbox"> would exist for current page only. Once page is changed, the checked state of the checkboxes would not be preserved.

See jQuery DataTables – Row selection using checkboxes and Select extension for a universal solution that will work for server-side processing mode as well.

Related posts

Comments

  1. If I need to add a column as the last column and need to point to a movie file source,
    how can I do that? Help will be appreciated.

  2. Brilliant. Easily modified for an mvc ajax post:

    var keys = [];
    table.$('input[type="checkbox"]').each(function(){
       if (this.checked){
          keys.push(this.value);
       }
    });
    
    if (keys.length > 0){
       var url = '@Url.Action("SomeMethod", "SomeController")';
       $.post(url, { keys: keys.join() }, function(result) {
          //...notify user or something
       }, 'text json');
    }
    

    Create a CSV model binder and then you’re working with a List:

    [HttpPost]
    public JsonResult SomeMethod([ModelBinder(typeof(CommaSeparatedModelBinder))] List keys)
    {
       // ...
    }
    
  3. This is really helpful.
    If we do select all first, then search, then submit, the code will submit all the items in table.
    We may need to use search applied nodes in the table for the submit too, not sure whether the check checkbox in DOM in submit method doing the same thing?

  4. How do you get the check boxes to checked state on going from page to page, is this built in to datables or is some thing you added?

  5. That’s really helpful thanks a lot. But if we want to fill the table with a request result, how can we do that?

  6. I need to retain the checked values of 1st page wen I come back from 2nd page. Please help me out.
    Since it is calling the back end again its not able to retain. How to overcome it?

  7. How to skip submitting the checkbox select all value e.g the example_length=50 in this case if the “Show 50 entries” is selected?

  8. How to get sorting on checkbox column for some selected checkbox.
    Ascending should get all selected and descending should get all deselected

  9. i AM CONFUSE , where should i write code for Select all check box,
    I have multiple table and i want to create one function , which can be called from any table .
    Should i create directive or should i create service for that.
    I already have table Directive for all table .

  10. great ! 🙂 I need the first and last cols fixed and I added after columnDefs:

    fixedColumns: {
       leftColumns: 1,
       rightColumns: 1
    }
    

    but then the checkbox select all doesn’t work, do you have suggestion?

Leave a Reply

Your email address will not be published.

(Optional)