Skip to content

Commit ad01620

Browse files
jvanbrueggejvanbruegge
committed
Add hosted examples to README
fixes #10
1 parent e418654 commit ad01620

25 files changed

+1491
-50
lines changed

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Full documentation: https://cyclejs-community.github.io/cyclejs-sortable/
77

88
NPM: https://www.npmjs.com/package/cyclejs-sortable
99

10+
## Examples
11+
12+
You can check out live versions of the [examples](./examples/) here:
13+
- [simple](./examples/simple/src/index.ts): https://cyclejs-community.github.io/cyclejs-sortable/simple/
14+
- [horizontal](./examples/horizontal/src/index.ts): https://cyclejs-community.github.io/cyclejs-sortable/horizontal/
15+
- [parentSelector](./examples/parentSelector/src/index.ts): https://cyclejs-community.github.io/cyclejs-sortable/parentSelector/
16+
- [updateEvent](./examples/updateEvent/src/index.ts): https://cyclejs-community.github.io/cyclejs-sortable/updateEvent/
17+
1018
## Required Polyfills
1119
The code uses a few ES6 features, so you might need an es6 polyfill like `babel-polyfill`
1220

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/globals.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ <h2>Index</h2>
7070
<section class="tsd-index-section ">
7171
<h3>External modules</h3>
7272
<ul class="tsd-index-list">
73+
<li class="tsd-kind-external-module"><a href="modules/_docs_horizontal_src_index_.html" class="tsd-kind-icon">"docs/horizontal/src/index"</a></li>
74+
<li class="tsd-kind-external-module"><a href="modules/_docs_parentselector_src_index_.html" class="tsd-kind-icon">"docs/parent<wbr>Selector/src/index"</a></li>
75+
<li class="tsd-kind-external-module"><a href="modules/_docs_simple_src_index_.html" class="tsd-kind-icon">"docs/simple/src/index"</a></li>
76+
<li class="tsd-kind-external-module"><a href="modules/_docs_updateevent_src_index_.html" class="tsd-kind-icon">"docs/update<wbr>Event/src/index"</a></li>
7377
<li class="tsd-kind-external-module"><a href="modules/_examples_horizontal_src_index_.html" class="tsd-kind-icon">"examples/horizontal/src/index"</a></li>
7478
<li class="tsd-kind-external-module"><a href="modules/_examples_parentselector_src_index_.html" class="tsd-kind-icon">"examples/parent<wbr>Selector/src/index"</a></li>
7579
<li class="tsd-kind-external-module"><a href="modules/_examples_simple_src_index_.html" class="tsd-kind-icon">"examples/simple/src/index"</a></li>
@@ -94,6 +98,18 @@ <h3>External modules</h3>
9498
<li class="globals current ">
9599
<a href="globals.html"><em>Globals</em></a>
96100
</li>
101+
<li class=" tsd-kind-external-module">
102+
<a href="modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
103+
</li>
104+
<li class=" tsd-kind-external-module">
105+
<a href="modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
106+
</li>
107+
<li class=" tsd-kind-external-module">
108+
<a href="modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
109+
</li>
110+
<li class=" tsd-kind-external-module">
111+
<a href="modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
112+
</li>
97113
<li class=" tsd-kind-external-module">
98114
<a href="modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
99115
</li>

‎docs/index.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,15 @@ <h1 id="cyclejs-sortable">cyclejs-sortable</h1>
6969
<p>Github Repo: <a href="https://github.com/cyclejs-community/cyclejs-sortable">https://github.com/cyclejs-community/cyclejs-sortable</a></p>
7070
<p>Full documentation: <a href="https://cyclejs-community.github.io/cyclejs-sortable/">https://cyclejs-community.github.io/cyclejs-sortable/</a></p>
7171
<p>NPM: <a href="https://www.npmjs.com/package/cyclejs-sortable">https://www.npmjs.com/package/cyclejs-sortable</a></p>
72+
<h2 id="examples">Examples</h2>
73+
<h3 id="hosted">Hosted</h3>
74+
<p>You can check out live versions of the <a href="./examples/">examples</a> here:</p>
75+
<ul>
76+
<li><a href="./examples/simple/src/index.ts">simple</a>: <a href="https://cyclejs-community.github.io/cyclejs-sortable/simple/">https://cyclejs-community.github.io/cyclejs-sortable/simple/</a></li>
77+
<li><a href="./examples/horizontal/src/index.ts">horizontal</a>: <a href="https://cyclejs-community.github.io/cyclejs-sortable/horizontal/">https://cyclejs-community.github.io/cyclejs-sortable/horizontal/</a></li>
78+
<li><a href="./examples/parentSelector/src/index.ts">parentSelector</a>: <a href="https://cyclejs-community.github.io/cyclejs-sortable/parentSelector/">https://cyclejs-community.github.io/cyclejs-sortable/parentSelector/</a></li>
79+
<li><a href="./examples/updateEvent/src/index.ts">updateEvent</a>: <a href="https://cyclejs-community.github.io/cyclejs-sortable/updateEvent/">https://cyclejs-community.github.io/cyclejs-sortable/updateEvent/</a></li>
80+
</ul>
7281
<h2 id="required-polyfills">Required Polyfills</h2>
7382
<p>The code uses a few ES6 features, so you might need an es6 polyfill like <code>babel-polyfill</code></p>
7483
<p>The use the <code>updateOrder Event</code> in IE you have to add a CustomEvent constructor polyfill like <a href="https://www.npmjs.com/package/custom-event">https://www.npmjs.com/package/custom-event</a></p>
@@ -97,6 +106,18 @@ <h2 id="basic-usage">Basic Usage</h2>
97106
<li class="globals ">
98107
<a href="globals.html"><em>Globals</em></a>
99108
</li>
109+
<li class=" tsd-kind-external-module">
110+
<a href="modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
111+
</li>
112+
<li class=" tsd-kind-external-module">
113+
<a href="modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
114+
</li>
115+
<li class=" tsd-kind-external-module">
116+
<a href="modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
117+
</li>
118+
<li class=" tsd-kind-external-module">
119+
<a href="modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
120+
</li>
100121
<li class=" tsd-kind-external-module">
101122
<a href="modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
102123
</li>

‎docs/interfaces/_src_definitions_.eventdetails.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>new<wbr>Index</h3>
112112
<div class="tsd-signature tsd-kind-icon">new<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L53">src/definitions.ts:53</a></li>
115+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L53">src/definitions.ts:53</a></li>
116116
</ul>
117117
</aside>
118118
</section>
@@ -122,7 +122,7 @@ <h3>new<wbr>Order</h3>
122122
<div class="tsd-signature tsd-kind-icon">new<wbr>Order<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L51">src/definitions.ts:51</a></li>
125+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L51">src/definitions.ts:51</a></li>
126126
</ul>
127127
</aside>
128128
</section>
@@ -132,7 +132,7 @@ <h3>old<wbr>Index</h3>
132132
<div class="tsd-signature tsd-kind-icon">old<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
133133
<aside class="tsd-sources">
134134
<ul>
135-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L52">src/definitions.ts:52</a></li>
135+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L52">src/definitions.ts:52</a></li>
136136
</ul>
137137
</aside>
138138
</section>
@@ -144,6 +144,18 @@ <h3>old<wbr>Index</h3>
144144
<li class="globals ">
145145
<a href="../globals.html"><em>Globals</em></a>
146146
</li>
147+
<li class=" tsd-kind-external-module">
148+
<a href="../modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
149+
</li>
150+
<li class=" tsd-kind-external-module">
151+
<a href="../modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
152+
</li>
153+
<li class=" tsd-kind-external-module">
154+
<a href="../modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
155+
</li>
156+
<li class=" tsd-kind-external-module">
157+
<a href="../modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
158+
</li>
147159
<li class=" tsd-kind-external-module">
148160
<a href="../modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
149161
</li>

‎docs/interfaces/_src_definitions_.intersection.html‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3>xmax</h3>
101101
<div class="tsd-signature tsd-kind-icon">xmax<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
102102
<aside class="tsd-sources">
103103
<ul>
104-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L66">src/definitions.ts:66</a></li>
104+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L66">src/definitions.ts:66</a></li>
105105
</ul>
106106
</aside>
107107
</section>
@@ -111,7 +111,7 @@ <h3>xmin</h3>
111111
<div class="tsd-signature tsd-kind-icon">xmin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
112112
<aside class="tsd-sources">
113113
<ul>
114-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L64">src/definitions.ts:64</a></li>
114+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L64">src/definitions.ts:64</a></li>
115115
</ul>
116116
</aside>
117117
</section>
@@ -121,7 +121,7 @@ <h3>ymax</h3>
121121
<div class="tsd-signature tsd-kind-icon">ymax<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L67">src/definitions.ts:67</a></li>
124+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L67">src/definitions.ts:67</a></li>
125125
</ul>
126126
</aside>
127127
</section>
@@ -131,7 +131,7 @@ <h3>ymin</h3>
131131
<div class="tsd-signature tsd-kind-icon">ymin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
132132
<aside class="tsd-sources">
133133
<ul>
134-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L65">src/definitions.ts:65</a></li>
134+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L65">src/definitions.ts:65</a></li>
135135
</ul>
136136
</aside>
137137
</section>
@@ -143,6 +143,18 @@ <h3>ymin</h3>
143143
<li class="globals ">
144144
<a href="../globals.html"><em>Globals</em></a>
145145
</li>
146+
<li class=" tsd-kind-external-module">
147+
<a href="../modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
148+
</li>
149+
<li class=" tsd-kind-external-module">
150+
<a href="../modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
151+
</li>
152+
<li class=" tsd-kind-external-module">
153+
<a href="../modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
154+
</li>
155+
<li class=" tsd-kind-external-module">
156+
<a href="../modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
157+
</li>
146158
<li class=" tsd-kind-external-module">
147159
<a href="../modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
148160
</li>

‎docs/interfaces/_src_definitions_.itemdimensions.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>height</h3>
9999
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L59">src/definitions.ts:59</a></li>
102+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L59">src/definitions.ts:59</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>width</h3>
109109
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L58">src/definitions.ts:58</a></li>
112+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L58">src/definitions.ts:58</a></li>
113113
</ul>
114114
</aside>
115115
</section>
@@ -121,6 +121,18 @@ <h3>width</h3>
121121
<li class="globals ">
122122
<a href="../globals.html"><em>Globals</em></a>
123123
</li>
124+
<li class=" tsd-kind-external-module">
125+
<a href="../modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
126+
</li>
127+
<li class=" tsd-kind-external-module">
128+
<a href="../modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
129+
</li>
130+
<li class=" tsd-kind-external-module">
131+
<a href="../modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
132+
</li>
133+
<li class=" tsd-kind-external-module">
134+
<a href="../modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
135+
</li>
124136
<li class=" tsd-kind-external-module">
125137
<a href="../modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
126138
</li>

‎docs/interfaces/_src_definitions_.mouseoffset.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>x</h3>
112112
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L41">src/definitions.ts:41</a></li>
115+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L41">src/definitions.ts:41</a></li>
116116
</ul>
117117
</aside>
118118
</section>
@@ -122,7 +122,7 @@ <h3>y</h3>
122122
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L42">src/definitions.ts:42</a></li>
125+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L42">src/definitions.ts:42</a></li>
126126
</ul>
127127
</aside>
128128
</section>
@@ -134,6 +134,18 @@ <h3>y</h3>
134134
<li class="globals ">
135135
<a href="../globals.html"><em>Globals</em></a>
136136
</li>
137+
<li class=" tsd-kind-external-module">
138+
<a href="../modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
139+
</li>
140+
<li class=" tsd-kind-external-module">
141+
<a href="../modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
142+
</li>
143+
<li class=" tsd-kind-external-module">
144+
<a href="../modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
145+
</li>
146+
<li class=" tsd-kind-external-module">
147+
<a href="../modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
148+
</li>
137149
<li class=" tsd-kind-external-module">
138150
<a href="../modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
139151
</li>

‎docs/interfaces/_src_definitions_.sortableoptions.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ghost<wbr>Class</h3>
100100
<div class="tsd-signature tsd-kind-icon">ghost<wbr>Class<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L31">src/definitions.ts:31</a></li>
103+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L31">src/definitions.ts:31</a></li>
104104
</ul>
105105
</aside>
106106
<div class="tsd-comment tsd-typography">
@@ -124,7 +124,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> handle</h3>
124124
<div class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125125
<aside class="tsd-sources">
126126
<ul>
127-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L23">src/definitions.ts:23</a></li>
127+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L23">src/definitions.ts:23</a></li>
128128
</ul>
129129
</aside>
130130
<div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> parent<wbr>Selector</
148148
<div class="tsd-signature tsd-kind-icon">parent<wbr>Selector<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149149
<aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/583e161/src/definitions.ts#L15">src/definitions.ts:15</a></li>
151+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-sortable/blob/521a182/src/definitions.ts#L15">src/definitions.ts:15</a></li>
152152
</ul>
153153
</aside>
154154
<div class="tsd-comment tsd-typography">
@@ -175,6 +175,18 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> parent<wbr>Selector</
175175
<li class="globals ">
176176
<a href="../globals.html"><em>Globals</em></a>
177177
</li>
178+
<li class=" tsd-kind-external-module">
179+
<a href="../modules/_docs_horizontal_src_index_.html">"docs/horizontal/src/index"</a>
180+
</li>
181+
<li class=" tsd-kind-external-module">
182+
<a href="../modules/_docs_parentselector_src_index_.html">"docs/parent<wbr>Selector/src/index"</a>
183+
</li>
184+
<li class=" tsd-kind-external-module">
185+
<a href="../modules/_docs_simple_src_index_.html">"docs/simple/src/index"</a>
186+
</li>
187+
<li class=" tsd-kind-external-module">
188+
<a href="../modules/_docs_updateevent_src_index_.html">"docs/update<wbr>Event/src/index"</a>
189+
</li>
178190
<li class=" tsd-kind-external-module">
179191
<a href="../modules/_examples_horizontal_src_index_.html">"examples/horizontal/src/index"</a>
180192
</li>

0 commit comments

Comments
 (0)