aboutsummaryrefslogtreecommitdiffstats
path: root/library/jRange/demo/index.html
blob: 61966ba22041d304a0d7bfc2b1350e969509a534 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title>jRange : jQuery Range Selector</title>
	<link rel="stylesheet" href="normalize.css">
	<link rel="stylesheet" href="main.css">
	<link rel="stylesheet" href="prism/prism.css">
	<link rel="stylesheet" href="../jquery.range.css">
	<link href='http://fonts.googleapis.com/css?family=Raleway:100,300' rel='stylesheet' type='text/css'>
	<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
</head>
<body>
    <section class="pane header">
        <div class="header">
            <h1>jRange</h1>
            <h2>jQuery Plugin to create Range Selector</h2>
        </div>
        <footer>
            <div class="left">
                <a href="http://twitter.com/share" class="twitter-share-button" data-url="https://github.com/nitinhayaran/jRange" data-text="jRange - jQuery plugin for Range Selector" data-count="none" data-via="nitinhayaran">Tweet</a>
                <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
                <iframe src="http://ghbtns.com/github-btn.html?user=nitinhayaran&amp;repo=jRange&amp;type=watch&amp;count=false&amp;size=small"
                  allowtransparency="true" frameborder="0" scrolling="0" width="62" height="20"></iframe>
            </div>
            <div class="right">
                <a href="https://twitter.com/nitinhayaran" class="twitter-follow-button" data-show-count="false">Follow @nitinhayaran</a>
                <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
                <iframe src="http://ghbtns.com/github-btn.html?user=nitinhayaran&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="153" height="20"></iframe>
            </div>
        </footer>
    </section>
    <section class="body demo">
        <div class="container">
            <h2>See it in Action</h2>
            <h3>Play around with the demo</h3>
            <div class="demo-container clearfix">
            	<div class="demo-section">
            		<div class="demo-code">
            			<pre><code class="language-javascript">$('.single-slider').jRange({
    from: -2.0,
    to: 2.0,
    step: 0.5,
    scale: [-2.0,-1.0,0.0,1.0,2.0],
    format: '%s',
    width: 300,
    showLabels: true,
    snap: true
});</code></pre>
            		</div>
            		<div class="demo-output">
            			<input class="single-slider" type="hidden" value="0.0"/>
            		</div>
            	</div>
            	<div class="demo-section">
            		<div class="demo-code">
            			<pre><code class="language-javascript">$('.range-slider').jRange({
    from: 0,
    to: 100,
    step: 1,
    scale: [0,25,50,75,100],
    format: '%s',
    width: 300,
    showLabels: true,
    isRange : true
});</code></pre>
            		</div>
            		<div class="demo-output">
            			<input class="range-slider" type="hidden" value="25,75"/>
            		</div>
            	</div>


            </div>
            <div class="text-container">
                <h2>How to Use</h2>
                <h3>Lets see some code</h3>
                <p>To get started you'll have to include <code>jquery.range.js</code> and <code>jquery.range.css</code> files in your html file.</p>
                <pre><code class="language-css">&lt;link rel="stylesheet" href="jquery.range.css"&gt;
&lt;script src="jquery.range.js"&gt;&lt;/script&gt;</code></pre>
				<p>Later just add an hidden input, where ever you want this slider to be shown.</p>
				<pre><code class="language-css">&lt;input type="hidden" class="slider-input" value="23" /&gt;</code></pre>
				<p>After this you'll have to intialize this plugin for that input, as shown in the example above</p>

                <h2>Options</h2>
                <h3>See configuration options</h3>
                <p>Options can also be set programatically, by passing an options hash to the jRange method.
                <table class="plugin-options" width='900'>
                    <tr>
                        <th>Option</th>
                        <th width="200">Override</th>
                        <th>Type</th>
                        <th>Details</th>
                    </tr>
                    <tr>
                        <td>from</td>
                        <td>Mandatory</td>
                        <td>Integer</td>
                        <td>Lower bound of slider</td>
                    </tr>
                    <tr>
                        <td>to</td>
                        <td>Mandatory</td>
                        <td>Integer</td>
                        <td>Upper bound of slider</td>
                    </tr>
                    <tr>
                        <td>step</td>
                        <td>Optional</td>
                        <td>Integer</td>
                        <td>
                        	<code>Default : 1</code>
                        	<p>amount of increment on each step</p>
                        </td>
                    </tr>
                    <tr>
                        <td>scale</td>
                        <td>Optional</td>
                        <td>Array</td>
                        <td>
                        	<p>Array containing label which are shown below the slider. By default its [from, to].</p>
                        </td>
                    </tr>
                    <tr>
                        <td>showLabels</td>
                        <td>Optional</td>
                        <td>Boolean</td>
                        <td>
                        	<p>False, if you'd like to hide label which are shown on top of slider.</p>
                        	<code>Default : true</code>
                        </td>
                    </tr>
                    <tr>
                        <td>showScale</td>
                        <td>Optional</td>
                        <td>Boolean</td>
                        <td>
                            <p>False, if you'd like to hide scale which are shown below the slider.</p>
                            <code>Default : true</code>
                        </td>
                    </tr>
                    <tr>
                        <td>format</td>
                        <td>Optional</td>
                        <td>String / Function</td>
                        <td>
                        	<p>this is used to show label on the pointer</p>
                        	<code>Default : "%s"</code>
                        	<p><code>String</code> : %s is replaced by its value, e.g., "%s days", "%s goats"</p>
                        	<p>
                                <code>Function</code> : format(value, pointer)
                                <br>
                                <code>return</code> : string label for a given value and pointer. <br>
                                <code>pointer</code> could be 'low'/'high' if <code>isRange</code> is true, else undefined
                            </p>
                        </td>
                    </tr>
                    <tr>
                        <td>width</td>
                        <td>Optional</td>
                        <td>Integer</td>
                        <td>
                        	<code>Default : 300</code>
                        </td>
                    </tr>
                    <tr>
                        <td>theme</td>
                        <td>Optional</td>
                        <td>String</td>
                        <td>
                        	<code>Default : "theme-green"</code>
                            <p>This is the css class name added to the container. Available themes are "theme-blue", "theme-green". You can also add more themes, just like in <code>jquery.range.less</code></p>
                        </td>
                    </tr>
                    <tr>
                        <td>isRange</td>
                        <td>Optional</td>
                        <td>Boolean</td>
                        <td>
                            <code>Default : false</code>
                            <p>True if this is a range selector. If its a range the value of hidden input will be set comma-seperated, e.g., "25,75"</p>
                        </td>
                    </tr>
										<tr>
                        <td>snap</td>
                        <td>Optional</td>
                        <td>Boolean</td>
                        <td>
                            <code>Default : false</code>
                            <p>True to snap slider to step values</p>
                        </td>
                    </tr>
                    <tr>
                        <td>disable</td>
                        <td>Optional</td>
                        <td>Boolean</td>
                        <td>
                            <code>Default : false</code>
                            <p>True if this is a disable(read only) range selector. You can also change disable status later by calling. </p>
                            <code>
                                $('.slider').jRange('disable');
                                $('.slider').jRange('enable');
                                $('.slider').jRange('toggleDisable');
                            </code>
                        </td>
                    </tr>
                    <tr>
                        <td>onstatechange</td>
                        <td>Optional</td>
                        <td>Function</td>
                        <td>
                           <p>This function is called whenever the value is changed by user. This same value is also automatically set for the provided Hidden Input.</p>
                           <p>For single slider value is without comma, however for a range selector value is comma-seperated.</p>
                        </td>
                    </tr>
                    <tr>
                        <td>ondragend</td>
                        <td>Optional</td>
                        <td>Function</td>
                        <td>
                           <p>ondragend callback. Useful if you want to fire event just once per slider drag.</p>
                        </td>
                    </tr>
                    <tr>
                        <td>onbarclicked</td>
                        <td>Optional</td>
                        <td>Function</td>
                        <td>
                           <p>called when user clicks on the bar</p>
                        </td>
                    </tr>
                </table>

								<h2>Modification</h2>
                <h3>Change values on runtime</h3>
                <p>Methods which you can call to dynamically modify current values and range.
                <table class="plugin-options" width='900'>
										<tr>
											<th width="150">Method</th>
											<th></th>
											<th></th>
											<th>Description</th>
										</tr>
                    <tr>
                        <td>setValue</td>
												<td></td>
												<td></td>
                        <td>
													<p>sets the current value of the slider without changing its range, if you want to update the range as well use <code>updateRange</code> instead.</p>
													<code>
														$('.slider').jRange('setValue', '10,20');<br>
														$('.slider').jRange('setValue', '10');
													</code>
												</td>
                    </tr>
                    <tr>
                        <td>updateRange</td>
												<td></td>
												<td></td>
                        <td>
													<p>'updateRange' to change (min, max) value and interval after initialized.</p>
													<code>
														$('.slider').jRange('updateRange', '0,100');<br>
														$('.slider').jRange('updateRange', '0,100', '25,50');<br>
														$('.slider').jRange('updateRange', '0,100', 25);
													</code>
													<p>passing second parameter also sets its current value</p>
												</td>
                    </tr>
								</table>

                <div class="footer">
                    <a href="https://github.com/nitinhayaran/jRange" class="large-github">Get it from Github</a>
                </div>
            </div>
        </div>
    </section>
    <section class="footer">
        <div class="text-container clearfix">
            <div class="left">
                <p>
                    <a href="https://twitter.com/nitinhayaran" class="twitter-follow-button" data-show-count="false">Follow @nitinhayaran</a>
                    <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
                </p>
                <p><iframe src="http://ghbtns.com/github-btn.html?user=nitinhayaran&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="153" height="20"></iframe></p>
            </div>
            <div class="right">
                <p><a href="https://github.com/nitinhayaran/jRange">jRange</a> is authored and maintained by <a href="https://github.com/nitinhayaran/">@nitinhayaran</a></p>
                <p>
                    Released under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT
                      License</a>
                  </p>
            </div>
        </div>
    </section>
    <script src="prism/prism.js"></script>

    <script src="../jquery.range.js"></script>
    <script type="text/javascript">
        $(document).ready(function(){
            $('.single-slider').jRange({
                from: -2.0,
                to: 2.0,
                step: 0.5,
                scale: [-2.0,-1.0,0.0,1.0,2.0],
                format: '%s',
                width: 300,
                showLabels: true,
                snap: true
            });
            $('.range-slider').jRange({
                from: 0,
                to: 100,
                step: 1,
                scale: [0,25,50,75,100],
                format: '%s',
                width: 300,
                showLabels: true,
                isRange : true
            });
        });
    </script>
</body>
</html>