JSPM

Package Exports

tui-grid

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tui-grid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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

🌏 Browser Support

Chrome	Internet Explorer	Edge	Safari	Firefox
Yes	8+	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

TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

Via Package Manager

TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

npm

$ npm install --save tui-grid # Latest version
$ npm install --save tui-grid@<version> # Specific version

bower

$ bower install tui-grid # Latest version
$ bower install tui-grid#<tag> # Specific version

Via Contents Delivery Network (CDN)

TOAST UI products are available over the CDN powered by TOAST Cloud.

You can use the CDN as below.

<link rel="stylesheet" href="https://uicdn.toast.com/tui.grid/latest/tui-grid.css" />
...
<script src="https://uicdn.toast.com/tui.grid/latest/tui-grid.js"></script>

If you want to use a specific version, use the tag name instead of latest in the url's path.

The CDN directory has the following structure.

tui.grid/
├─ latest/
│  ├─ tui-grid.comb.js // This file includes the backbone and underscore.
│  ├─ tui-grid.comb.min.js
│  ├─ tui-grid.css
│  ├─ tui-grid.min.css
│  ├─ tui-grid.js
│  └─ tui-grid.min.js
├─ v2.10.0/
│  ├─ ...

Download Source Files

🔩 Dependency

jquery >=1.11.0
underscore >=1.8.3
backbone >=1.3.3
tui-code-snippet >=1.3.0
component (optional)
- tui-pagination >=3.2.0
- tui-date-picker >=3.1.0

You can also use lodash instead of underscore and use higher version of jquery (like v2.x.x) depending on your project.

🔨 Usage

HTML

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

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

JavaScript

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 ways depending on your environment.

Using namespace in browser environment

var Grid = tui.Grid;

Using module format in node environment

var Grid = require('tui-grid'); /* CommonJS */

import {Grid} from 'tui-grid'; /* ES6 */

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

🔧 Pull Request Steps

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

Setup

Fork master branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{your-personal-repo}/tui.grid.git
$ cd tui.grid
$ npm install
$ npm run test

Develop

Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

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

Run karma test

$ npm run test

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

tui-grid