-
Notifications
You must be signed in to change notification settings - Fork 147
/
documentation.html
370 lines (312 loc) · 15 KB
/
documentation.html
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>jQRangeSlider - Documentation - Quickstart</title>
<meta name="viewport" content="width=980" />
<link href="lib/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">
<link href="lib/prettify/prettify.css" rel="stylesheet" media="screen">
<link href="css/style.css" rel="stylesheet" media="screen">
<link href="css/documentation.css" rel="stylesheet" media="screen">
<link href="stable/css/iThing.css" rel="stylesheet" media="screen">
<link rel="icon" type="image/png" href="favicon.png" />
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
</head>
<body data-spy="scroll" data-target="#tableOfContent" data-offset="60">
<nav class="navbar navbar-inverse navbar-default navbar-fixed-top" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">jQRangeSlider</a>
</div>
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav">
<li><a href="index.html"><i class="glyphicon glyphicon-white glyphicon-home"></i> Home</a></li>
<li><a href="demo.html" onClick="_gaq.push(['_trackEvent', 'Demo', 'Menubar']);"><i
class="glyphicon glyphicon-white glyphicon-play"></i> Demo</a></li>
<li class="active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i
class="glyphicon glyphicon-white glyphicon-book"></i> Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="documentation.html">Quick start</a></li>
<li><a href="options.html">Options</a></li>
<li><a href="events.html">Events</a></li>
<li><a href="methods.html">Methods</a></li>
</ul>
</li>
<li><a href="technicalDemo.html" onClick="_gaq.push(['_trackEvent', 'TechnicalDocumentation', 'Menubar']);"><i
class="glyphicon glyphicon-white glyphicon-fast-forward"></i> Technical demo</a></li>
</ul>
<ul class="navbar-right nav navbar-nav">
<li><a href="#" class="donateMenu"><i class="glyphicon glyphicon-gift"></i> Donate</a></li>
<li><a href="download.html" onClick="_gaq.push(['_trackEvent', 'Download', 'Menubar']);"><i
class="glyphicon glyphicon-white glyphicon-download-alt"></i> Download</a></li>
</ul>
</div>
</nav>
<div class="container">
<div class="row">
<nav id="tableOfContent" class="col-md-3">
<div class="navcontainer" data-spy="affix">
<ul class="nav nav-list hiddenprint">
<li><a href="#quickStart">Quick start</a></li>
<li class="nav-header"><span class="trigger collapsed" data-toggle="collapse"
data-target="#optionsDetails">Options</span>
<ul id="optionsDetails" class="collapse out nav">
<li><a href="options.html#optionsUsage">Get and set options</a></li>
<li class="divider"></li>
<li><a href="options.html#arrowsOption">Arrows</a></li>
<li><a href="options.html#boundsOption">Bounds</a></li>
<li><a href="options.html#defaultValuesOption">Default values</a></li>
<li><a href="options.html#delayOption">Delay out</a></li>
<li><a href="options.html#durationOptions">Duration in/out</a></li>
<li><a href="options.html#enabledOption">Enabled</a></li>
<li><a href="options.html#formatterOption">Formatter</a></li>
<li><a href="options.html#rangeOption">Range</a></li>
<li><a href="options.html#scalesOption">Scales</a></li>
<li><a href="options.html#stepOption">Step</a></li>
<li><a href="options.html#typeOption">Type (edit slider)</a></li>
<li><a href="options.html#valueLabelsOption">Value labels</a></li>
<li><a href="options.html#wheelModeOption">Wheel mode</a></li>
<li><a href="options.html#wheelSpeedOption">Wheel speed</a></li>
</ul>
</li>
<li class="nav-header"><span class="trigger collapsed" data-toggle="collapse"
data-target="#eventsDetails">Events</span>
<ul id="eventsDetails" class="collapse out">
<li><a href="events.html#bindingEvents">Binding events</a></li>
<li class="divider"></li>
<li><a href="events.html#valuesChangingEvent">Values changing</a></li>
<li><a href="events.html#valuesChangedEvent">Values changed</a></li>
<li><a href="events.html#userValuesChangedEvent">User values changed</a></li>
</ul>
</li>
<li class="nav-header"><span class="trigger collapsed" data-toggle="collapse"
data-target="#methodsDetails">Methods</span>
<ul id="methodsDetails" class="collapse out">
<li><a href="methods.html#executingMethods">Executing methods</a></li>
<li class="divider"></li>
<li><a href="methods.html#boundsMethod">Bounds</a></li>
<li><a href="methods.html#destroyMethod">Destroy</a></li>
<li><a href="methods.html#enableDisableMethods">Enable / disable</a></li>
<li><a href="methods.html#minMaxMethods">Min / max</a></li>
<li><a href="methods.html#resizeMethod">Resize</a></li>
<li><a href="methods.html#scrollMethods">Scroll left/right</a></li>
<li><a href="methods.html#valuesMethod">Values</a></li>
<li><a href="methods.html#zoomMethods">Zoom in/out</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<article class="col-md-9">
<section id="quickStart">
<div class="page-header">
<h1>Quick start</h1>
</div>
<h2>Prerequisites</h2>
<ul>
<li>jQuery</li>
<li>jQuery UI Core</li>
<li>jQuery UI Widget</li>
<li>jQuery <a href="https://github.com/jquery/jquery-mousewheel">mousewheel plugin</a> (optional)</li>
</ul>
<p>jQRangeSlider is highly dependant on CSS. Be sure to include one of the provided stylesheets.</p>
<h2>Basic slider</h2>
<div class="alert alert-info">
<strong>Info</strong>: If you use more than one type of slider, please report to the <strong><a
href="#allSlidersScript">multiple sliders</a></strong> section.
</div>
<div class="example">
<div class="sliderContainer">
<div id="basicSliderExample"></div>
</div>
<pre class="prettyprint linenums"><code class="language-html"><!DOCTYPE>
<html>
<head>
<meta charset="utf-8"/>
<title>example</title>
<link rel="stylesheet" href="css/iThing.css" type="text/css" />
</head>
<body>
<h1>Hello world</h1>
<div id="slider"></div>
<script src="jquery.js"></script>
<script src="jquery-ui.custom.js"></script>
<strong><script src="jQRangeSlider-min.js"></script></strong>
<script>
//<!--
<strong>$("#slider").rangeSlider();</strong>
//-->
</script>
</body>
</html>
</code></pre>
</div>
<h2>Edit slider</h2>
<div class="alert alert-info">
<strong>Info</strong>: If you use more than one type of slider, please report to the <strong><a
href="#allSlidersScript">multiple sliders</a></strong> section.
</div>
<div class="example">
<div class="sliderContainer">
<div id="editSliderExample"></div>
</div>
<pre class="prettyprint linenums"><code class="language-html"><!DOCTYPE>
<html>
<head>
<meta charset="utf-8"/>
<title>example</title>
<link rel="stylesheet" href="css/iThing.css" type="text/css" />
</head>
<body>
<h1>Hello world</h1>
<div id="slider"></div>
<script src="jquery.js"></script>
<script src="jquery-ui.custom.js"></script>
<strong><script src="jQEditRangeSlider-min.js"></script></strong>
<script>
//<!--
<strong>$("#slider").editRangeSlider();</strong>
//-->
</script>
</body>
</html>
</code></pre>
</div>
<h2 id="dateSliderQuickStart">Date slider</h2>
<div class="alert alert-info">
<strong>Info</strong>: If you use more than one type of slider, please report to the <strong><a
href="#allSlidersScript">multiple sliders</a></strong> section.
</div>
<div class="example">
<div class="sliderContainer">
<div id="dateSliderExample"></div>
</div>
<pre class="prettyprint linenums"><code class="language-html"><!DOCTYPE>
<html>
<head>
<meta charset="utf-8"/>
<title>example</title>
<link rel="stylesheet" href="css/iThing.css" type="text/css" />
</head>
<body>
<h1>Hello world</h1>
<div id="slider"></div>
<script src="jquery.js"></script>
<script src="jquery-ui.custom.js"></script>
<strong><script src="jQDateRangeSlider-min.js"></script></strong>
<script>
//<!--
<strong>$("#slider").dateRangeSlider();</strong>
//-->
</script>
</body>
</html>
</code></pre>
</div>
<h2 id="allSlidersScript">Multiple sliders</h2>
<p>If you are using multiple sliders on the same page, you need to use another javascript file:
<code>jQAllRangeSliders-min.js</code>. This file contains all necessary javascript for creating all types of
slider. As most part of the source code is common between different kind of sliders, it's a good practice to
use this file instead of including multiple minified files.</p>
<pre class="prettyprint linenums"><code class="language-html"><!DOCTYPE>
<html>
<head>
<meta charset="utf-8"/>
<title>example</title>
<link rel="stylesheet" href="css/iThing.css" type="text/css" />
</head>
<body>
<h1>Hello world</h1>
<div id="slider"></div>
<div id="dateSlider"></div>
<div id="editSlider"></div>
<script src="jquery.js"></script>
<script src="jquery-ui.custom.js"></script>
<strong><script src="jQAllRangeSliders-min.js"></script></strong>
<script>
//<!--
<strong>$("#slider").rangeSlider();</strong>
<strong>$("#dateSlider").dateRangeSlider();</strong>
<strong>$("#editSlider").editRangeSlider();</strong>
//-->
</script>
</body>
</html>
</code></pre>
</section>
</article>
</div>
<div class="row">
<footer class="col-md-offset-3 col-md-9">
<p>Thanks to <a href="https://twitter.github.com/bootstrap">twitter bootstrap</a> for its awesome CSS framework.
</p>
</footer>
</div>
</div>
<div id="donationContent" style="display:none">
<p>If you appreciate the slider, don't hesitate to donate to support the project. Even <strong>a small amount will
help</strong>.</p>
<p class="donation">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=guillaume%40ghusse%2ecom&lc=US&item_name=jQRangeSlider&item_number=download&amount=10%2e00&currency_code=USD&no_note=0&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest"
class="btn btn-default" onClick="_gaq.push(['_trackEvent', 'Donation', 'Donate10Gotcha', 'Donate $10', 10]);"><i
class="glyphicon glyphicon-thumbs-up"></i> $10</a>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=guillaume%40ghusse%2ecom&lc=US&item_name=jQRangeSlider&item_number=download&amount=20%2e00&currency_code=USD&no_note=0&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest"
class="btn btn-primary btn-lg"
onClick="_gaq.push(['_trackEvent', 'Donation', 'Donate20Gotcha', 'Donate $20', 20]);"><i
class="glyphicon glyphicon-gift"></i> $20</a>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=guillaume%40ghusse%2ecom&lc=US&item_name=jQRangeSlider&item_number=download&amount=50%2e00&currency_code=USD&no_note=0&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest"
class="btn btn-default" onClick="_gaq.push(['_trackEvent', 'Donation', 'Donate50Gotcha', 'Donate $50', 50]);"><i
class="glyphicon glyphicon-heart"></i> $50</a>
</p>
<p class="donation BTC">BTC: <input value="18HvbEBJ22HdzNdgDqWKLfHxYrVoGCiSMt"></p>
<p>Thank you!</p>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="lib/bootstrap/js/bootstrap.min.js"></script>
<script src="lib/prettify/prettify.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.10.3/jquery-ui.min.js"></script>
<script src="stable/lib/jquery.mousewheel.min.js"></script>
<script src="stable/jQRangeSliderMouseTouch.js"></script>
<script src="stable/jQRangeSliderDraggable.js"></script>
<script src="stable/jQRangeSliderHandle.js"></script>
<script src="stable/jQRangeSliderBar.js"></script>
<script src="stable/jQRangeSliderLabel.js"></script>
<script src="stable/jQRangeSlider.js"></script>
<script src="stable/jQDateRangeSliderHandle.js"></script>
<script src="stable/jQDateRangeSlider.js"></script>
<script src="stable/jQEditRangeSliderLabel.js"></script>
<script src="stable/jQEditRangeSlider.js"></script>
<script src="stable/jQRuler.js"></script>
<script>
$(document).ready(function () {
prettyPrint();
$("#basicSliderExample").rangeSlider();
$("#editSliderExample").editRangeSlider();
$("#dateSliderExample").dateRangeSlider();
});
$(".donateMenu").popover({
html: true,
placement: "bottom",
title: "Thank you for donating!",
container: "body",
content: function () { return $("#donationContent").html(); }
});
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-20560239-1']);
_gaq.push(['_trackPageview']);
(function () {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>