JavaScript Data GridSaving data

Save data after each change to the data set, using Handsontable's API hooks. Preserve the table's state by saving data to the local storage.

Save changes using a callback
Save data locally
PersistentState vs localStorage
Related API reference

Save changes using a callback

To track changes made in your data grid, use Handsontable's afterChange hook.

The example below handles data by using fetch. Note that this is just a mockup, and nothing is actually saved. You need to implement the server-side part by yourself.

Autosave

Click "Load" to load data from server

{
    "name": "handsontable",
    "version": "1.0.0",
    "description": "",
    "dependencies": {
      "hyperformula": "^2.4.0",
      "handsontable": "14.6"
    }
  }

<!DOCTYPE html>
  <html>
    <head>
      <meta charset="utf-8" />
      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <title>Handsontable</title>
    </head>
  
    <body>
      <div class="example-controls-container">
  <div class="controls">
    <button id="load" class="button button--primary button--blue">Load data</button> 
    <button id="save" class="button button--primary button--blue">Save data</button>
    <label>
      <input type="checkbox" name="autosave" id="autosave"/>
      Autosave
    </label>
  </div>

  <output class="console" id="output">Click "Load" to load data from server</output>
</div>

<div id="example1"></div>
    </body>
  </html>

import './styles.css'
import Handsontable from 'handsontable';
import 'handsontable/dist/handsontable.full.min.css';

const container = document.querySelector('#example1');
const exampleConsole = document.querySelector('#output');
const autosave = document.querySelector('#autosave');
const load = document.querySelector('#load');
const save = document.querySelector('#save');
const hot = new Handsontable(container, {
  startRows: 8,
  startCols: 6,
  rowHeaders: true,
  colHeaders: true,
  height: 'auto',
  licenseKey: 'non-commercial-and-evaluation',
  afterChange(change, source) {
    if (source === 'loadData') {
      return; // don't save this change
    }

    if (!change) {
      return;
    }

    if (!autosave.checked) {
      return;
    }

    fetch('https://handsontable.com/docs/scripts/json/save.json', {
      method: 'POST',
      mode: 'no-cors',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({ data: change }),
    }).then(() => {
      exampleConsole.innerText = `Autosaved (${change.length} cell${
        change.length > 1 ? 's' : ''
      })`;
      console.log('The POST request is only used here for the demo purposes');
    });
  },
  autoWrapRow: true,
  autoWrapCol: true,
});

load.addEventListener('click', () => {
  fetch('https://handsontable.com/docs/scripts/json/load.json').then((response) => {
    response.json().then((data) => {
      hot.loadData(data.data);
      // or, use `updateData()` to replace `data` without resetting states
      exampleConsole.innerText = 'Data loaded';
    });
  });
});
save.addEventListener('click', () => {
  // save all cell's data
  fetch('https://handsontable.com/docs/scripts/json/save.json', {
    method: 'POST',
    mode: 'no-cors',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ data: hot.getData() }),
  }).then(() => {
    exampleConsole.innerText = 'Data saved';
    console.log('The POST request is only used here for the demo purposes');
  });
});
autosave.addEventListener('click', () => {
  if (autosave.checked) {
    exampleConsole.innerText = 'Changes will be autosaved';
  } else {
    exampleConsole.innerText = 'Changes will not be autosaved';
  }
});

import Handsontable from 'handsontable';
import 'handsontable/dist/handsontable.full.min.css';

const container = document.querySelector('#example1');
const exampleConsole = document.querySelector('#output');
const autosave = document.querySelector('#autosave');
const load = document.querySelector('#load');
const save = document.querySelector('#save');
const hot = new Handsontable(container, {
  startRows: 8,
  startCols: 6,
  rowHeaders: true,
  colHeaders: true,
  height: 'auto',
  licenseKey: 'non-commercial-and-evaluation',
  afterChange(change, source) {
    if (source === 'loadData') {
      return; // don't save this change
    }

    if (!change) {
      return;
    }

    if (!autosave.checked) {
      return;
    }

    fetch('https://handsontable.com/docs/scripts/json/save.json', {
      method: 'POST',
      mode: 'no-cors',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({ data: change }),
    }).then(() => {
      exampleConsole.innerText = `Autosaved (${change.length} cell${
        change.length > 1 ? 's' : ''
      })`;
      console.log('The POST request is only used here for the demo purposes');
    });
  },
  autoWrapRow: true,
  autoWrapCol: true,
});

load.addEventListener('click', () => {
  fetch('https://handsontable.com/docs/scripts/json/load.json').then((response) => {
    response.json().then((data) => {
      hot.loadData(data.data);
      // or, use `updateData()` to replace `data` without resetting states
      exampleConsole.innerText = 'Data loaded';
    });
  });
});
save.addEventListener('click', () => {
  // save all cell's data
  fetch('https://handsontable.com/docs/scripts/json/save.json', {
    method: 'POST',
    mode: 'no-cors',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ data: hot.getData() }),
  }).then(() => {
    exampleConsole.innerText = 'Data saved';
    console.log('The POST request is only used here for the demo purposes');
  });
});
autosave.addEventListener('click', () => {
  if (autosave.checked) {
    exampleConsole.innerText = 'Changes will be autosaved';
  } else {
    exampleConsole.innerText = 'Changes will not be autosaved';
  }
});

<script src="https://cdn.jsdelivr.net/npm/handsontable@14.6/dist/handsontable.full.min.js"></script>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@14.6/dist/handsontable.full.min.css" /> 
<script src="https://handsontable.com/docs/scripts/fixer.js"></script>

<div class="example-controls-container">
  <div class="controls">
    <button id="load" class="button button--primary button--blue">Load data</button> 
    <button id="save" class="button button--primary button--blue">Save data</button>
    <label>
      <input type="checkbox" name="autosave" id="autosave"/>
      Autosave
    </label>
  </div>

  <output class="console" id="output">Click "Load" to load data from server</output>
</div>

<div id="example1"></div>

import Handsontable from 'handsontable';
import 'handsontable/dist/handsontable.full.min.css';

const container = document.querySelector('#example1');
const exampleConsole = document.querySelector('#output');
const autosave = document.querySelector('#autosave');
const load = document.querySelector('#load');
const save = document.querySelector('#save');
const hot = new Handsontable(container, {
  startRows: 8,
  startCols: 6,
  rowHeaders: true,
  colHeaders: true,
  height: 'auto',
  licenseKey: 'non-commercial-and-evaluation',
  afterChange(change, source) {
    if (source === 'loadData') {
      return; // don't save this change
    }

    if (!change) {
      return;
    }

    if (!autosave.checked) {
      return;
    }

    fetch('https://handsontable.com/docs/scripts/json/save.json', {
      method: 'POST',
      mode: 'no-cors',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({ data: change }),
    }).then(() => {
      exampleConsole.innerText = `Autosaved (${change.length} cell${
        change.length > 1 ? 's' : ''
      })`;
      console.log('The POST request is only used here for the demo purposes');
    });
  },
  autoWrapRow: true,
  autoWrapCol: true,
});

load.addEventListener('click', () => {
  fetch('https://handsontable.com/docs/scripts/json/load.json').then((response) => {
    response.json().then((data) => {
      hot.loadData(data.data);
      // or, use `updateData()` to replace `data` without resetting states
      exampleConsole.innerText = 'Data loaded';
    });
  });
});
save.addEventListener('click', () => {
  // save all cell's data
  fetch('https://handsontable.com/docs/scripts/json/save.json', {
    method: 'POST',
    mode: 'no-cors',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ data: hot.getData() }),
  }).then(() => {
    exampleConsole.innerText = 'Data saved';
    console.log('The POST request is only used here for the demo purposes');
  });
});
autosave.addEventListener('click', () => {
  if (autosave.checked) {
    exampleConsole.innerText = 'Changes will be autosaved';
  } else {
    exampleConsole.innerText = 'Changes will not be autosaved';
  }
});

You can save any type of data in local storage to preserve the table state after page reloads. The persistentState option must be set to true to enable the data storage mechanism. You can set it either during the Handsontable initialization or using the updateSettings() method.

Persistent state storage is particularly useful when running multiple instances of Handsontable on one page as it allows data separation per each instance.

When the persistentState option is enabled, the PersistentState plugin exposes hooks listed below:

`PersistentState` vs `localStorage`

The main benefit of using the PersistentState plugin hooks rather than the regular localStorage API is that it ensures separation of data stored by multiple Handsontable instances. For example, if you have two or more instances of Handsontable on one page, data saved by one instance will be inaccessible to the second instance. Those two instances can store data under the same key, and no data would be overwritten.

For the data separation to work properly, make sure that each instance of Handsontable has a unique id.

Configuration options:
- persistentState
Core methods:
- updateSettings()
Hooks:
Plugins:
- PersistentState

JavaScript Data GridSaving data

Save changes using a callback

Save data locally

PersistentState vs localStorage

Related API reference

`PersistentState` vs `localStorage`