ToastUI Grid

The Powerful Component to Display and Edit Data. Experience the Ultimate Da...

Table
nhn/tui.gridui.toast.com/tui-grid/tui-grid

README

TOAST UI Grid


The Powerful Component to Display and Edit Data. Experience the Ultimate Data Transformer!

GitHub release npm GitHub license PRs welcome code with hearth by NHN Cloud

tui-grid

🚩 Table of Contents


- Packages
- The Toast UI Grid Is an Ultimate Transformer
- Features
- Examples
- Browser Support
- Pull Request Steps
- Contributing
- Dependencies
- TOAST UI Family
- Used By
- License

📦 Packages


The functionality of TOAST UI Grid is available when using the Plain javaScript, React, Vue Component.

- toast-ui.grid - Plain JavaScript component implemented by NHN Cloud.
- toast-ui.vue-grid -Vue wrapper component implemented by NHN Cloud.
- toast-ui.react-grid -React wrapper component implemented by NHN Cloud.

🤖 The Toast UI Grid Is an Ultimate Transformer


Data Can Be Displayed in Any Format


Styling


The TOAST UI Grid is a component that can display, edit, add, and delete multiple data.
You can append units to the data shown and use html to represent images and links instead of textual data.

style

Summary


The summary function allows you to caculate on multiple rows of data and display the results.
It automatically calculates the total sum, the average, the maximum and minimum value, and updates each result whenever the value changes.

summary

Tree Data


Starting with version 3 or later, you can use tree data to represent them in a hierarchy.
Now let's process the data we want.

tree

Provides a Custom Editing Elements


In order to edit the data, you don't need to use html to create the editing elements yourself.
It supports various input elements such as text, select box, checkbox, radio button.
You can set the data editing method just by setting options.
You can also show editing elements whatever you want through Custom Editor.

59417111-9e181280-8e01-11e9-8de7-2df819b36354

Simple, Easy to Use Themes


It has three themes: default, striped (zebra pattern), and clean theme.
You can easily add the desired design to the themes provided through the theme API.
Themes API has been improved since version 3, allowing you to easily control the background color of the header / body area and vertical / horizontal border lines without modifying CSS styles directly.
Use the theme to customize your grid.

defaultstripedclean
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
![theme-default](https://user-images.githubusercontent.com/18183560/41571499-724937ec-73ae-11e8-8ecd-a111a5c391bc.png)![theme-striped](https://user-images.githubusercontent.com/18183560/41571500-727500ca-73ae-11e8-808c-252638e479fc.png)![theme-clean](https://user-images.githubusercontent.com/18183560/41571498-721ffdbe-73ae-11e8-9e75-7603b582c3cb.png)

In addition, a variety of powerful features can be found on the demo page below. 👇👇👇

🎨 Features


- More Diverse Input Types _(checkbox, radio, select, password, etc.)_
- Full Keyboard Navigation _(move, select, copy, paste, delete, etc.)_
- Copy & Paste using clipboard with 3rd party application _(Like MS-Excel or Google-spreadsheet)_
- Multi column headers
- Picking date
- Relational Structure Between Columns
- Data Source
- Summarize all values of each column
- Customizing styles _(Three basic themes)_
- Tree Data Representation
- Custom cell renderer
- Pagination
- Frozen(Pinned) columns
- Enhanced Virtual Scroll _(Handling Large Dataset Without Performance Loss)_
- Column resize & reorder & show & hide
- Validation
- Selection
- Sorting
- Merging cell

🐾 Examples


- Basic
- Custom Editor
- Relation between columns
- Themes
- DatePicker
- Summary
- Data Source
- Tree

Here are more examples and play with TOAST UI Grid!

TypeScript


If you are using TypeScript, you must use import module = require('module') to import the Grid module. See "export = " and "import = require()".

  1. ```typescript
  2. import Grid = require('tui-grid');

  4. const instance = new Grid({
  5.   // ...options
  6. });
  7. ```

🌏 Browser Support


| Chrome Chrome | IE Internet Explorer | Edge Edge | Safari Safari | Firefox Firefox |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|                                                                               Yes                                                                                |                                                                                   9+                                                                                    |                                                                             Yes                                                                              |                                                                               Yes                                                                                |                                                                                Yes                                                                                 |

🔧 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 if there are any errors.

  1. ```sh
  2. $ git clone https://github.com/{your-personal-repo}/tui.grid.git
  3. $ npm install
  4. $ cd packages/toast-ui.grid
  5. $ npm install
  6. $ npm run test
  7. ```

Develop


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

Run webpack-dev-server


  1. ```sh
  2. $ npm start
  3. ```

Run storybook


  1. ```sh
  2. $ npm run storybook
  3. ```

Run cypress test


  1. ```sh
  2. $ npm run test
  3. ```

Pull Request


Before uploading your PR, run test one last time to check if there are any errors.
If it has no errors, commit and then push it!

For more information on PR's steps, please see links in the Contributing section.

💬 Contributing


- Code of Conduct
- Contributing guideline
- Commit convention
- Issue guideline

🔩 Dependencies


DOMPurify

🍞 TOAST UI Family


- TOAST UI Calendar
- TOAST UI Chart
- TOAST UI Editor
- TOAST UI Image-Editor
- TOAST UI Components

🚀 Used By


- NCP - Commerce Platform
- TOAST File
- HANGAME
- TOAST Gamebase
- NHN Dooray - Collaboration Service
- Shop by
- Payco
- YES24 - Movie Management System (Admin Tools)
- coreBOS

📜 License


This software is licensed under the MIT © NHN Cloud.