Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jvanbruegge committed Jun 21, 2018
1 parent 8fe9146 commit 05df994
Show file tree
Hide file tree
Showing 12 changed files with 15,183 additions and 19,127 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/interfaces/_makesortable_.sortableoptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> DOMDriver<wbr>Key</h3
<div class="tsd-signature tsd-kind-icon">DOMDriver<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L19">makeSortable.ts:19</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L19">makeSortable.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> handle</h3>
<div class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L18">makeSortable.ts:18</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L18">makeSortable.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -121,7 +121,7 @@ <h3>item<wbr>Selector</h3>
<div class="tsd-signature tsd-kind-icon">item<wbr>Selector<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L17">makeSortable.ts:17</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L17">makeSortable.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> selection<wbr>Delay</
<div class="tsd-signature tsd-kind-icon">selection<wbr>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L20">makeSortable.ts:20</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L20">makeSortable.ts:20</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/_makesortable_.sortablesinks.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>dragging</h3>
<div class="tsd-signature tsd-kind-icon">dragging<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L30">makeSortable.ts:30</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L30">makeSortable.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,7 +110,7 @@ <h3>update<wbr>Done</h3>
<div class="tsd-signature tsd-kind-icon">update<wbr>Done<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol">&lt;</span><a href="_makesortable_.updateorder.html" class="tsd-signature-type">UpdateOrder</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L32">makeSortable.ts:32</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L32">makeSortable.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -120,7 +120,7 @@ <h3>update<wbr>Live</h3>
<div class="tsd-signature tsd-kind-icon">update<wbr>Live<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol">&lt;</span><a href="_makesortable_.updateorder.html" class="tsd-signature-type">UpdateOrder</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L31">makeSortable.ts:31</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L31">makeSortable.ts:31</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/_makesortable_.updateorder.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>index<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L24">makeSortable.ts:24</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L24">makeSortable.ts:24</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -118,7 +118,7 @@ <h3>new<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">new<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L26">makeSortable.ts:26</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L26">makeSortable.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -128,7 +128,7 @@ <h3>old<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">old<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L25">makeSortable.ts:25</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/makeSortable.ts#L25">makeSortable.ts:25</a></li>
</ul>
</aside>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_eventhandler_.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h3>handle<wbr>Event</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandler.ts#L9">eventHandler.ts:9</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandler.ts#L9">eventHandler.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
40 changes: 35 additions & 5 deletions docs/modules/_eventhandlers_mousedown_.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ <h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_eventhandlers_mousedown_.html#adddata" class="tsd-kind-icon">add<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_eventhandlers_mousedown_.html#createghost" class="tsd-kind-icon">create<wbr>Ghost</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_eventhandlers_mousedown_.html#findparent" class="tsd-kind-icon">find<wbr>Parent</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_eventhandlers_mousedown_.html#hideselected" class="tsd-kind-icon">hide<wbr>Selected</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_eventhandlers_mousedown_.html#mousedownhandler" class="tsd-kind-icon">mousedown<wbr>Handler</a></li>
</ul>
Expand All @@ -96,7 +97,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> select<wbr>Names</h3>
<div class="tsd-signature tsd-kind-icon">select<wbr>Names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[&#x27;-webkit-touch-callout&#x27;,&#x27;-webkit-user-select&#x27;,&#x27;-khtml-user-select&#x27;,&#x27;-moz-user-select&#x27;,&#x27;-ms-user-select&#x27;,&#x27;user-select&#x27;]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousedown.ts#L6">eventHandlers/mousedown.ts:6</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L6">eventHandlers/mousedown.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +114,7 @@ <h3>add<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousedown.ts#L48">eventHandlers/mousedown.ts:48</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L59">eventHandlers/mousedown.ts:59</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -139,7 +140,7 @@ <h3>create<wbr>Ghost</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousedown.ts#L64">eventHandlers/mousedown.ts:64</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L75">eventHandlers/mousedown.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -161,6 +162,32 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">VNode</sp
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="findparent" class="tsd-anchor"></a>
<h3>find<wbr>Parent</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">find<wbr>Parent<span class="tsd-signature-symbol">(</span>el<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, sel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L15">eventHandlers/mousedown.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>el: <span class="tsd-signature-type">Element</span></h5>
</li>
<li>
<h5>sel: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="hideselected" class="tsd-anchor"></a>
<h3>hide<wbr>Selected</h3>
Expand All @@ -171,7 +198,7 @@ <h3>hide<wbr>Selected</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousedown.ts#L54">eventHandlers/mousedown.ts:54</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L65">eventHandlers/mousedown.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -215,7 +242,7 @@ <h3>mousedown<wbr>Handler</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousedown.ts#L15">eventHandlers/mousedown.ts:15</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousedown.ts#L26">eventHandlers/mousedown.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -273,6 +300,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_eventhandlers_mousedown_.html#createghost" class="tsd-kind-icon">create<wbr>Ghost</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_eventhandlers_mousedown_.html#findparent" class="tsd-kind-icon">find<wbr>Parent</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_eventhandlers_mousedown_.html#hideselected" class="tsd-kind-icon">hide<wbr>Selected</a>
</li>
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/_eventhandlers_mousemove_.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h3>get<wbr>Area</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousemove.ts#L60">eventHandlers/mousemove.ts:60</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousemove.ts#L60">eventHandlers/mousemove.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -118,7 +118,7 @@ <h3>get<wbr>Intersection</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousemove.ts#L75">eventHandlers/mousemove.ts:75</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousemove.ts#L75">eventHandlers/mousemove.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -147,7 +147,7 @@ <h3>get<wbr>Intersection<wbr>Area</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousemove.ts#L65">eventHandlers/mousemove.ts:65</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousemove.ts#L65">eventHandlers/mousemove.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -173,7 +173,7 @@ <h3>mousemove<wbr>Handler</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousemove.ts#L6">eventHandlers/mousemove.ts:6</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousemove.ts#L6">eventHandlers/mousemove.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -202,7 +202,7 @@ <h3>update<wbr>Ghost</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mousemove.ts#L104">eventHandlers/mousemove.ts:104</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mousemove.ts#L104">eventHandlers/mousemove.ts:104</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/_eventhandlers_mouseup_.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h3>cleanup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mouseup.ts#L28">eventHandlers/mouseup.ts:28</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mouseup.ts#L28">eventHandlers/mouseup.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -116,7 +116,7 @@ <h3>delete<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mouseup.ts#L38">eventHandlers/mouseup.ts:38</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mouseup.ts#L38">eventHandlers/mouseup.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -148,7 +148,7 @@ <h3>mouseup<wbr>Handler</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandlers/mouseup.ts#L7">eventHandlers/mouseup.ts:7</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/eventHandlers/mouseup.ts#L7">eventHandlers/mouseup.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/_helpers_.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>add<wbr>Data<wbr>Entry</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/helpers.ts#L13">helpers.ts:13</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/helpers.ts#L13">helpers.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -121,7 +121,7 @@ <h3>add<wbr>Keys</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/helpers.ts#L3">helpers.ts:3</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/8fe9146/src/helpers.ts#L3">helpers.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

0 comments on commit 05df994

Please sign in to comment.