Skip to content

Commit 6a2b65a

Browse files
committed
Modify README due to leaf/container modification.
1 parent 045d442 commit 6a2b65a

1 file changed

Lines changed: 26 additions & 18 deletions

File tree

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,33 @@ angular.module('myApp', ['angularTreeview']);
2222

2323
Add a tree to your application. See [Usage](#usage).
2424

25-
## Usage
25+
## Usage (modified in fork)
2626

2727
Attributes of angular treeview are below.
2828

29-
- angular-treeview: the treeview directive.
30-
- tree-id : each tree's unique id.
31-
- tree-model : the tree model on $scope.
32-
- node-id : each node's id.
33-
- node-label : each node's label.
34-
- node-children: each node's children.
29+
- angular-treeview: the treeview directive
30+
- tree-id : tree's unique id
31+
- tree-model : the tree model on $scope
32+
- node-id : each node's id
33+
- node-label : name of key determining a label
34+
- node-type : each node's type (look `type-container` and `type-leaf`)
35+
- node-type-container : name of type for nodes which are containers (has children)
36+
- node-type-leaf : name of type for nodes which don't have children
37+
- node-children: each node's children
3538

3639
Here is a simple example.
3740

3841

3942
```html
4043
<div
4144
data-angular-treeview="true"
42-
data-tree-id="abc"
43-
data-tree-model="treedata"
45+
data-tree-id="myFileList"
46+
data-tree-model="fileList"
4447
data-node-id="id"
45-
data-node-label="label"
48+
data-node-label="name"
49+
data-node-type="type"
50+
data-node-type-container="folder"
51+
data-node-type-leaf="file"
4652
data-node-children="children" >
4753
</div>
4854
```
@@ -52,20 +58,22 @@ Example model:
5258
```javascript
5359
$scope.treedata =
5460
[
55-
{ "label" : "User", "id" : "role1", "children" : [
56-
{ "label" : "subUser1", "id" : "role11", "children" : [] },
57-
{ "label" : "subUser2", "id" : "role12", "children" : [
58-
{ "label" : "subUser2-1", "id" : "role121", "children" : [
59-
{ "label" : "subUser2-1-1", "id" : "role1211", "children" : [] },
60-
{ "label" : "subUser2-1-2", "id" : "role1212", "children" : [] }
61+
{ "name": "Photos", "id": 1, "type": "folder", "children": [
62+
{ "name": "my photo.jpg", "id": 11, "type": "file", "children": [] },
63+
{ "name": "Holidays", "id": 12, "type": "folder", "children" : [
64+
{ "name": "2015 - March", "id": 121, "type": "folder", "children": [
65+
{ "name": "photo1.jpg", "id": 1211, "type": "file", "children" : [] },
66+
{ "name": "photo2.jpg", "id": 1212, "type": "file", "children": [] }
6167
]}
6268
]}
6369
]},
64-
{ "label" : "Admin", "id" : "role2", "children" : [] },
65-
{ "label" : "Guest", "id" : "role3", "children" : [] }
70+
{ "name": "Videos", "id": 2, "type": "folder", "children": [] },
71+
{ "name": "Notes", "id": 3, "type": "folder", "children": [] }
6672
];
6773
```
6874

75+
Note: unfortunately, AFAIR, even file nodes need empty `children` collection. Probably needs a fix (PRs?).
76+
6977
## Selection
7078

7179
If tree node is selected, then that selected tree node is saved to $scope."TREE ID".currentNode. By using $watch, the controller can recognize the tree selection.

0 commit comments

Comments
 (0)