https://github.com/chemzqm/tree

Lightweight tree component, with dynamic node, event and D&D support.
https://github.com/chemzqm/tree

Last synced: about 1 month ago
JSON representation

Lightweight tree component, with dynamic node, event and D&D support.

• Host: GitHub
• URL: https://github.com/chemzqm/tree
• Owner: chemzqm
• Created: 2014-01-14T07:31:47.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-04-03T17:25:41.000Z (over 8 years ago)
• Last Synced: 2024-10-29T16:26:39.032Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://chemzqm.github.io/tree/
• Size: 84 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
# tree

  Lightweight tree component, with dynamic node, event and D&D support.

  [demo](http://chemzqm.github.io/tree/)

## Installation

  Install with [component(1)](http://component.io):

    $ component install chemzqm/tree

  Install with [npm](https://npmjs.com)

    $ npm install tree-ui

## Example

``` js

var Tree = require('tree');

var parent =document.getElementById('tree');

var tree = new Tree(parent);

tree.data([{

    text: 'o'

  }, {

    text: 'first title',

    id: 'first',

    children:[

      {text: '2'},

      {text: '3'}

    ]

  }, {

    text: 'end'

  }]);

tree.draggable();

tree.on('active', function(node) {

  console.log(node);

})

tree.on('update', function(){

  var str = tree.toJSON();

  console.log(str);

})

```

## Events

* `update` emitted after D&D event.

* `active` emitted with `node` when a leaf node is clicked, class `active` is added to that node.

* `remove` emitted with `node` when a node is removed from the tree.

## API

### Tree(parent)

Init tree with parent node.

### .data(object, [config])

Build the tree with object. Optional config your `text` and `children` attributes.

### .draggable()

Make the leaves draggable.

### .parents(id | el)

et branch node list by id or node reference.

### .toJSON()

Get the json format.

### .find(id)

Get the node by `data-id`.

### .show(id | el)

Make the node visible by `data-id` or node refenence.

### .remove(id | el)

Remove the node by `data-id` or node refenence.

### .collapse(id | el)

Collapse the branch node by id or node reference.

## License

  The MIT License (MIT)

  Copyright (c) 2014 

  Permission is hereby granted, free of charge, to any person obtaining a copy

  of this software and associated documentation files (the "Software"), to deal

  in the Software without restriction, including without limitation the rights

  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  copies of the Software, and to permit persons to whom the Software is

  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in

  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

  THE SOFTWARE.