Angular UI Tree
======================
[](https://gitter.im/angular-ui-tree/angular-ui-tree?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Angular UI Tree is an AngularJS UI component that can sort nested lists, provides drag & drop support and doesn't depend on jQuery. If you are a user who uses `angular-nestedSortable`, this is [How to migrate From v1.x to v2.0](https://github.com/JimLiu/angular-ui-tree/wiki/Migrate-From-v1.x-to-v2.0).
### Considering Contributing?
Read our contributing guidelines and become a contributing member of Angular UI Tree!
[CONTRIBUTING](https://github.com/angular-ui-tree/angular-ui-tree/blob/master/CONTRIBUTING.md)
## Features
- Uses the native AngularJS scope for data binding
- Sorted and move items through the entire tree
- Prevent elements from accepting child nodes
## Supported browsers
The Angular UI Tree is tested with the following browsers:
- Chrome (stable)
- Firefox
- IE 8, 9 and 10
For IE8 support, make sure you do the following:
- include an [ES5 shim](https://github.com/es-shims/es5-shim)
- make your [AngularJS application compatible with Internet Explorer](http://docs.angularjs.org/guide/ie)
- use [jQuery 1.x](http://jquery.com/browser-support/)
## Demo
Watch the Tree component in action on the [demo page](http://angular-ui-tree.github.io/angular-ui-tree/).
## Requirements
- Angularjs
## Usage
### Download
- Using [bower](http://bower.io/) to install it. `bower install angular-ui-tree`
- [Download](https://github.com/angular-ui-tree/angular-ui-tree/archive/master.zip) from github.
### Load CSS
Load the css file: `angular-ui-tree.min.css` in your application:
```html
```
### Load Script
Load the script file: `angular-ui-tree.js` or `angular-ui-tree.min.js` in your application:
```html
```
### Code
Add the sortable module as a dependency to your application module:
```js
var myAppModule = angular.module('MyApp', ['ui.tree'])
```
Injecting `ui.tree`, `ui-tree-nodes`, `ui-tree-node`, `ui-tree-handle` to your html.
#### HTML View or Templates
```html
-
```
**Developing Notes:**
- Adding `ui-tree` to your root element of the tree.
- Adding `ui-tree-nodes` to the elements which contain the nodes. `ng-model` is required, and it should be an array, so that the directive knows which model to bind and update.
- Adding `ui-tree-node` to your node element, it always follows the `ng-repeat` attribute.
- Adding `ui-tree-handle` to the element used to drag the object.
- All `ui-tree`, `ui-tree-nodes`, `ng-model`, `ui-tree-node` are necessary. And they can be nested.
- If you don't add a `ui-tree-handle` for a node, the entire node can be dragged.
**Styling Notes:**
- While an element is being dragged, it is temporarily removed from the DOM and injected just before closing `` tag. When dropped, it returns to it's original place in the DOM's hierarchy.
- The dragged element `ui-tree-node`, together with its parent `ui-tree-nodes`, are the only ones being injected. hence any styling that relies on a 'higher' parent, will not apply.
- To target the dragged element use the class `angular-ui-tree-drag`, which is added to the `ui-tree-nodes` element.
- While a node is being dragged, a new empty node is added into the tree to act as a placeholder. this node will have the class 'angular-ui-tree-placeholder'.
#### Unlimited nesting HTML View or Templates Example
```html
```
## Structure of angular-ui-tree
ui-tree --> Root of tree
ui-tree-nodes --> Container of nodes
ui-tree-node --> One of the node of a tree
ui-tree-handle --> Handle
ui-tree-nodes --> Container of child-nodes
ui-tree-node --> Child node
ui-tree-handle --> Handle
ui-tree-node --> Child node
ui-tree-node --> Another node
ui-tree-handle --> Handle
## Migrate From v1.x to v2.0
[Migrate From v1.x to v2.0](https://github.com/angular-ui-tree/angular-ui-tree/wiki/Migrate-From-v1.x-to-v2.0)
## API
### ui-tree
`ui-tree` is the root scope for a tree
#### Attributes
##### data-nodrop-enabled
Prevent dropping of nodes into this tree. This applies to both nodes dragged within this tree and nodes from a connected tree.
Adding this attribute to the `ui-tree` effectively makes the tree a drag source only.
To prevent a particular node from accepting children, add the attribute to the `ui-tree-nodes` element instead (see below).
See the [demo page](http://angular-ui-tree.github.io/angular-ui-tree/#/nodrop) for examples.
- `false` (default): turn off
- `true`: turn on no drop
##### data-dropzone-enabled
Turn on a dropzone that is always visible, even when tree is not empty.
- `false` (default): turn off
- `true`: turn on dropzone
##### data-clone-enabled
Turn on cloning of nodes. This will clone the source node to the destination when dragging between 2 trees.
- `false` (default): turn off clone
- `true`: turn on clone
##### data-drag-enabled
Turn on dragging and dropping of nodes.
- `true` (default): allow drag and drop
- `false`: turn off drag and drop
##### data-max-depth
Number of levels a nodes can be nested (default 0). 0 means no limit.
**Note**
If you write your own [$callbacks.accept](#accept) method, you have to check `data-max-depth` by yourself.
##### data-drag-delay
Number of milliseconds a click must be held to start a drag. (default 0)
##### data-empty-placeholder-enabled
If a tree is empty, there will be an empty placeholder which is used to drop node from other trees by default.
- `true` (default): display an empty placeholder if the tree is empty
- `false`: do not display an empty placeholder
##### Example
- turn on/off drag and drop.
- Limit depth to 5
- 500 milliseconds delay
```html
```
#### Events
`angular-ui-tree:collapse-all`
Collapse all it's child nodes.
`angular-ui-tree:expand-all`
Expand all it's child nodes.
#### Methods of scope
##### $callbacks (type: Object)
`$callbacks` is a very important property for `angular-ui-tree`.
When some special events trigger, the functions in `$callbacks` are called.
The callbacks can be passed through the directive.
Example:
```js
myAppModule.controller('MyController', function($scope) {
$scope.treeOptions = {
accept: function(sourceNodeScope, destNodesScope, destIndex) {
return true;
},
};
});
```
```html
```
#### Methods in $callbacks
#####
accept(sourceNodeScope, destNodesScope, destIndex)
Check if the current dragging node can be dropped in the `ui-tree-nodes`.
**Parameters:**
- `sourceNodeScope`: The scope of source node which is dragging.
- `destNodesScope`: The scope of `ui-tree-nodes` which you want to drop in.
- `destIndex`: The position you want to drop in.
**Return**
If the nodes accept the current dragging node.
- `true` Allow it to drop.
- `false` Not allow.
#####
beforeDrag(sourceNodeScope)
Check if the current selected node can be dragged.
**Parameters:**
- `sourceNodeScope`: The scope of source node which is selected.
**Return**
If current node is draggable.
- `true` Allow it to drag.
- `false` Not allow.
#####
removed(node)
If a node is removed, the `removed` callback will be called.
**Parameters:**
- `node`: The node that was removed
#####
dropped(event)
If a node moves it's position after dropped, the `nodeDropped` callback will be called.
**Parameters:**
-
`event`: Event arguments, it's an object.
* `source`: Source object
+ `nodeScope`: The scope of source node which was dragged.
+ `nodesScope`: The scope of the parent nodes of source node when it began to drag.
+ `index`: The position when it began to drag.
+ `cloneModel`: Given data-clone-enabled is true, holds the model of the cloned node that is to be inserted, this can be edited before drop without affecting the source node.
* `dest`: Destination object
+ `nodesScope`: The scope of `ui-tree-nodes` which you just dropped in.
+ `index`: The position you dropped in.
* `elements`: The dragging relative elements.
+ `placeholder`: The placeholder element.
+ `dragging`: The dragging element.
* `pos`: Position object.
To change the node being dropped before
#####
dragStart(event)
The `dragStart` function is called when the user starts to drag the node.
**Parameters:**
Same as [Parameters](#eventParam) of dropped.
##### dragMove(event)
The `dragMove` function is called when the user moves the node.
**Parameters:**
Same as [Parameters](#eventParam) of dropped.
##### dragStop(event)
The `dragStop` function is called when the user stop dragging the node.
**Parameters:**
Same as [Parameters](#eventParam) of dropped.
##### beforeDrop(event)
The `beforeDrop` function is called before the dragging node is dropped. If you implement this callback, the return value determines whether the drop event is allowed to proceed.
**Parameters:**
Same as [Parameters](#eventParam) of dropped.
**Callback Return Values**
- **Resolved Promise** or **truthy**: Allow the node to be dropped
- **Rejected Promise** or **false**: Disallow the node drop and return the dragged node to its original position
##### toggle(collapsed, sourceNodeScope)
The `toggle` function is called after the node is toggled
**Parameters:**
- `collapsed`: Boolean value with state of the node.
- `sourceNodeScope`: The scope of source node which is toggled.
### ui-tree-nodes
`ui-tree-nodes` is the container of nodes.
Every `ui-tree-node` should have a `ui-tree-nodes` as it's container, a `ui-tree-nodes` can have multiple child nodes.
#### Attributes
##### data-nodrop-enabled
Prevent nodes from being dropped into this node container.
This prevents nodes from being dropped directly into the container with the attribute but not into children that contain additional containers.
See the [demo page](http://angular-ui-tree.github.io/angular-ui-tree/#/nodrop) for examples.
##### data-max-depth
Number of levels a nodes can be nested (default 0). 0 means no limit. It can override the `data-max-depth` in `ui-tree`.
**Note**
If you write your own [$callbacks.accept](#accept) method, you have to check `data-nodrop-enabled` and `data-max-depth` by yourself.
Example: turn off drop.
```html
- {{node.title}}
```
#### Properties of scope
##### $element (type: AngularElement)
The html element which bind with the `ui-tree-nodes` scope.
##### $modelValue (type: Object)
The data which bind with the scope.
##### $nodes (type: Array)
All it's child nodes. The type of child node is scope of `ui-tree-node`.
##### $nodeScope (type: Scope of ui-tree-node)
The scope of node which current `ui-tree-nodes` belongs to.
For example:
ui-tree-nodes --> nodes 1
ui-tree-node --> node 1.1
ui-tree-nodes --> nodes 1.1
ui-tree-node --> node 1.1.1
ui-tree-node --> node 1.1.2
ui-tree-node --> node 1.2