dataTables.scrollResize

ScrollResize

  • Author: SpryMedia Ltd
  • Requires: DataTables 3+

This feature plug-in for DataTables will automatically change the height of a scrolling DataTable to fit inside its container. This can be particularly useful for control panels and other interfaces which resize dynamically with the user's browser window.

Page resizing in DataTables can be enabled by using any one of the following options:

  • Setting the scrollResize parameter in the DataTables initialisation to be true - i.e. scrollResize: true
  • Setting the scrollResize parameter to be true in the DataTables defaults (thus causing all tables to have this feature) - i.e. DataTable.defaults.scrollResize = true.
  • Creating a new instance: new DataTable.ScrollResize( table ); where table is a DataTable's API instance.

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/features/scrollResize/dist/dataTables.scrollResize.mjs';

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!