DataTables component for Vue

This library provides a Vue component for DataTables.net to be used inside a Vue application.

Please refer to the Vue DataTables documentation for full information on working with this component, including a 60 second quick-start guide.

Installation

To install:

npm install --save datatables.net-dt datatables.net-vue3

This will install DataTables core (with default styling) and the Vue DataTables component. Other DataTables extensions can also be installed in your application - see below.

Usage

In your Vue component you can then import those two modules:

import DataTable, { Column } from 'datatables.net-vue3'
import DtCore from 'datatables.net';

DataTable.use(DtCore);

Note how both the DataTables core and DataTables Vue component must both be imported. This is so the extensions for DataTables can also be imported in this scope and used (see below).

Doing the above will make a <DataTable> component available. It provides the following parameters:

• columns - Define the columns array used for DataTables initialisation
• data - Data array for DataTables. This is optional and if you are using Ajax to load the DataTable data is not required.
• ajax - Ajax option for DataTables - to load data for the table over Ajax.
• class - Class name to assign to the table tag
• options - The DataTables options for the table. Note that this can include columns, data and ajax - if they are provided by one of the properties from above that will override a matching option given here.

Columns

The DataTable component provides the ability to define columns using the <Column> component that it exports. For example for data with the structure:

const data = [
    {
      "id": "1",
      "name": "Tiger Nixon",
      "position": "System Architect",
      "salary": "$320,800",
      "start_date": "2011/04/25",
      "office": "Edinburgh",
      "extn": "5421"
    },
	// ... etc
]

Use:

<DataTable :data="data" class="display">
	<Column title="Name" data="name" />
	<Column title="Position" data="position" />
	<Column title="Salary" data="salary" />
	<Column title="Start date" data="start_date" />
</DataTable>

IMPORTANT You should not use a Vue for in the template to display the HTML for the table body! Doing so will cause a conflict between DataTables and Vue both trying to control the same DOM elements. Allow DataTables to build the HTML for the rows.

Extensions

DataTables provides a wide range of extensions that significantly expands its abilities. Extensions can be imported from npm as modules directly in the script where you wish to make use of them in your DataTable, and then assign the resulting DataTables library to the DataTables Vue3 component - e.g.:

import DataTable from 'datatables.net-vue3'
import DtCore from 'datatables.net';
import 'datatables.net-select';

DataTable.use(DtCore);

Styling

The Vue component for DataTables doesn't include any styling by default. We provide support for a number of different styling libraries, and you will need to install those that you require and for any additional extensions you require.

For example, to use Bootstrap 5 styling, you would install the -bs5 packages for DataTables:

npm install datatables.net-bs5
npm install datatables.net-select-bs5

Your JS import would then be:

import DataTable from 'datatables.net-vue3'
import DtCore from 'datatables.net-bs5';
import 'datatables.net-select-bs5';

DataTable.use(DtCore);

And in your Vue application's CSS (assuming your are using Vite or some other builder which can resolve the style property for npm packages):

@import 'datatables.net-dt';
@import 'datatables.net-select-dt';

Development

Clone this repo and then in your terminal:

npm install
npm run build

This will build a local copy of the Vue DataTables component in dist, which you can then npm link for testing with a local app, or npm run test to run the unit tests.