Wondering what’s next for npm?Check out our public roadmap! »

    tui-grid
    TypeScript icon, indicating that this package has built-in type declarations

    4.17.0 • Public • Published

    TOAST UI Grid

    npm

    🚩 Table of Contents

    Collect statistics on the use of open source

    TOAST UI Grid applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Grid is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > "ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage.

    To disable GA, use the following usageStatistics option when creating the instance.

    const options = {
      // ...
      usageStatistics: false
    };
    
    const instance = new Grid(options);

    📙 Documents

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

    💾 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. You can conveniently install it using the commands provided by the 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

    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/grid/latest/tui-grid.css" />
    ...
    <script src="https://uicdn.toast.com/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.

    grid/
    ├─ latest/
    │  ├─ tui-grid.css
    │  ├─ tui-grid.min.css
    │  ├─ tui-grid.js
    │  └─ tui-grid.min.js
    ├─ v3.8.0/
    │  ├─ ...
    

    Download Source Files

    🔨 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

    const Grid = tui.Grid;

    Using module format in node environment

    const Grid = require('tui-grid'); /* CommonJS */
    import Grid from 'tui-grid'; /* ES6 */

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

    const instance = new Grid({
      el: document.getElementById('grid'), // Container element
      columns: [
        {
          header: 'Name',
          name: 'name'
        },
        {
          header: 'Artist',
          name: 'artist'
        },
        {
          header: 'Release',
          name: 'release'
        },
        {
          header: 'Genre',
          name: 'genre'
        }
      ],
      data: [
        {
          name: 'Beautiful Lies',
          artist: 'Birdy',
          release: '2016.03.26',
          genre: 'Pop'
        }
      ]
    });
    
    instance.resetData(newData); // Call API of instance's public method
    
    Grid.applyTheme('striped'); // Call API of static method

    Install

    npm i tui-grid

    DownloadsWeekly Downloads

    1,176

    Version

    4.17.0

    License

    MIT

    Unpacked Size

    1.65 MB

    Total Files

    29

    Last publish

    Collaborators

    • avatar