DataTables logo
≡

Download Button

A button that can be configured to trigger a server-side action.

A button that can be used to trigger a server-side action, typically a download of a file generated by the server. If server-side processing is enabled in the host table it will automatically add the last parameters used for a table draw allowing the script to output a file with the same order / search applied as the main table.

This is particularly useful when using server-side processing and wishing to allow user export of the data in a table. The default Buttons package will only export the data available on the client-side, while this button can be used to let the server generate the required file and then download it to the client-side.

Use

This plug-in can be obtained and used in multiple different ways.

Browser

This plug-in is available on the DataTables CDN:

JS

The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.

Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.

NPM

The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins package. To use this plug-in, first install the plug-ins package:

npm install datatables.net-plugins

Then import datatables.net, any other DataTables extensions you need, plus the plug-in:

import DataTable from 'datatables.net';
import 'datatables.net-plugins/buttons/button.download.mjs';

Example

// Download button
 const table = new DataTable('#example', {
   layout: {
    topStart: {
      buttons: [{
        extend: 'download',
        url: '/api/download'
      }]
    }
  }
 });

Version control

If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!