DataTables
Advanced interaction
features for your tables.
Editor
Comprehensive editing
library for DataTables.
Manual
Download
Show site navigation

Custom display controller

Editor has two display controllers built in for use with the display option (lightbox and envelope). However, you might wish to customise how Editor displays your form - this can be done through the use of a display controller plug-in.

Display controllers basically place the form on screen somewhere - they are not interested in the contents of the form, they are simply given an element that needs to be shown, and how exactly they display that element is entirely up to them! This provides a huge amount of flexibility in Editor, allowing your interface to be customised to exactly what you want.

This example shows how a display controller can be built using DataTables child row abilities (row().child().show()). When the control icon is clicked upon, we make a call to edit() to start the edit. The display controller then creates the child row using the DataTables API and inserts the form control. Note that it uses the built in lightbox control for creating new rows, since attaching the new row form to an existing row doesn't make any sense! As a result of this the styling for this example is locked to the DataTables default, since the other frameworks don't have the styles for the default lightbox. It can be modified to support each individual framework though.

For more detailed information on how to create plug-ins for Editor, please refer to the Editor documentation.

Name Position Office Salary
Name Position Office Salary
  • Javascript
  • HTML
  • CSS
  • Ajax
  • Server-side script
  • Comments (0)

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

Javascript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
//
// Plug-in code
//
(function () {
    var Editor = DataTable.Editor;
    Editor.display.details = $.extend(true, {}, Editor.models.displayController, {
        init: function (editor) {
            // Setup the lightbox - we'll use it for new entries
            Editor.display.lightbox.init(editor);
 
            // No other setup needed
            return Editor.display.details;
        },
 
        open: function (editor, append, callback) {
            var table = $(editor.s.table).DataTable();
            var row = editor.s.modifier;
 
            // Close any rows which are already open
            Editor.display.details.close(editor);
 
            if (editor.mode() === 'create') {
                // Its a new row. Use Editor's lightbox
                Editor.display.lightbox.open(editor, append, callback);
            }
            else {
                // Open the child row on the DataTable
                table
                    .row(row)
                    .child(append)
                    .show();
 
                $(table.row(row).node()).addClass('shown');
 
                if (callback) {
                    callback();
                }
            }
        },
 
        close: function (editor, callback) {
            Editor.display.lightbox.close(editor, callback);
 
            var table = $(editor.s.table).DataTable();
 
            table.rows().every(function () {
                if (this.child.isShown()) {
                    this.child.hide();
                    $(this.node()).removeClass('shown');
                }
            });
 
            if (callback) {
                callback();
            }
        }
    });
})();
 
//
// Initialisation code
//
var editor = new DataTable.Editor({
    ajax: '../php/staff.php',
    display: 'details',
    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'
        }
    ],
    table: '#example'
});
 
var table = $('#example').DataTable({
    ajax: '../php/staff.php',
    columns: [
        {
            className: 'dt-control',
            orderable: false,
            data: null,
            defaultContent: ''
        },
        {
            data: null,
            render: function (data, type, row) {
                // Combine the first and last names into a single table field
                return data.first_name + ' ' + data.last_name;
            }
        },
        { data: 'position' },
        { data: 'office' },
        { data: 'salary', render: DataTable.render.number(null, null, 0, '$') }
    ],
    layout: {
        topStart: {
            buttons: [{ extend: 'create', editor: editor }]
        }
    },
    order: [[1, 'asc']],
    rowCallback: function (row, data, index) {
        $('td:first-child', row).attr('title', 'Click to edit');
    },
    select: true
});
 
$('#example').on('click', 'td.dt-control', function () {
    var tr = this.parentNode;
 
    if (table.row(tr).child.isShown()) {
        editor.close();
    }
    else {
        editor.edit(tr, 'Edit row', [
            {
                className: 'delete',
                label: 'Delete row',
                fn: function () {
                    // Close the edit display and delete the row immediately
                    editor.close();
                    editor.remove(tr, '', null, false);
                    editor.submit();
                }
            },
            {
                label: 'Update row',
                fn: function () {
                    editor.submit();
                }
            }
        ]);
    }
});
Javascript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
//
// Plug-in code
//
(function () {
    const Editor = DataTable.Editor;
    Editor.display.details = Object.assign({}, Editor.models.displayController, {
        init: function (editor) {
            // Setup the lightbox - we'll use it for new entries
            Editor.display.lightbox.init(editor);
 
            // No other setup needed
            return Editor.display.details;
        },
 
        open: function (editor, append, callback) {
            let table = new DataTable.Api(editor.s.table);
            let row = editor.s.modifier;
 
            // Close any rows which are already open
            Editor.display.details.close(editor);
 
            if (editor.mode() === 'create') {
                // Its a new row. Use Editor's lightbox
                Editor.display.lightbox.open(editor, append, callback);
            }
            else {
                // Open the child row on the DataTable
                table
                    .row(row)
                    .child(append)
                    .show();
                table
                    .row(row)
                    .node()
                    .classList.add('shown');
 
                if (callback) {
                    callback();
                }
            }
        },
 
        close: function (editor, callback) {
            Editor.display.lightbox.close(editor, callback);
 
            let table = new DataTable.Api(editor.s.table);
 
            table.rows().every(function () {
                if (this.child.isShown()) {
                    this.child.hide();
                    this.node().classList.remove('shown');
                }
            });
 
            if (callback) {
                callback();
            }
        }
    });
})();
 
//
// Initialisation code
//
const editor = new DataTable.Editor({
    ajax: '../php/staff.php',
    display: 'details',
    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'
        }
    ],
    table: '#example'
});
 
const table = $('#example').DataTable({
    ajax: '../php/staff.php',
    columns: [
        {
            className: 'dt-control',
            orderable: false,
            data: null,
            defaultContent: ''
        },
        {
            data: null,
            render: (data) => data.first_name + ' ' + data.last_name
        },
        { data: 'position' },
        { data: 'office' },
        { data: 'salary', render: DataTable.render.number(null, null, 0, '$') }
    ],
    layout: {
        topStart: {
            buttons: [{ extend: 'create', editor: editor }]
        }
    },
    order: [[1, 'asc']],
    rowCallback: function (row, data, index) {
        row.querySelector('td:first-child').setAttribute('title', 'Click to edit');
    },
    select: true
});
 
table.on('click', 'td.dt-control', function () {
    var tr = this.parentNode;
 
    if (table.row(tr).child.isShown()) {
        editor.close();
    }
    else {
        editor.edit(tr, 'Edit row', [
            {
                className: 'delete',
                label: 'Delete row',
                fn: () => {
                    // Close the edit display and delete the row immediately
                    editor.close();
                    editor.remove(tr, '', null, false);
                    editor.submit();
                }
            },
            {
                label: 'Update row',
                fn: () => {
                    editor.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:

    CSS
    1
     

    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.

      No comments posted for this page yet. Be the first to contribute!

      Post new comment

      Contributions in the form of tips, code snippets and suggestions for the above material are very welcome. To post a comment, please use the form below. Text is formatted by Markdown.

      To post comments, please sign in to your DataTables account, or register:

      Any questions posted here will be deleted without being published.
      Please post questions in the Forums. Comments are moderated.

      Other examples

      Simple initialisation

      Advanced initialisation

      Triggering editing

      DataTables as an input

      Dates and time

      Dropdown input types

      DataTables extensions

      Inline editing

      Bubble editing

      API

      Standalone

      Styling

      Plug-ins

      DataTables


      DataTables and Editor designed and created by SpryMedia Ltd © 2007-2025. Privacy policy.
      SpryMedia Ltd is registered in Scotland, company no. SC456502.