Edit icon

The other inline editing examples present an interface whereby you click on the cell that you want to edit and row selection options are presented in the first column for the primary editing mode of Editor.

As this example shows, any element can be used to activate the inline edit. In this particular case, a pencil icon is added to each cell, which can be clicked upon. Clicking anywhere else in the row will select it, but clicking the icon will simply activate the inline editing mode for that cell.

This could be useful if only certain columns are to be available, thus highlighting and making clear to the users which columns are editable, or if other action controls are also to be presented for each cell.

First name Last name Position Office Start date Salary
  • Javascript
  • HTML
  • CSS
  • Ajax
  • Server-side script
  • Comments

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

var editor; // use a global for the submit and return data rendering in the examples $(document).ready(function() { editor = new $.fn.dataTable.Editor( { ajax: "../php/staff.php", table: "#example", fields: [ { label: "First name:", name: "first_name" }, { label: "Last name:", name: "last_name" }, { label: "Position:", name: "position" }, { label: "Office:", name: "office" }, { label: "Extension:", name: "extn" }, { label: "Start date:", name: "start_date", type: "datetime" }, { label: "Salary:", name: "salary" } ] } ); editor .on( 'onOpen', function () { // Listen for a tab key event $(document).on( 'keydown.editor', function ( e ) { if ( e.keyCode === 9 ) { e.preventDefault(); // Find the cell that is currently being edited var cell = $('div.DTE').parent(); if ( e.shiftKey && cell.prev().length && cell.prev().index() !== 0 ) { // One cell to the left (skipping the first column) cell.prev().click(); } else if ( e.shiftKey ) { // Up to the previous row cell.parent().prev().children().last(0).click(); } else if ( cell.next().length ) { // One cell to the right cell.next().click(); } else { // Down to the next row cell.parent().next().children().eq(1).click(); } } } ); } ) .on( 'onClose', function () { $(document).off( 'keydown.editor' ); } ); var editIcon = function ( data, type, row ) { if ( type === 'display' ) { return data + ' <i class="fa fa-pencil"/>'; } return data; }; $('#example tbody').on( 'click', 'td i', function (e) { e.stopImmediatePropagation(); // stop the row selection when clicking on an icon editor.inline( $(this).parent() ); } ); $('#example').DataTable( { dom: "Bfrtip", ajax: "../php/staff.php", columns: [ { data: "first_name", render: editIcon }, { data: "last_name", render: editIcon }, { data: "position", render: editIcon }, { data: "office", render: editIcon }, { data: "start_date", render: editIcon }, { data: "salary", render: function ( data, type, row ) { if ( type === 'display' ) { var numberRenderer = $.fn.dataTable.render.number( ',', '.', 0, '$' ).display; return numberRenderer( data )+ ' <i class="fa fa-pencil"/>'; } return data; } } ], select: true, buttons: [ { extend: "create", editor: editor }, { extend: "edit", editor: editor }, { extend: "remove", editor: editor } ] } ); } );

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:

table.dataTable td > i { margin-left: 0.5em; opacity: 0.3; }

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 processing for this table is shown below. Please note that this is just an example script using PHP. Server-side processing scripts can be written in any language, using the protocol described in the DataTables documentation.

Other examples