JavaScript Data Grid Handsontable cell type

Table of contents

• Overview
• Usage
• Basic example
• Related articles
  • Related guides
  • Related API reference

Overview

This page describes how to use Handsontable as a cell editor in Handsontable.

Usage

HOT-in-HOT opens by any of the following:

• F2 or Enter key is pressed while the cell is selected
• The triangle icon is clicked
• The cell content is double clicked

While HOT-in-HOT is opened, the text field above the HOT-in-HOT remains focused at all times.

Keyboard bindings while the HOT-in-HOT is opened:

• Escape - close editor and cancel change.
• Enter - close editor and apply change*, move the selection in the main HOT downwards or according to the enterMoves setting.
• Tab - behaves as the Enter key, but move the selection in the main HOT to the right or to the left (depending on your layoutDirection setting) or according to the tabMovessetting.
• Arrow Down - move the selection in HOT-in-HOT downwards. If the last row was selected, this has no effect.
• Arrow Up - move the selection in HOT-in-HOT upwards. If the first row was selected, deselect. If HOT-in-HOT was deselected, behave as the Enter key but move the selection in the main HOT upwards.
• Arrow Right - move the text cursor in the text field to the left. If the text cursor was at the start position, behave as the Enter key but move the selection in the main HOT to the left.
• Arrow Left - move the text cursor in the text field to the right. If the text cursor was at the end position, behave as the TAB key.

Basic example

const container = document.querySelector('#example1'); const colorData = [['yellow'], ['red'], ['orange'], ['green'], ['blue'], ['gray'], ['black'], ['white']]; const manufacturerData = [ { name: 'BMW', country: 'Germany', owner: 'Bayerische Motoren Werke AG' }, { name: 'Chrysler', country: 'USA', owner: 'Chrysler Group LLC' }, { name: 'Nissan', country: 'Japan', owner: 'Nissan Motor Company Ltd' }, { name: 'Suzuki', country: 'Japan', owner: 'Suzuki Motor Corporation' }, { name: 'Toyota', country: 'Japan', owner: 'Toyota Motor Corporation' }, { name: 'Volvo', country: 'Sweden', owner: 'Zhejiang Geely Holding Group' } ]; const hot = new Handsontable(container, { licenseKey: 'non-commercial-and-evaluation', data: [ ['Tesla', 2017, 'black', 'black'], ['Nissan', 2018, 'blue', 'blue'], ['Chrysler', 2019, 'yellow', 'black'], ['Volvo', 2020, 'white', 'gray'] ], colHeaders: ['Car', 'Year', 'Chassis color', 'Bumper color'], columns: [ { type: 'handsontable', handsontable: { colHeaders: ['Marque', 'Country', 'Parent company'], autoColumnSize: true, data: manufacturerData, getValue() { const selection = this.getSelectedLast(); // Get the manufacturer name of the clicked row and ignore header // coordinates (negative values) return this.getSourceDataAtRow(Math.max(selection[0], 0)).name; }, } }, { type: 'numeric' }, { type: 'handsontable', handsontable: { colHeaders: false, data: colorData } }, { type: 'handsontable', handsontable: { colHeaders: false, data: colorData } } ] }); <script src="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.css" /> <div id="example1" class="hot "></div>

const container = document.querySelector('#example1');
const colorData = [['yellow'], ['red'], ['orange'], ['green'], ['blue'], ['gray'], ['black'], ['white']];
const manufacturerData = [
  { name: 'BMW', country: 'Germany', owner: 'Bayerische Motoren Werke AG' },
  { name: 'Chrysler', country: 'USA', owner: 'Chrysler Group LLC' },
  { name: 'Nissan', country: 'Japan', owner: 'Nissan Motor Company Ltd' },
  { name: 'Suzuki', country: 'Japan', owner: 'Suzuki Motor Corporation' },
  { name: 'Toyota', country: 'Japan', owner: 'Toyota Motor Corporation' },
  { name: 'Volvo', country: 'Sweden', owner: 'Zhejiang Geely Holding Group' }
];

const hot = new Handsontable(container, {
  licenseKey: 'non-commercial-and-evaluation',
  data: [
    ['Tesla', 2017, 'black', 'black'],
    ['Nissan', 2018, 'blue', 'blue'],
    ['Chrysler', 2019, 'yellow', 'black'],
    ['Volvo', 2020, 'white', 'gray']
  ],
  colHeaders: ['Car', 'Year', 'Chassis color', 'Bumper color'],
  columns: [
    {
      type: 'handsontable',
      handsontable: {
        colHeaders: ['Marque', 'Country', 'Parent company'],
        autoColumnSize: true,
        data: manufacturerData,
        getValue() {
          const selection = this.getSelectedLast();

          // Get the manufacturer name of the clicked row and ignore header
          // coordinates (negative values)
          return this.getSourceDataAtRow(Math.max(selection[0], 0)).name;
        },
      }
    },
    { type: 'numeric' },
    {
      type: 'handsontable',
      handsontable: {
        colHeaders: false,
        data: colorData
      }
    },
    {
      type: 'handsontable',
      handsontable: {
        colHeaders: false,
        data: colorData
      }
    }
  ]
});

Related articles

Related guides

• Cell type

Related API reference

• Configuration options:
  • type
• Core methods:
  • getCellMeta()
  • getCellMetaAtRow()
  • getCellsMeta()
  • getDataType()
  • setCellMeta()
  • setCellMetaObject()
  • removeCellMeta()
• Hooks:
  • afterGetCellMeta
  • afterSetCellMeta
  • beforeGetCellMeta
  • beforeSetCellMeta