Skip to content
Handsontable dev

Custom editor in Vue 3

In this tutorial, you will create a custom cell editor as a Vue 3 component. You will learn to extend the BaseEditor class and register your editor with Handsontable.

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.

Vue
<script setup>
import { ref } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { TextEditor } from 'handsontable/editors/textEditor';
import { registerAllModules } from 'handsontable/registry';


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 hotSettings = ref({
  startRows: 5,
  columns: [
    {
      editor: CustomEditor
    }
  ],
  colHeaders: true,
  colWidths: 200,
  autoWrapRow: true,
  autoWrapCol: true,
  height: 'auto',
  licenseKey: 'non-commercial-and-evaluation'
});
</script>


<template>
  <div id="example1">
    <HotTable :settings="hotSettings" />
  </div>
</template>

Related guides

Cell editor

APIs

BasePlugin

Configuration options

editor
enterBeginsEditing

Core methods

destroyEditor()
getActiveEditor()
getCellEditor()
getCellMeta()
getCellMetaAtRow()
getCellsMeta()
setCellMeta()
setCellMetaObject()
removeCellMeta()

Hooks

afterBeginEditing
afterGetCellMeta
beforeGetCellMeta

What you learned

  • How to extend the BaseEditor class to build a custom editor.
  • How to register a custom editor with a Handsontable column or the entire grid.
  • How to pass a key attribute to differentiate between multiple editor instances.

Next steps