h1

h2

Documents

• Getting Started
• How to use Ajax feature
• APIs
• v4.0.0 Migration Guide

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 NHN 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

• Download bundle files and all sources for each version

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.

Browser Support

Chrome	Internet Explorer	Edge	Safari	Firefox
Yes	8+	Yes	Yes	Yes

• ContextMenu feature does not support IE8.

Contributing

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

TOAST UI Family

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

License

This software is licensed under the MIT © NHN Cloud.