React Data Grid Time cell type

Table of contents

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

Overview

The time cell type formats, renders, and validates the contents of the cell as a time.

Usage

To use the time cell type, set the type: 'time' option in the columns array or the cells function. The time cell uses Moment.js (opens new window) as the time formatter, therefore you must add the following required dependency:

<script src="https://cdn.jsdelivr.net/npm/moment@2.29.4/moment.min.js"></script>

All data entered into the time-typed cells is eventually validated against the default time format - h:mm:ss a, which translates to, for example, 9:30:00 am unless another format is provided as the timeFormat. If you enable the correctFormat configuration option, the values will be automatically formatted to match the desired time format.

TIP

By default, the values entered into the time-type column are not validated, so if you want them to display in the proper format, remember to call hot.validateCells() after the table initialization.

Basic example

import { useEffect, useRef } from 'react'; import ReactDOM from 'react-dom'; import { HotTable } from '@handsontable/react'; import { registerAllModules } from 'handsontable/registry'; import 'handsontable/dist/handsontable.full.min.css'; // register Handsontable's modules registerAllModules(); const ExampleComponent = () => { const hotRef = useRef(null); useEffect(() => { const hot = hotRef.current.hotInstance; hot.validateCells(); }); return ( <HotTable ref={hotRef} data={[ ['Mercedes', 'A 160', 1332284400000, 6999.95], ['Citroen', 'C4 Coupe', '10 30', 8330], ['Audi', 'A4 Avant', '8:00 PM', 33900], ['Opel', 'Astra', 1332284400000, 7000], ['BMW', '320i Coupe', 1332284400000, 30500] ]} colHeaders={['Car', 'Model', 'Registration time', 'Price']} columnSorting={true} height="auto" licenseKey="non-commercial-and-evaluation" columns={[{ type: 'text', }, { // 2nd cell is simple text, no special options here }, { type: 'time', timeFormat: 'h:mm:ss a', correctFormat: true }, { type: 'numeric', numericFormat: { pattern: '$ 0,0.00' } } ]} /> ); }; ReactDOM.render(<ExampleComponent />, document.getElementById('example1')); <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" /> <script src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@handsontable/react@12.1/dist/react-handsontable.js"></script> <script src="https://handsontable.com/docs/12.1/scripts/fixer.js"></script> <script src="https://handsontable.com/docs/12.1/scripts/helpers.js"></script> <div id="example1" class="hot "></div>

import { useEffect, useRef } from 'react';
import ReactDOM from 'react-dom';
import { HotTable } from '@handsontable/react';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.min.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = () => {
  const hotRef = useRef(null);

  useEffect(() => {
    const hot = hotRef.current.hotInstance;

    hot.validateCells();
  });

  return (
    <HotTable
      ref={hotRef}
      data={[
        ['Mercedes', 'A 160', 1332284400000, 6999.95],
        ['Citroen', 'C4 Coupe', '10 30', 8330],
        ['Audi', 'A4 Avant', '8:00 PM', 33900],
        ['Opel', 'Astra', 1332284400000, 7000],
        ['BMW', '320i Coupe', 1332284400000, 30500]
      ]}
      colHeaders={['Car', 'Model', 'Registration time', 'Price']}
      columnSorting={true}
      height="auto"
      licenseKey="non-commercial-and-evaluation"
      columns={[{
          type: 'text',
        },
        {
          // 2nd cell is simple text, no special options here
        },
        {
          type: 'time',
          timeFormat: 'h:mm:ss a',
          correctFormat: true
        },
        {
          type: 'numeric',
          numericFormat: {
            pattern: '$ 0,0.00'
          }
        }
      ]}
    />
  );
};

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

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