Git Product home page Git Product logo

tui.grid's Introduction

toast ui grid

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

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

tui-grid-screenshot

โ˜๏ธ ๐Ÿ‘€ โ˜๏ธ 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

Download

๐Ÿ”จ 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 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.

Setup

$ git clone https://github.com/nhnent/tui.grid.git
$ cd tui.grid
$ npm install

Local Test

$ npm run test

Run Server

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

Bundle

$ 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.

tui.grid's People

Contributors

seonim-ryu avatar icebelle avatar

Watchers

Steve avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.