Referencing the Handsontable instance in Vue 3

Table of contents

• Overview
• Example

Overview

The following example implements the @handsontable/vue3, showing how to reference the Handsontable instance from the wrapper component.

Find out which Vue 3 versions are supported →

Example

import { createApp } from 'vue'; import { HotTable } from '@handsontable/vue3'; import { registerAllModules } from 'handsontable/registry'; import { createSpreadsheetData } from './helpers'; // register Handsontable's modules registerAllModules(); const app = createApp({ data() { return { hotSettings: { data: createSpreadsheetData(4, 4), colHeaders: true, height: 'auto', licenseKey: 'non-commercial-and-evaluation' } }; }, methods: { swapHotData: function() { // The Handsontable instance is stored under the `hotInstance` property of the wrapper component. this.$refs.hotTableComponent.hotInstance.loadData([['new', 'data']]); } }, components: { HotTable, } }); app.mount('#example1'); <script src="https://cdn.jsdelivr.net/npm/handsontable@11.1/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@11.1/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/@handsontable/vue3@11.1/dist/vue-handsontable.min.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/fixer.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/helpers.js"></script> <div id="example1"> <hot-table ref="hotTableComponent" :settings="hotSettings"></hot-table><br/> <button v-on:click="swapHotData" class="controls">Load new data!</button> </div>

import { createApp } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { registerAllModules } from 'handsontable/registry';
import { createSpreadsheetData } from './helpers';

// register Handsontable's modules
registerAllModules();

const app = createApp({
  data() {
    return {
      hotSettings: {
        data: createSpreadsheetData(4, 4),
        colHeaders: true,
        height: 'auto',
        licenseKey: 'non-commercial-and-evaluation'
      }
    };
  },
  methods: {
    swapHotData: function() {
      // The Handsontable instance is stored under the `hotInstance` property of the wrapper component.
      this.$refs.hotTableComponent.hotInstance.loadData([['new', 'data']]);
    }
  },
  components: {
    HotTable,
  }
});

app.mount('#example1');

<div id="example1">
  <hot-table ref="hotTableComponent" :settings="hotSettings"></hot-table><br/>
  <button v-on:click="swapHotData" class="controls">Load new data!</button>
</div>