tui-tree

    4.0.9 • Public • Published

    TOAST UI Component : Tree

    Component that displays data hierarchically.

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

    🚩 Table of Contents

    Collect statistics on the use of open source

    TOAST UI Tree applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Tree 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 Tree(container, options);

    Or, include tui-code-snippet(v2.3.0 or later) and then immediately write the options as follows:

    tui.usageStatistics = false;

    📙 Documents

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

    🎨 Features

    • Creates each node hierarchically by data.
    • Folds or unfolds the children of each node.
    • Supports optional features.
      • Selectable : Each node can be selected.
      • Draggable : Each node can be moved.
      • Editable : Each node can be edited.
      • ContextMenu : A context menu can be created for each node. (Not supporting IE8)
      • Checkbox : A checkbox can be added to each node and a 3-state checkbox is used.
      • Ajax : Requests server and handles the CRUD for each node.
    • Supports templates.
    • Supports custom events.
    • Provides the file of default css style.

    🐾 Examples

    • Basic : Example of using default options.
    • Using checkbox : Example of adding checkbox on each node and handling.
    • Using Ajax : Example of using server request, Selectable, Draggable, Editable, ContextMenu features.

    More examples can be found on the left sidebar of each example page, and have fun with it.

    💾 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 the package manager, npm. 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-tree # Latest version
    $ npm install --save tui-tree@<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.

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

    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-tree/
    ├─ latest/
    │  ├─ tui-tree.css
    │  ├─ tui-tree.js
    │  ├─ tui-tree.min.css
    │  └─ tui-tree.min.js
    ├─ v3.3.0/
    │  ├─ ...
    

    Download Source Files

    🔨 Usage

    HTML

    Add the container element to create the component. A wrapper element should have tui-tree-wrap as a class name to apply tui-tree's style.

    <div id="tree" class="tui-tree-wrap"></div>

    JavaScript

    This 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 Tree = tui.Tree;

    Using module format in node environment

    const Tree = require('tui-tree'); /* CommonJS */
    import Tree from 'tui-tree'; /* ES6 */

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

    const container = document.getElementById('tree');
    const instance = new Tree(container, { ... });
    
    instance.add( ... );

    For more information about the API, please see here.

    🔩 Dependency

    • tui-context-menu >=2.1.6 (Optional, needs forusing ContextMenu feature, not supporting IE8)

    🌏 Browser Support

    Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
    Yes 8+ Yes Yes Yes
    • ContextMenu feature does not support IE8.

    🔧 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 develop 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.tree.git
    $ cd tui.tree
    $ 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.

    Running dev server

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

    Running 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!

    For more information on PR's step, please see links of Contributing section.

    💬 Contributing

    🍞 TOAST UI Family

    📜 License

    This software is licensed under the MIT © NHN.

    Install

    npm i tui-tree

    DownloadsWeekly Downloads

    86

    Version

    4.0.9

    License

    MIT

    Unpacked Size

    330 kB

    Total Files

    7

    Last publish

    Collaborators

    • nhnent