Angular Data Grid Custom editor example in Angular

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

In this article

• Example
• Related articles
  • Related guides
  • Related API reference

Example

The following is an implementation of the @handsontable/angular component with a custom editor added. It utilizes the placeholder attribute in the editor's input element.

/* file: app.component.ts */
import { Component } from '@angular/core';
import Handsontable from 'handsontable/base';
import { CustomEditor } from './CustomEditor';

@Component({
  selector: 'app-root',
  template: `
    <div>
      <hot-table [settings]="hotSettings"></hot-table>
    </div>
  `,
})
export class AppComponent {
  hotSettings: Handsontable.GridSettings = {
    startRows: 5,
    columns: [
      {
        editor: CustomEditor
      }
    ],
    colHeaders: true,
    colWidths: 200,
    licenseKey: 'non-commercial-and-evaluation'
  };
}

/* file: app.module.ts */
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { HotTableModule } from '@handsontable/angular';
import { registerAllModules } from 'handsontable/registry';
import { AppComponent } from './app.component';

// register Handsontable's modules
registerAllModules();

@NgModule({
  imports: [ BrowserModule, HotTableModule ],
  declarations: [ AppComponent ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

/* file: CustomEditor.ts */
import { TextEditor } from 'handsontable/editors/textEditor';

export class CustomEditor extends TextEditor {
  override 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);
  }
}

<app-root></app-root>

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