forked from kenwheeler/slick
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
687 lines (670 loc) · 19.2 KB
/
index.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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
<!DOCTYPE html>
<html lang="en">
<head>
<title>slick - the last carousel you'll ever need</title>
<link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.0/styles/monokai.min.css">
<link rel="stylesheet" type="text/css" href="slick/slick.css"/>
<link rel="stylesheet" type="text/css" href="css/style.css">
<meta name="description" content="slick is a responsive carousel jQuery plugin that supports multiple breakpoints, CSS3 transitions, touch events/swiping & much more!">
<meta name="keywords" content="slick, responsive, carousel, slider, jQuery, plugin, CSS3, swipe, touch">
<!-- Open Graph -->
<meta property="og:title" content="slick - the last carousel you'll ever need" />
<meta property="og:description" content="slick is a responsive carousel jQuery plugin that supports multiple breakpoints, CSS3 transitions, touch events/swiping & much more!" />
<meta property="og:type" content="article" />
<meta property="og:url" content="http://kenwheeler.github.io/slick/" />
<meta property="og:image" content="http://kenwheeler.github.io/slick/img/slick.gif" />
<meta property="og:image:type" content="image/gif" />
<meta property="og:image:width" content="300" />
<meta property="og:image:height" content="300" />
<!-- Twitter Card -->
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="slick - the last carousel you'll ever need" />
<meta name="twitter:description" content="slick is a responsive carousel jQuery plugin that supports multiple breakpoints, CSS3 transitions, touch events/swiping & much more!" />
<meta name="twitter:creator" content="@ken_wheeler" />
<meta name="twitter:image:src" content="http://kenwheeler.github.io/slick/img/slick.gif" />
<meta name="twitter:domain" content="http://kenwheeler.github.io/slick/" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=0">
<script src="http://cdnjs.cloudflare.com/ajax/libs/modernizr/2.7.1/modernizr.min.js" type="text/javascript"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-4390117-9', 'kenwheeler.github.io');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="header">
<div class="header-content">
<h1 class="title">slick</h1>
<p class="subheading">the last carousel you'll ever need</p>
<ul class="nav">
<li><a href="#demos">demos</a></li>
<li><a href="#getting-started">usage</a></li>
<li><a href="#settings">settings</a></li>
<li><a href="#go-get-it">get it now</a></li>
</ul>
</div>
</div>
<div class="fixed-header">
<div class="header-content">
<h1 class="title">slick</h1>
<p class="subheading">the last carousel you'll ever need</p>
<ul class="nav">
<li><a href="#demos">demos</a></li>
<li><a href="#getting-started">usage</a></li>
<li><a href="#settings">settings</a></li>
<li><a href="#go-get-it">get it now</a></li>
</ul>
</div>
</div>
<section id="features" class="blue">
<div class="content">
<h2>Features</h2>
<ul class="features">
<li>Fully responsive. Scales with its container.</li>
<li>Separate settings per breakpoint</li>
<li>Uses CSS3 when available. Fully functional when not.</li>
<li>Swipe enabled. Or disabled, if you prefer.</li>
<li>Desktop mouse dragging</li>
<li>Infinite looping.</li>
<li>Fully accessible with arrow key navigation</li>
<li>Add, remove, filter & unfilter slides</li>
<li>Autoplay, dots, arrows, callbacks, etc...</li>
</ul>
<hr id="demos"/>
<h2>Single Item</h2>
<div class="slider single-item">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
</div>
<pre><code>
$('.single-item').slick();
</code></pre>
<hr/>
<h2>Multiple Items</h2>
<div class="slider multiple-items">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
<div><h3>7</h3></div>
<div><h3>8</h3></div>
<div><h3>9</h3></div>
</div>
<pre><code>
$('.multiple-items').slick({
infinite: true,
slidesToShow: 3,
slidesToScroll: 3
});
</code></pre>
<hr/>
<h2>Responsive Display</h2>
<div class="slider responsive">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
<div><h3>7</h3></div>
<div><h3>8</h3></div>
</div>
<pre><code>
$('.responsive').slick({
dots: true,
infinite: false,
speed: 300,
slidesToShow: 4,
slidesToScroll: 4,
responsive: [
{
breakpoint: 1024,
settings: {
slidesToShow: 3,
slidesToScroll: 3,
infinite: true,
dots: true
}
},
{
breakpoint: 600,
settings: {
slidesToShow: 2,
slidesToScroll: 2
}
},
{
breakpoint: 480,
settings: {
slidesToShow: 1,
slidesToScroll: 1
}
}
]
});
</code></pre>
<hr/>
<h2>One At A Time</h2>
<div class="slider one-time">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
</div>
<pre><code>
$('.one-time').slick({
dots: true,
infinite: false,
speed: 300,
slidesToShow: 5,
touchMove: false,
slidesToScroll: 1
});
</code></pre>
<hr/>
<h2>Uneven Sets</h2>
<div class="slider uneven">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
</div>
<pre><code>
$('.uneven').slick({
slidesToShow: 4,
slidesToScroll: 4
});
</code></pre>
<hr/>
<h2>Center Mode</h2>
<div class="slider center">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
</div>
<pre><code>
$('.center').slick({
centerMode: true,
centerPadding: '60px',
slidesToShow: 3,
responsive: [
{
breakpoint: 768,
settings: {
arrows: false,
centerMode: true,
centerPadding: '40px',
slidesToShow: 3
}
},
{
breakpoint: 480,
settings: {
arrows: false,
centerMode: true,
centerPadding: '40px',
slidesToShow: 1
}
}
]
});
</code></pre>
<hr/>
<h2>Lazy Loading</h2>
<div class="slider lazy">
<div><div class="image"><img data-lazy="img/lazyfonz1.png"/></div></div>
<div><div class="image"><img data-lazy="img/lazyfonz2.png"/></div></div>
<div><div class="image"><img data-lazy="img/lazyfonz3.png"/></div></div>
<div><div class="image"><img data-lazy="img/lazyfonz4.png"/></div></div>
<div><div class="image"><img data-lazy="img/lazyfonz5.png"/></div></div>
<div><div class="image"><img data-lazy="img/lazyfonz6.png"/></div></div>
</div>
<pre><code>
// To use lazy loading, set a data-lazy attribute
// on your img tags and leave off the src
<img data-lazy="img/lazyfonz1.png"/>
$('.lazy').slick({
lazyLoad: 'ondemand',
slidesToShow: 3,
slidesToScroll: 1
});
</code></pre>
<hr/>
<h2>Autoplay</h2>
<div class="slider autoplay">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
</div>
<pre><code>
$('.autoplay').slick({
slidesToShow: 3,
slidesToScroll: 1,
autoplay: true,
autoplaySpeed: 2000,
});
</code></pre>
<hr/>
<h2>Fade</h2>
<div class="slider fade">
<div><div class="image"><img src="img/fonz1.png"/></div></div>
<div><div class="image"><img src="img/fonz2.png"/></div></div>
<div><div class="image"><img src="img/fonz3.png"/></div></div>
</div>
<pre><code>
$('.fade').slick({
dots: true,
infinite: true,
speed: 500,
fade: true,
slide: '> div',
cssEase: 'linear'
});
</code></pre>
<hr/>
<h2>Add & Remove</h2>
<div class="slider add-remove">
<div><h3>1</h3></div>
</div>
<div class="buttons">
<a href="javascript:void(0)" class="button js-add-slide">Add Slide</a>
<a href="javascript:void(0)" class="button js-remove-slide">Remove Slide</a>
</div>
<pre><code>
$('.add-remove').slick({
slidesToShow: 3,
slidesToScroll: 3
});
var slideIndex = 1;
$('.js-add-slide').on('click', function(){
slideIndex++;
$('.add-remove').slickAdd('<div><h3>'+slideIndex+'</h3></div>');
});
$('.js-remove-slide').on('click', function(){
$('.add-remove').slickRemove(slideIndex - 1);
if (slideIndex !== 0) {
slideIndex--;
}
});
</code></pre>
<hr/>
<h2>Filtering</h2>
<div class="slider filtering">
<div><h3>1</h3></div>
<div><h3>2</h3></div>
<div><h3>3</h3></div>
<div><h3>4</h3></div>
<div><h3>5</h3></div>
<div><h3>6</h3></div>
<div><h3>7</h3></div>
<div><h3>8</h3></div>
<div><h3>9</h3></div>
<div><h3>10</h3></div>
<div><h3>11</h3></div>
<div><h3>12</h3></div>
</div>
<div class="filter">
<a href="javascript:void(0)" class="button js-filter">Filter Slides</a>
</div>
<pre><code>
$('.filtering').slick({
slidesToShow: 4,
slidesToScroll: 4
});
var filtered = false;
$('.js-filter').on('click', function(){
if(filtered === false) {
$('.filtering').slickFilter(':even');
$(this).text('Unfilter Slides');
filtered = true;
} else {
$('.filtering').slickUnfilter();
$(this).text('Filter Slides');
filtered = false;
}
});
</code></pre>
<hr/>
<h2>Destroy</h2>
<p class="destroy">If you really want to be that guy...</p>
<pre><code>
$('.your-slider').unslick();
</code></pre>
<h4 class="more">and a whole lot more...</h4>
</div>
</section>
<section id="getting-started" class="white">
<div class="content">
<h2 class="margin-40">Getting Started</h2>
<p>Set up your HTML.</p>
<pre><code>
<div class="your-class">
<div>your content</div>
<div>your content</div>
<div>your content</div>
</div>
</code></pre>
<hr/>
<p>Move the /slick folder into your project</p>
<hr/>
<p>Add slick.css in your <head></p>
<pre><code>
<link rel="stylesheet" type="text/css" href="slick/slick.css"/>
</code></pre>
<hr/>
<p>Add slick.js before your closing <body> tag, after jQuery (requires jQuery 1.7 +)</p>
<pre><code>
<script type="text/javascript" src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="http://code.jquery.com/jquery-migrate-1.2.1.min.js"></script>
<script type="text/javascript" src="slick/slick.min.js"></script>
</code></pre>
<hr/>
<p>Initialize your slider in your script file or an inline script tag</p>
<pre><code>
$(document).ready(function(){
$('.your-class').slick({
setting-name: setting-value
});
});
</code></pre>
</div>
</section>
<section id="settings" class="blue">
<div class="content">
<h2 >Settings</h2>
<table class="settings">
<thead>
<tr>
<th class="first">Setting</th>
<th class="type">Type</th>
<th class="default">Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accessibility</td>
<td>boolean</td>
<td>true</td>
<td>Enables tabbing and arrow key navigation</td>
</tr>
<tr>
<td>autoplay</td>
<td>boolean</td>
<td>false</td>
<td>Enables Autoplay</td>
</tr>
<tr>
<td>autoplaySpeed</td>
<td>int(ms)</td>
<td>3000</td>
<td>Autoplay Speed in milliseconds</td>
</tr>
<tr>
<td>arrows</td>
<td>boolean</td>
<td>true</td>
<td>Prev/Next Arrows</td>
</tr>
<tr>
<td>centerMode</td>
<td>boolean</td>
<td>false</td>
<td>Enables centered view with partial prev/next slides. Use with odd numbered slidesToShow counts.</td>
</tr>
<tr>
<td>centerPadding</td>
<td>string</td>
<td>'50px'</td>
<td>Side padding when in center mode (px or %)</td>
</tr>
<tr>
<td>cssEase</td>
<td>string</td>
<td>'ease'</td>
<td>CSS3 Animation Easing</td>
</tr>
<tr>
<td>customPaging</td>
<td>function</td>
<td>n/a</td>
<td>Custom paging templates. See source for use example.</td>
</tr>
<tr>
<td>dots</td>
<td>boolean</td>
<td>false</td>
<td>Show dot indicators</td>
</tr>
<tr>
<td>draggable</td>
<td>boolean</td>
<td>true</td>
<td>Enable mouse dragging</td>
</tr>
<tr>
<td>fade</td>
<td>boolean</td>
<td>false</td>
<td>Enable fade</td>
</tr>
<tr>
<td>easing</td>
<td>string</td>
<td>'linear'</td>
<td>Add easing for jQuery animate. Use with easing libraries or default easing methods</td>
</tr>
<tr>
<td>infinite</td>
<td>boolean</td>
<td>true</td>
<td>Infinite loop sliding</td>
</tr>
<tr>
<td>lazyLoad</td>
<td>string</td>
<td>'ondemand'</td>
<td>Set lazy loading technique. Accepts 'ondemand' or 'progressive'.</td>
</tr>
<tr>
<td>onBeforeChange</td>
<td>function</td>
<td>null</td>
<td>Before slide callback</td>
</tr>
<tr>
<td>onAfterChange</td>
<td>function</td>
<td>null</td>
<td>After slide callback</td>
</tr>
<tr>
<td>onInit</td>
<td>function</td>
<td>null</td>
<td>Callback that fires after first initialization</td>
</tr>
<tr>
<td>onReInit</td>
<td>function</td>
<td>null</td>
<td>Callback that fires after every re-initialization</td>
</tr>
<tr>
<td>pauseOnHover</td>
<td>boolean</td>
<td>true</td>
<td>Pause Autoplay On Hover</td>
</tr>
<tr>
<td>responsive</td>
<td>object</td>
<td>none</td>
<td>Object containing breakpoints and settings objects (see demo). Enables settings sets at given screen width.</td>
</tr>
<tr>
<td>slide</td>
<td>element</td>
<td>'div'</td>
<td>Element query to use as slide</td>
</tr>
<tr>
<td>slidesToShow</td>
<td>int</td>
<td>1</td>
<td># of slides to show</td>
</tr>
<tr>
<td>slidesToScroll</td>
<td>int</td>
<td>1</td>
<td># of slides to scroll</td>
</tr>
<tr>
<td>speed</td>
<td>int(ms)</td>
<td>300</td>
<td>Slide/Fade animation speed</td>
</tr>
<tr>
<td>swipe</td>
<td>boolean</td>
<td>true</td>
<td>Enable swiping</td>
</tr>
<tr>
<td>touchMove</td>
<td>boolean</td>
<td>true</td>
<td>Enable slide motion with touch</td>
</tr>
<tr>
<td>touchThreshold</td>
<td>int</td>
<td>5</td>
<td>Swipe distance threshold</td>
</tr>
<tr>
<td>vertical</td>
<td>boolean</td>
<td>false</td>
<td>Vertical slide mode</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table class="methods">
<thead>
<tr>
<th class="first">Method</th>
<th>Arguments</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>slickGoTo</td>
<td>int : slide number</td>
<td>Navigates to a slide by index</td>
</tr>
<tr>
<td>slickNext</td>
<td>none</td>
<td>Navigates to the next slide</td>
</tr>
<tr>
<td>slickPrev</td>
<td>none</td>
<td>Navigates to the previous slide</td>
</tr>
<tr>
<td>slickPause</td>
<td>none</td>
<td>Pauses autoplay</td>
</tr>
<tr>
<td>slickPlay</td>
<td>none</td>
<td>Starts autoplay</td>
</tr>
<tr>
<td>slickAdd</td>
<td>html or DOM object, index, addBefore</td>
<td>Add a slide. If an index is provided, will add at that index, or before if addBefore is set. If no index is provided, add to the end or to the beginning if addBefore is set. Accepts HTML String || Object</td>
</tr>
<tr>
<td>slickRemove</td>
<td>index, removeBefore</td>
<td>Remove slide by index. If removeBefore is set true, remove slide preceding index, or the first slide if no index is specified. If removeBefore is set to false, remove the slide following index, or the last slide if no index is set.</td>
</tr>
<tr>
<td>slickFilter</td>
<td>Selector or Function</td>
<td>Filters slides using jQuery .filter()</td>
</tr>
<tr>
<td>slickUnfilter</td>
<td>index</td>
<td>Removes applied filtering</td>
</tr>
<tr>
<td>slickSetOption</td>
<td>option : string, value : depends on option, refresh : boolean</td>
<td>Sets an individual value live. Set refresh to true if it's a UI update.</td>
</tr>
<tr>
<td>unslick</td>
<td>none</td>
<td>Deconstructs slick</td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="go-get-it" class="white">
<div class="content">
<h2>Go Get It</h2>
<a class="button first" href="https://github.com/kenwheeler/slick/archive/master.zip">Download Now</a>
<a class="button last" href="https://github.com/kenwheeler/slick/">View On Github</a>
<hr/>
<p class="guff">If you like slick, and also like Sass, try my <a href="http://kenwheeler.github.io/guff">Guff</a> mixin library!</p>
<hr/>
<div id="disqus_thread"></div>
</div>
</section>
<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="http://code.jquery.com/jquery-migrate-1.2.1.min.js"></script>
<script src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.0/highlight.min.js"></script>
<script type="text/javascript" src="slick/slick.js"></script>
<script type="text/javascript" src="js/scripts.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script type="text/javascript">
var disqus_shortname = 'slickcarousel';
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
</body>
</html>