Editor's built in tags field type is a cross
between autocomplete and select fields. It provides a searchable list that the end
user can select a label from, and then populates the field with a value. Similar to select, tags
lists the display label and the value can be different values. This makes it perfectly suited for working with joins, where the value is typically a foreign key
and the label a human understandable representation of that.
This example is the same as the basic join example but in this case the select is replaced by tags. Note that multiple is set to
false in this case (since only a single option should be selectable for this example) and i18n.addButton is used to customise the button
text when creating a new row.
| First name | Last name | Phone # | Location |
|---|---|---|---|
| First name | Last name | Phone # | Location |
The JavaScript shown below is used to initialise the table shown in this example:
var editor = new DataTable.Editor({
ajax: '../../controllers/join.php',
fields: [
{
label: 'First name:',
name: 'users.first_name'
},
{
label: 'Last name:',
name: 'users.last_name'
},
{
label: 'Phone #:',
name: 'users.phone'
},
{
label: 'Site:',
name: 'users.site',
type: 'tags',
i18n: {
addButton: 'Set site...'
},
multiple: false
}
],
table: '#example'
});
$('#example').DataTable({
ajax: {
url: '../../controllers/join.php',
type: 'POST'
},
columns: [
{ data: 'users.first_name' },
{ data: 'users.last_name' },
{ data: 'users.phone' },
{ data: 'sites.name' }
],
layout: {
topStart: {
buttons: [
{ extend: 'create', editor: editor },
{ extend: 'edit', editor: editor },
{ extend: 'remove', editor: editor }
]
}
},
select: true
});
const editor = new DataTable.Editor({
ajax: '../../controllers/join.php',
fields: [
{
label: 'First name:',
name: 'users.first_name'
},
{
label: 'Last name:',
name: 'users.last_name'
},
{
label: 'Phone #:',
name: 'users.phone'
},
{
label: 'Site:',
name: 'users.site',
type: 'tags',
i18n: {
addButton: 'Set site...'
},
multiple: false
}
],
table: '#example'
});
new DataTable('#example', {
ajax: {
url: '../../controllers/join.php',
type: 'POST'
},
columns: [
{ data: 'users.first_name' },
{ data: 'users.last_name' },
{ data: 'users.phone' },
{ data: 'sites.name' }
],
layout: {
topStart: {
buttons: [
{ extend: 'create', editor: editor },
{ extend: 'edit', editor: editor },
{ extend: 'remove', editor: editor }
]
}
},
select: true
});
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 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.