Vue 3 Data Grid Custom editor in Vue 3

Create a custom cell editor, and use it in your Vue 3 data grid by declaring it as a class.

In this article

• Overview
• Example - Declaring an editor as a class
• Related articles
  • Related guides
  • Related API reference

Overview

You can declare a custom editor for the HotTable component by declaring it as a class and passing it to the Handsontable options or creating an editor component. You can use it many times and with different properties. To differentiate between editor instances, pass a key attribute.

Find out which Vue 3 versions are supported

Example - Declaring an editor as a class

The following example implements the @handsontable/vue3 component with a custom editor added, utilizing the placeholder attribute in the editor's input element.

import { defineComponent } from 'vue'; import { HotTable } from '@handsontable/vue3'; import { TextEditor } from 'handsontable/editors/textEditor'; import { registerAllModules } from 'handsontable/registry'; import 'handsontable/dist/handsontable.full.css'; // register Handsontable's modules registerAllModules(); class CustomEditor extends TextEditor { createElements() { super.createElements(); this.TEXTAREA = document.createElement('input'); this.TEXTAREA.setAttribute('placeholder', 'Custom placeholder'); this.TEXTAREA.setAttribute('data-hot-input', true); this.textareaStyle = this.TEXTAREA.style; this.TEXTAREA_PARENT.innerText = ''; this.TEXTAREA_PARENT.appendChild(this.TEXTAREA); } } const ExampleComponent = defineComponent({ data() { return { hotSettings: { startRows: 5, columns: [ { editor: CustomEditor } ], colHeaders: true, colWidths: 200, licenseKey: 'non-commercial-and-evaluation' } } }, 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/@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"> <hot-table :settings="hotSettings"></hot-table> </div>

import { defineComponent } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { TextEditor } from 'handsontable/editors/textEditor';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.css';

// register Handsontable's modules
registerAllModules();

class CustomEditor extends TextEditor {
  createElements() {
    super.createElements();

    this.TEXTAREA = document.createElement('input');
    this.TEXTAREA.setAttribute('placeholder', 'Custom placeholder');
    this.TEXTAREA.setAttribute('data-hot-input', true);
    this.textareaStyle = this.TEXTAREA.style;
    this.TEXTAREA_PARENT.innerText = '';
    this.TEXTAREA_PARENT.appendChild(this.TEXTAREA);
  }
}

const ExampleComponent = defineComponent({
  data() {
    return {
      hotSettings: {
        startRows: 5,
        columns: [
          {
            editor: CustomEditor
          }
        ],
        colHeaders: true,
        colWidths: 200,
        licenseKey: 'non-commercial-and-evaluation'
      }
    }
  },
  components: {
    HotTable,
  }
});

export default ExampleComponent;

<div id="example1">
  <hot-table :settings="hotSettings"></hot-table>
</div>

Related articles

Related guides

• Cell editor

Related API reference

• APIs:
  • BasePlugin
• Configuration options:
  • editor
  • enterBeginsEditing
• Core methods:
  • destroyEditor()
  • getActiveEditor()
  • getCellEditor()
  • getCellMeta()
  • getCellMetaAtRow()
  • getCellsMeta()
  • setCellMeta()
  • setCellMetaObject()
  • removeCellMeta()
• Hooks:
  • afterBeginEditing
  • afterGetCellMeta
  • beforeGetCellMeta