Skip to content

Commit 5e9ba14

Browse files
committed
Updated docs
1 parent 70e3efd commit 5e9ba14

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

doc/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,11 @@ <h2 id="a-full-featured-tree-component-for-angular-2-and-above-including-4-">A f
8989
</ul>
9090
<h2 id="angular-supported-version">Angular supported version</h2>
9191
<p>angular-tree-component supports angular 2.X.X releases, 4.X.X releases, and AoT compilation.</p>
92-
<h2 id="getting-started-demo-full-documentation">Getting started, demo &amp; full documentation</h2>
92+
<h2 id="getting-started">Getting started</h2>
9393
<p>Please refer to the full documentation:<br><a href="https://angular2-tree.readme.io/docs">https://angular2-tree.readme.io/docs</a></p>
94+
<h2 id="demo">Demo</h2>
95+
<p>You can find working demos inside the docs:
96+
<a href="https://angular2-tree.readme.io/docs">https://angular2-tree.readme.io/docs</a></p>
9497
<h2 id="call-for-styles">Call for styles</h2>
9598
<p>Hello users &amp; contributors of the tree.</p>
9699
<p>We&#39;re looking for nice example themes for the tree.

doc/interfaces/_api_.itreemodel.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -743,15 +743,24 @@ <h4 class="tsd-parameters-title">Parameters</h4>
743743
<ul class="tsd-parameters">
744744
<li>
745745
<h5>node: <a href="_api_.itreenode.html" class="tsd-signature-type">ITreeNode</a></h5>
746+
<div class="tsd-comment tsd-typography">
747+
<p>describes which node needs to be moved</p>
748+
</div>
746749
</li>
747750
<li>
748751
<h5>to: <span class="tsd-signature-type">object</span></h5>
752+
<div class="tsd-comment tsd-typography">
753+
<p>describes where to move the node to. Contains a &#39;parent&#39; node, an &#39;index&#39;, and a &#39;dropOnNode&#39; - to distinguish between dropping between nodes or on the node</p>
754+
</div>
749755
<ul class="tsd-parameters">
756+
<li class="tsd-parameter">
757+
<h5>drop<wbr>OnNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
758+
</li>
750759
<li class="tsd-parameter">
751760
<h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
752761
</li>
753762
<li class="tsd-parameter">
754-
<h5>node<span class="tsd-signature-symbol">: </span><a href="_api_.itreenode.html" class="tsd-signature-type">ITreeNode</a></h5>
763+
<h5>parent<span class="tsd-signature-symbol">: </span><a href="_api_.itreenode.html" class="tsd-signature-type">ITreeNode</a></h5>
755764
</li>
756765
</ul>
757766
</li>

lib/defs/api.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -524,10 +524,10 @@ export interface ITreeModel {
524524
clearFilter();
525525
/**
526526
* moves a node from one location in the tree to another
527-
* @param location has a from and a to attributes, each has a node and index attributes.
528-
The combination of node + index tells which node needs to be moved, and to where
527+
* @param node describes which node needs to be moved
528+
* @param to describes where to move the node to. Contains a 'parent' node, an 'index', and a 'dropOnNode' - to distinguish between dropping between nodes or on the node
529529
*/
530-
moveNode(node: ITreeNode, to: {node: ITreeNode, index: number});
530+
moveNode(node: ITreeNode, to: {parent: ITreeNode, index: number, dropOnNode: boolean});
531531
/**
532532
* Invokes a method for every node of the tree - depth first
533533
* @param fn a function that receives the node

0 commit comments

Comments
 (0)