toast ui grid

The powerful widget to show and edit data. It's free!

GitHub release
GitHub license
PRs welcome
code with hearth by NHN Entertainment


☝️ 👀 ☝️ Click the image above to play the video below shows the major features of TOAST UI Grid briefly!

🚩 Table of Contents

🌏 Browser Support

IE / Edge Internet Explorer IE / Edge Edge Firefox Firefox Chrome Chrome Safari Safari
8+ Yes Yes Yes Yes

🎨 Features

  • Various input types (checkbox, radio, select, password, etc)
  • Full keyboard navigation (move, select, copy, paste, delete, etc)
  • Virtual scrolling (Handling large dataset without performance loses)
  • Copy & Paste using clipboard with 3rd party application (Like MS-Excel or Google-spreadsheet)
  • Column resize & reorder & show & hide
  • Multi column headers
  • Custom cell formatter & converter
  • Inline Editing
  • Validation
  • Selection
  • Pagination
  • Picking date
  • Sorting
  • Merging cell
  • Frozen(Pinned) columns
  • Relation between each columns
  • Binding to remote data
  • Summarize all values of each column
  • Customizing styles (Three basic themes)

In addition, you can implement desired functions using various options and APIs.

🐾 Examples

Here are more examples and play with TOAST UI Grid!

💾 Install

Install the module to use. TOAST UI products are registered in two package managers, npm and bower. You can download it directly from the github repository, but we highly recommend to install using the npm package manager.

Using npm

$ npm install --save tui-grid # latest version
$ npm install --save tui-grid@<version> # specific version

Using bower

$ bower install tui-grid # latest version
$ bower install tui-grid#<tag> # specific version


🔨 Usage


Add the container element where TOAST UI Grid will be created.

<div id="grid"></div>


TOAST UI Grid can be used by creating an instance with the constructor function.
To get the constructor function, you should import the module using one of the following three ways depending on your environment.

var Grid = tui.Grid; /* namespace */
var Grid = require('tui-grid'); /* CommonJS in Node.js */
import {Grid} from 'tui-grid'; /* ES6 in Node.js */

You can create an instance with options and call various APIs after creating an instance.

var instance = new Grid({
    el: $('#grid'), // Container element
    columns: [
            title: 'Name',
            name: 'name'
            title: 'Artist',
            name: 'artist'
            title: 'Release',
            name: 'release'
            title: 'Genre',
            name: 'genre'
    data: [
        name: 'Beautiful Lies',
        artist: 'Birdy',
        release: '2016.03.26',
        genre: 'Pop'

instance.setData(newData); // Call API of instance's public method

Grid.applyTheme('striped'); // Call API of static method

🔧 Development

TOAST UI products are open source, so you can create a pull request after you fix issues. Run npm scripts and develop yourself with the following process.


$ git clone
$ cd tui.grid
$ npm install

Local Test

$ npm run test

Run Server

$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8


$ npm run bundle

📙 Documents

You can also see the older versions of API page on the releases page.

💬 Contributing

🍞 TOAST UI Family

📜 License

This software is licensed under the MIT © NHN Entertainment.