Installation

The easiest way to install any extension for for DataTables, including StateRestore, is with the download builder. With the download builder, you select the styling and aspects of DataTables suite that you want, and it will generate the packages / install commands for you to use.

The download builder includes options for direct loading with script and link tags, details for using a package manager such as npm and NuGet, or a download option if you wish to have the files locally.

The download builder is strongly recommended for getting started with StateRestore, and all other DataTables software, particularly so you make sure that the correct styling integration files are available on your page.

However, if you prefer to create the installation yourself, below is an overview of installation via the CDN and npm for the DataTables default styling of StateRestore.

CDN

Assuming that you already have DataTables installed simply add the CSS and JS for StateRestore by inserting the following two tags to your HTML, after the core DataTables file has been included.

<link href="https://cdn.datatables.net/staterestore/2.0.0/css/stateRestore.dataTables.min.css" rel="stylesheet">
 
<script src="https://cdn.datatables.net/staterestore/2.0.0/js/dataTables.stateRestore.min.js"></script>

Once done you will be able to define the staterestore option in the DataTable options to configure StateRestore. Please see the configuration documentation for details.

NPM

To install StateRestore via npm use:

npm install datatables.net-staterestore-dt

Note that the -dt at the end of the package name denotes that it is for DataTables default styling. For other styling integrations, this postfix must be changed. Use the download builder to get the required packages.

To use StateRestore in your own software include the following just after you import the core DataTables library - e.g.:

import DataTable from 'datatables.net-dt';
import 'datatables.net-staterestore-dt';

Note that StateRestore doesn't import to a specific constant - rather the software is automatically attached to the constant imported from DataTables core and made available from there.

You will now be able to define the staterestore option in the DataTable options to configure StateRestore. Please see the configuration documentation for details.

License

StateRestore is part of the DataTables Plus software suite - a set of premium extensions for DataTables. A free trial can be started in the download builder, and a license purchased here.