Vue 3 Data Grid Vuex in Vue 3

Use the Vuex state management pattern to maintain the data and configuration options of your Vue 3 data grid.

In this article

• Example - Vuex store dump

Example - Vuex store dump

The following example implements the @handsontable/vue3 component with a readOnly toggle switch and the Vuex state manager.

Find out which Vue 3 versions are supported

import { createStore } from 'vuex'; import { defineComponent } from 'vue'; import { HotTable } from '@handsontable/vue3'; import { registerAllModules } from 'handsontable/registry'; import 'handsontable/dist/handsontable.full.css'; // register Handsontable's modules registerAllModules(); const store = createStore({ state() { return { hotData: null, hotSettings: { readOnly: false } }; }, mutations: { updateData(state, hotData) { state.hotData = hotData; }, updateSettings(state, updateObj) { state.hotSettings[updateObj.prop] = updateObj.value; } } }); const ExampleComponent = defineComponent({ data() { return { hotSettings: { data: [ ['A1', 'B1', 'C1', 'D1'], ['A2', 'B2', 'C2', 'D2'], ['A3', 'B3', 'C3', 'D3'], ['A4', 'B4', 'C4', 'D4'], ], colHeaders: true, rowHeaders: true, readOnly: true, height: 'auto', afterChange: () => { if (this.hotRef) { store.commit('updateData', this.hotRef.getSourceData()); } }, licenseKey: 'non-commercial-and-evaluation' }, hotRef: null } }, mounted() { this.hotRef = this.$refs.wrapper.hotInstance; store.subscribe(() => this.updateVuexPreview()); store.commit('updateData', this.hotRef.getSourceData()); }, methods: { toggleReadOnly(event) { this.hotSettings.readOnly = event.target.checked; store.commit('updateSettings', {prop: 'readOnly', value: this.hotSettings.readOnly}); }, updateVuexPreview() { // This method serves only as a renderer for the Vuex's state dump. const previewTable = document.querySelector('#vuex-preview table'); let newInnerHtml = '<tbody>'; for (const [key, value] of Object.entries(store.state)) { newInnerHtml += `<tr><td class="table-container">`; if (key === 'hotData' && Array.isArray(value)) { newInnerHtml += `<strong>hotData:</strong> <br><table><tbody>`; for (let row of value) { newInnerHtml += `<tr>`; for (let cell of row) { newInnerHtml += `<td>${cell}</td>`; } newInnerHtml += `</tr>`; } newInnerHtml += `</tbody></table>`; } else if (key === 'hotSettings') { newInnerHtml += `<strong>hotSettings:</strong> <ul>`; for (let settingsKey of Object.keys(value)) { newInnerHtml += `<li>${settingsKey}: ${store.state.hotSettings[settingsKey]}</li>`; } newInnerHtml += `</ul>`; } newInnerHtml += `</td></tr>`; } newInnerHtml += `</tbody>`; previewTable.innerHTML = newInnerHtml; } }, components: { HotTable, } }); export default ExampleComponent; import { createApp } from 'vue'; const app = createApp(ExampleComponent); app.mount('#example1'); <script src="https://cdn.jsdelivr.net/npm/handsontable@12.2/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.2/dist/handsontable.full.min.css" /> <script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script> <script src="https://cdn.jsdelivr.net/npm/vuex@4/dist/vuex.global.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@handsontable/vue3@12.2/dist/vue-handsontable.min.js"></script> <script src="https://handsontable.com/docs/12.2/scripts/fixer.js"></script> <div id="example1" class="dump-example-container"> <div id="example-preview"> <div id="toggle-boxes"> <br/> <input v-on:click="toggleReadOnly" checked id="readOnlyCheck" type="checkbox"/> <label for="readOnlyCheck"> Toggle <code>readOnly</code> for the entire table</label> </div> <br/> <hot-table ref="wrapper" :settings="hotSettings"></hot-table> </div> <div id="vuex-preview"> <h4>Vuex store dump:</h4> <table></table> </div> </div>

import { createStore } from 'vuex';
import { defineComponent } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.css';

// register Handsontable's modules
registerAllModules();

const store = createStore({
  state() {
    return {
      hotData: null,
      hotSettings: {
        readOnly: false
      }
    };
  },
  mutations: {
    updateData(state, hotData) {
      state.hotData = hotData;
    },
    updateSettings(state, updateObj) {
      state.hotSettings[updateObj.prop] = updateObj.value;
    }
  }
});

const ExampleComponent = defineComponent({
  data() {
    return {
      hotSettings: {
        data: [
          ['A1', 'B1', 'C1', 'D1'],
          ['A2', 'B2', 'C2', 'D2'],
          ['A3', 'B3', 'C3', 'D3'],
          ['A4', 'B4', 'C4', 'D4'],
        ],
        colHeaders: true,
        rowHeaders: true,
        readOnly: true,
        height: 'auto',
        afterChange: () => {
          if (this.hotRef) {
            store.commit('updateData', this.hotRef.getSourceData());
          }
        },
        licenseKey: 'non-commercial-and-evaluation'
      },
      hotRef: null
    }
  },
  mounted() {
    this.hotRef = this.$refs.wrapper.hotInstance;
    store.subscribe(() => this.updateVuexPreview());
    store.commit('updateData', this.hotRef.getSourceData());
  },
  methods: {
    toggleReadOnly(event) {
      this.hotSettings.readOnly = event.target.checked;
      store.commit('updateSettings', {prop: 'readOnly', value: this.hotSettings.readOnly});
    },
    updateVuexPreview() {
      // This method serves only as a renderer for the Vuex's state dump.
      const previewTable = document.querySelector('#vuex-preview table');
      let newInnerHtml = '<tbody>';

      for (const [key, value] of Object.entries(store.state)) {
        newInnerHtml += `<tr><td class="table-container">`;

        if (key === 'hotData' && Array.isArray(value)) {
          newInnerHtml += `<strong>hotData:</strong> <br><table><tbody>`;

          for (let row of value) {
            newInnerHtml += `<tr>`;

            for (let cell of row) {
              newInnerHtml += `<td>${cell}</td>`;
            }

            newInnerHtml += `</tr>`;
          }
          newInnerHtml += `</tbody></table>`;

        } else if (key === 'hotSettings') {
          newInnerHtml += `<strong>hotSettings:</strong> <ul>`;

          for (let settingsKey of Object.keys(value)) {
            newInnerHtml += `<li>${settingsKey}: ${store.state.hotSettings[settingsKey]}</li>`;
          }

          newInnerHtml += `</ul>`;
        }

        newInnerHtml += `</td></tr>`;
      }
      newInnerHtml += `</tbody>`;

      previewTable.innerHTML = newInnerHtml;
    }
  },
  components: {
    HotTable,
  }
});

export default ExampleComponent;

<div id="example1" class="dump-example-container">
  <div id="example-preview">
    <div id="toggle-boxes">
      <br/>
      <input v-on:click="toggleReadOnly" checked id="readOnlyCheck" type="checkbox"/>
      <label for="readOnlyCheck"> Toggle <code>readOnly</code> for the entire table</label>
    </div>
    <br/>
    <hot-table ref="wrapper" :settings="hotSettings"></hot-table>
  </div>
  <div id="vuex-preview">
    <h4>Vuex store dump:</h4>
    <table></table>
  </div>
</div>