Skip to content

Commit 1156fe8

Browse files
jvanbrueggejvanbruegge
committed
Update documentation
1 parent 4f6d899 commit 1156fe8

17 files changed

+30904
-49446
lines changed

‎docs/assets/js/main.js‎

Lines changed: 5 additions & 9523 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/search.js‎

Lines changed: 2 additions & 387 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/horizontal/index.js‎

Lines changed: 30294 additions & 39160 deletions
Large diffs are not rendered by default.

‎docs/horizontal/src/index.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ function userSelectDriver(sort$): void {
3939
}
4040

4141
function main(sources: Sources): Sinks {
42-
const sinks = makeSortable(Child, {
42+
const sinks: any = makeSortable(Child, {
4343
itemSelector: 'ul > li'
4444
})(sources);
4545

4646
return {
47-
drag: sinks.drag,
47+
drag: sinks.dragging,
4848
DOM: sinks.DOM.map(dom =>
4949
div([h3('Horizontal too!'), p('this is running with RxJS'), dom])
5050
)

‎docs/interfaces/_makesortable_.sortableoptions.html‎

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ <h2>Index</h2>
8585
<h3>Properties</h3>
8686
<ul class="tsd-index-list">
8787
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_makesortable_.sortableoptions.html#domdriverkey" class="tsd-kind-icon">DOMDriver<wbr>Key</a></li>
88-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_makesortable_.sortableoptions.html#timedriverkey" class="tsd-kind-icon">Time<wbr>Driver<wbr>Key</a></li>
8988
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_makesortable_.sortableoptions.html#handle" class="tsd-kind-icon">handle</a></li>
9089
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_makesortable_.sortableoptions.html#itemselector" class="tsd-kind-icon">item<wbr>Selector</a></li>
9190
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_makesortable_.sortableoptions.html#selectiondelay" class="tsd-kind-icon">selection<wbr>Delay</a></li>
@@ -102,17 +101,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> DOMDriver<wbr>Key</h3
102101
<div class="tsd-signature tsd-kind-icon">DOMDriver<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103102
<aside class="tsd-sources">
104103
<ul>
105-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L19">makeSortable.ts:19</a></li>
106-
</ul>
107-
</aside>
108-
</section>
109-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
110-
<a name="timedriverkey" class="tsd-anchor"></a>
111-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Time<wbr>Driver<wbr>Key</h3>
112-
<div class="tsd-signature tsd-kind-icon">Time<wbr>Driver<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113-
<aside class="tsd-sources">
114-
<ul>
115-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L20">makeSortable.ts:20</a></li>
104+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L19">makeSortable.ts:19</a></li>
116105
</ul>
117106
</aside>
118107
</section>
@@ -122,7 +111,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> handle</h3>
122111
<div class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
123112
<aside class="tsd-sources">
124113
<ul>
125-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L18">makeSortable.ts:18</a></li>
114+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L18">makeSortable.ts:18</a></li>
126115
</ul>
127116
</aside>
128117
</section>
@@ -132,7 +121,7 @@ <h3>item<wbr>Selector</h3>
132121
<div class="tsd-signature tsd-kind-icon">item<wbr>Selector<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133122
<aside class="tsd-sources">
134123
<ul>
135-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L17">makeSortable.ts:17</a></li>
124+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L17">makeSortable.ts:17</a></li>
136125
</ul>
137126
</aside>
138127
</section>
@@ -142,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> selection<wbr>Delay</
142131
<div class="tsd-signature tsd-kind-icon">selection<wbr>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
143132
<aside class="tsd-sources">
144133
<ul>
145-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L21">makeSortable.ts:21</a></li>
134+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L20">makeSortable.ts:20</a></li>
146135
</ul>
147136
</aside>
148137
</section>
@@ -184,9 +173,6 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> selection<wbr>Delay</
184173
<li class=" tsd-kind-property tsd-parent-kind-interface">
185174
<a href="_makesortable_.sortableoptions.html#domdriverkey" class="tsd-kind-icon">DOMDriver<wbr>Key</a>
186175
</li>
187-
<li class=" tsd-kind-property tsd-parent-kind-interface">
188-
<a href="_makesortable_.sortableoptions.html#timedriverkey" class="tsd-kind-icon">Time<wbr>Driver<wbr>Key</a>
189-
</li>
190176
<li class=" tsd-kind-property tsd-parent-kind-interface">
191177
<a href="_makesortable_.sortableoptions.html#handle" class="tsd-kind-icon">handle</a>
192178
</li>

‎docs/interfaces/_makesortable_.sortablesinks.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>dragging</h3>
100100
<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>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L31">makeSortable.ts:31</a></li>
103+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L30">makeSortable.ts:30</a></li>
104104
</ul>
105105
</aside>
106106
</section>
@@ -110,7 +110,7 @@ <h3>update<wbr>Done</h3>
110110
<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>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L33">makeSortable.ts:33</a></li>
113+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L32">makeSortable.ts:32</a></li>
114114
</ul>
115115
</aside>
116116
</section>
@@ -120,7 +120,7 @@ <h3>update<wbr>Live</h3>
120120
<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>
121121
<aside class="tsd-sources">
122122
<ul>
123-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L32">makeSortable.ts:32</a></li>
123+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L31">makeSortable.ts:31</a></li>
124124
</ul>
125125
</aside>
126126
</section>

‎docs/interfaces/_makesortable_.updateorder.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>index<wbr>Map</h3>
100100
<div class="tsd-signature tsd-kind-icon">index<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L25">makeSortable.ts:25</a></li>
103+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L24">makeSortable.ts:24</a></li>
104104
</ul>
105105
</aside>
106106
<div class="tsd-type-declaration">
@@ -118,7 +118,7 @@ <h3>new<wbr>Index</h3>
118118
<div class="tsd-signature tsd-kind-icon">new<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L27">makeSortable.ts:27</a></li>
121+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L26">makeSortable.ts:26</a></li>
122122
</ul>
123123
</aside>
124124
</section>
@@ -128,7 +128,7 @@ <h3>old<wbr>Index</h3>
128128
<div class="tsd-signature tsd-kind-icon">old<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
129129
<aside class="tsd-sources">
130130
<ul>
131-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/makeSortable.ts#L26">makeSortable.ts:26</a></li>
131+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/makeSortable.ts#L25">makeSortable.ts:25</a></li>
132132
</ul>
133133
</aside>
134134
</section>

‎docs/modules/_eventhandler_.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h3>handle<wbr>Event</h3>
9191
<li class="tsd-description">
9292
<aside class="tsd-sources">
9393
<ul>
94-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandler.ts#L9">eventHandler.ts:9</a></li>
94+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/4f6d899/src/eventHandler.ts#L9">eventHandler.ts:9</a></li>
9595
</ul>
9696
</aside>
9797
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/modules/_eventhandlers_mousedown_.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> select<wbr>Names</h3>
9696
<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>
9797
<aside class="tsd-sources">
9898
<ul>
99-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousedown.ts#L6">eventHandlers/mousedown.ts:6</a></li>
99+
<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>
100100
</ul>
101101
</aside>
102102
</section>
@@ -113,7 +113,7 @@ <h3>add<wbr>Data</h3>
113113
<li class="tsd-description">
114114
<aside class="tsd-sources">
115115
<ul>
116-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousedown.ts#L46">eventHandlers/mousedown.ts:46</a></li>
116+
<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>
117117
</ul>
118118
</aside>
119119
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -139,7 +139,7 @@ <h3>create<wbr>Ghost</h3>
139139
<li class="tsd-description">
140140
<aside class="tsd-sources">
141141
<ul>
142-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousedown.ts#L62">eventHandlers/mousedown.ts:62</a></li>
142+
<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>
143143
</ul>
144144
</aside>
145145
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -171,7 +171,7 @@ <h3>hide<wbr>Selected</h3>
171171
<li class="tsd-description">
172172
<aside class="tsd-sources">
173173
<ul>
174-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousedown.ts#L52">eventHandlers/mousedown.ts:52</a></li>
174+
<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>
175175
</ul>
176176
</aside>
177177
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -215,7 +215,7 @@ <h3>mousedown<wbr>Handler</h3>
215215
<li class="tsd-description">
216216
<aside class="tsd-sources">
217217
<ul>
218-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousedown.ts#L15">eventHandlers/mousedown.ts:15</a></li>
218+
<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>
219219
</ul>
220220
</aside>
221221
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/modules/_eventhandlers_mousemove_.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3>get<wbr>Area</h3>
9595
<li class="tsd-description">
9696
<aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousemove.ts#L60">eventHandlers/mousemove.ts:60</a></li>
98+
<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>
9999
</ul>
100100
</aside>
101101
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -118,7 +118,7 @@ <h3>get<wbr>Intersection</h3>
118118
<li class="tsd-description">
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousemove.ts#L75">eventHandlers/mousemove.ts:75</a></li>
121+
<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>
122122
</ul>
123123
</aside>
124124
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +147,7 @@ <h3>get<wbr>Intersection<wbr>Area</h3>
147147
<li class="tsd-description">
148148
<aside class="tsd-sources">
149149
<ul>
150-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousemove.ts#L65">eventHandlers/mousemove.ts:65</a></li>
150+
<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>
151151
</ul>
152152
</aside>
153153
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -173,7 +173,7 @@ <h3>mousemove<wbr>Handler</h3>
173173
<li class="tsd-description">
174174
<aside class="tsd-sources">
175175
<ul>
176-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousemove.ts#L6">eventHandlers/mousemove.ts:6</a></li>
176+
<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>
177177
</ul>
178178
</aside>
179179
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -202,7 +202,7 @@ <h3>update<wbr>Ghost</h3>
202202
<li class="tsd-description">
203203
<aside class="tsd-sources">
204204
<ul>
205-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/ae63c12/src/eventHandlers/mousemove.ts#L104">eventHandlers/mousemove.ts:104</a></li>
205+
<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>
206206
</ul>
207207
</aside>
208208
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)