Custom editor in React

Table of contents

• 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.

Example - Declaring an editor as a class

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

import React from 'react';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { TextEditor } from 'handsontable/editors/textEditor';
import { registerAllModules } from 'handsontable/registry';

// register Handsontable's modules
registerAllModules();

class CustomEditor extends TextEditor {
  constructor(props) {
    super(props);
  }

  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 = {
  startRows: 5,
  columns: [
    {
      editor: CustomEditor
    }
  ],
  colHeaders: true,
  colWidths: 200,
  licenseKey: 'non-commercial-and-evaluation'
};

const App = () => {
  return (
    <div>
      <HotTable
        id="hot"
        settings={hotSettings}
      />
    </div>
  );
}

ReactDOM.render(<App />, document.getElementById('example1'));

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