summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorIsmaël Bouya <ismael.bouya@normalesup.org>2017-01-20 01:28:44 +0100
committerIsmaël Bouya <ismael.bouya@normalesup.org>2017-01-20 01:28:44 +0100
commit604734c4a960aac3d99f1008337181ed2b0f04db (patch)
tree0cc5a4a9c958edce1b28366a446b75f6a720f6dc /README.markdown
downloadludivine-slick-component-604734c4a960aac3d99f1008337181ed2b0f04db.tar.gz
ludivine-slick-component-604734c4a960aac3d99f1008337181ed2b0f04db.tar.zst
ludivine-slick-component-604734c4a960aac3d99f1008337181ed2b0f04db.zip
Validation initialeHEAD1.6.0master
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown287
1 files changed, 287 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..6dc5ca0
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,287 @@
1slick
2-------
3
4[1]: <https://github.com/kenwheeler/slick>
5
6_the last carousel you'll ever need_
7
8#### Demo
9
10[http://kenwheeler.github.io/slick](http://kenwheeler.github.io/slick/)
11
12#### CDN
13
14To start working with Slick right away, there's a couple of CDN choices availabile
15to serve the files as close, and fast as possible to your users:
16
17- https://cdnjs.com/libraries/slick-carousel
18- https://www.jsdelivr.com/projects/jquery.slick
19
20#####Example using jsDelivr
21
22Just add a link to the css file in your `<head>`:
23```html
24<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/jquery.slick/1.6.0/slick.css"/>
25<!-- Add the slick-theme.css if you want default styling -->
26<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/jquery.slick/1.6.0/slick-theme.css"/>
27```
28
29Then, before your closing ```<body>``` tag add:
30
31```html
32<script type="text/javascript" src="//cdn.jsdelivr.net/jquery.slick/1.6.0/slick.min.js"></script>
33```
34
35#### Package Managers
36
37```sh
38# Bower
39bower install --save slick-carousel
40
41# NPM
42npm install slick-carousel
43```
44
45#### Contributing
46
47PLEASE review CONTRIBUTING.markdown prior to requesting a feature, filing a pull request or filing an issue.
48
49### Data Attribute Settings
50
51In slick 1.5 you can now add settings using the data-slick attribute. You still need to call $(element).slick() to initialize slick on the element.
52
53Example:
54
55```html
56<div data-slick='{"slidesToShow": 4, "slidesToScroll": 4}'>
57 <div><h3>1</h3></div>
58 <div><h3>2</h3></div>
59 <div><h3>3</h3></div>
60 <div><h3>4</h3></div>
61 <div><h3>5</h3></div>
62 <div><h3>6</h3></div>
63</div>
64```
65
66### Settings
67
68Option | Type | Default | Description
69------ | ---- | ------- | -----------
70accessibility | boolean | true | Enables tabbing and arrow key navigation
71adaptiveHeight | boolean | false | Adapts slider height to the current slide
72autoplay | boolean | false | Enables auto play of slides
73autoplaySpeed | int | 3000 | Auto play change interval
74centerMode | boolean | false | Enables centered view with partial prev/next slides. Use with odd numbered slidesToShow counts.
75centerPadding | string | '50px' | Side padding when in center mode. (px or %)
76cssEase | string | 'ease' | CSS3 easing
77customPaging | function | n/a | Custom paging templates. See source for use example.
78dots | boolean | false | Current slide indicator dots
79dotsClass | string | 'slick-dots' | Class for slide indicator dots container
80draggable | boolean | true | Enables desktop dragging
81easing | string | 'linear' | animate() fallback easing
82edgeFriction | integer | 0.15 | Resistance when swiping edges of non-infinite carousels
83fade | boolean | false | Enables fade
84arrows | boolean | true | Enable Next/Prev arrows
85appendArrows | string | $(element) | Change where the navigation arrows are attached (Selector, htmlString, Array, Element, jQuery object)
86appendDots | string | $(element) | Change where the navigation dots are attached (Selector, htmlString, Array, Element, jQuery object)
87mobileFirst | boolean | false | Responsive settings use mobile first calculation
88prevArrow | string (html \| jQuery selector) \| object (DOM node \| jQuery object) | `<button type="button" class="slick-prev">Previous</button>` | Allows you to select a node or customize the HTML for the "Previous" arrow.
89nextArrow | string (html \| jQuery selector) \| object (DOM node \| jQuery object) | `<button type="button" class="slick-next">Next</button>` | Allows you to select a node or customize the HTML for the "Next" arrow.
90infinite | boolean | true | Infinite looping
91initialSlide | integer | 0 | Slide to start on
92lazyLoad | string | 'ondemand' | Accepts 'ondemand' or 'progressive' for lazy load technique. 'ondemand' will load the image as soon as you slide to it, 'progressive' loads one image after the other when the page loads.
93pauseOnFocus | boolean | true | Pauses autoplay when slider is focussed
94pauseOnHover | boolean | true | Pauses autoplay on hover
95pauseOnDotsHover | boolean | false | Pauses autoplay when a dot is hovered
96respondTo | string | 'window' | Width that responsive object responds to. Can be 'window', 'slider' or 'min' (the smaller of the two).
97responsive | array | null | Array of objects [containing breakpoints and settings objects (see example)](#responsive-option-example). Enables settings at given `breakpoint`. Set `settings` to "unslick" instead of an object to disable slick at a given breakpoint.
98rows | int | 1 | Setting this to more than 1 initializes grid mode. Use slidesPerRow to set how many slides should be in each row.
99slide | string | '' | Slide element query
100slidesPerRow | int | 1 | With grid mode initialized via the rows option, this sets how many slides are in each grid row.
101slidesToShow | int | 1 | # of slides to show at a time
102slidesToScroll | int | 1 | # of slides to scroll at a time
103speed | int | 300 | Transition speed
104swipe | boolean | true | Enables touch swipe
105swipeToSlide | boolean | false | Swipe to slide irrespective of slidesToScroll
106touchMove | boolean | true | Enables slide moving with touch
107touchThreshold | int | 5 | To advance slides, the user must swipe a length of (1/touchThreshold) * the width of the slider.
108useCSS | boolean | true | Enable/Disable CSS Transitions
109useTransform | boolean | true | Enable/Disable CSS Transforms
110variableWidth | boolean | false | Disables automatic slide width calculation
111vertical | boolean | false | Vertical slide direction
112verticalSwiping | boolean | false | Changes swipe direction to vertical
113rtl | boolean | false | Change the slider's direction to become right-to-left
114waitForAnimate | boolean | true | Ignores requests to advance the slide while animating
115zIndex | number | 1000 | Set the zIndex values for slides, useful for IE9 and lower
116
117##### Responsive Option Example
118The responsive option, and value, is quite unique and powerful.
119You can use it like so:
120
121```javascript
122$(".slider").slick({
123
124 // normal options...
125 infinite: false,
126
127 // the magic
128 responsive: [{
129
130 breakpoint: 1024,
131 settings: {
132 slidesToShow: 3,
133 infinite: true
134 }
135
136 }, {
137
138 breakpoint: 600,
139 settings: {
140 slidesToShow: 2,
141 dots: true
142 }
143
144 }, {
145
146 breakpoint: 300,
147 settings: "unslick" // destroys slick
148
149 }]
150});
151```
152
153
154
155
156### Events
157
158In slick 1.4, callback methods were deprecated and replaced with events. Use them before the initialization of slick as shown below:
159
160```javascript
161// On swipe event
162$('.your-element').on('swipe', function(event, slick, direction){
163 console.log(direction);
164 // left
165});
166
167// On edge hit
168$('.your-element').on('edge', function(event, slick, direction){
169 console.log('edge was hit')
170});
171
172// On before slide change
173$('.your-element').on('beforeChange', function(event, slick, currentSlide, nextSlide){
174 console.log(nextSlide);
175});
176```
177
178Event | Params | Description
179------ | -------- | -----------
180afterChange | event, slick, currentSlide | After slide change callback
181beforeChange | event, slick, currentSlide, nextSlide | Before slide change callback
182breakpoint | event, slick, breakpoint | Fires after a breakpoint is hit
183destroy | event, slick | When slider is destroyed, or unslicked.
184edge | event, slick, direction | Fires when an edge is overscrolled in non-infinite mode.
185init | event, slick | When Slick initializes for the first time callback. Note that this event should be defined before initializing the slider.
186reInit | event, slick | Every time Slick (re-)initializes callback
187setPosition | event, slick | Every time Slick recalculates position
188swipe | event, slick, direction | Fires after swipe/drag
189lazyLoaded | event, slick, image, imageSource | Fires after image loads lazily
190lazyLoadError | event, slick, image, imageSource | Fires after image fails to load
191
192
193#### Methods
194
195Methods are called on slick instances through the slick method itself in version 1.4, see below:
196
197```javascript
198// Add a slide
199$('.your-element').slick('slickAdd',"<div></div>");
200
201// Get the current slide
202var currentSlide = $('.your-element').slick('slickCurrentSlide');
203```
204
205This new syntax allows you to call any internal slick method as well:
206
207```javascript
208// Manually refresh positioning of slick
209$('.your-element').slick('setPosition');
210```
211
212
213Method | Argument | Description
214------ | -------- | -----------
215`slick` | options : object | Initializes Slick
216`unslick` | | Destroys Slick
217`slickNext` | | Triggers next slide
218`slickPrev` | | Triggers previous slide
219`slickPause` | | Pause Autoplay
220`slickPlay` | | Start Autoplay (_will also set `autoplay` option to `true`_)
221`slickGoTo` | index : int, dontAnimate : bool | Goes to slide by index, skipping animation if second parameter is set to true
222`slickCurrentSlide` | | Returns the current slide index
223`slickAdd` | element : html or DOM object, index: int, addBefore: bool | 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
224`slickRemove` | index: int, removeBefore: bool | 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.
225`slickFilter` | filter : selector or function | Filters slides using jQuery .filter syntax
226`slickUnfilter` | | Removes applied filter
227`slickGetOption` | option : string(option name) | Gets an option value.
228`slickSetOption` | change an option, `refresh` is always `boolean` and will update UI changes...
229 | `option, value, refresh` | change a [single `option`](https://github.com/kenwheeler/slick#settings) to given `value`; `refresh` is optional.
230 | `"responsive", [{ breakpoint: n, settings: {} }, ... ], refresh` | change or add [whole sets of responsive options](#responsive-option-example)
231 | `{ option: value, option: value, ... }, refresh` | change [multiple `option`s](https://github.com/kenwheeler/slick#settings) to corresponding `value`s.
232
233
234#### Example
235
236Initialize with:
237
238```javascript
239$(element).slick({
240 dots: true,
241 speed: 500
242});
243 ```
244
245Change the speed with:
246
247```javascript
248$(element).slick('slickSetOption', 'speed', 5000, true);
249```
250
251Destroy with:
252
253```javascript
254$(element).slick('unslick');
255```
256
257
258#### Sass Variables
259
260Variable | Type | Default | Description
261------ | ---- | ------- | -----------
262$slick-font-path | string | "./fonts/" | Directory path for the slick icon font
263$slick-font-family | string | "slick" | Font-family for slick icon font
264$slick-loader-path | string | "./" | Directory path for the loader image
265$slick-arrow-color | color | white | Color of the left/right arrow icons
266$slick-dot-color | color | black | Color of the navigation dots
267$slick-dot-color-active | color | $slick-dot-color | Color of the active navigation dot
268$slick-prev-character | string | '\2190' | Unicode character code for the previous arrow icon
269$slick-next-character | string | '\2192' | Unicode character code for the next arrow icon
270$slick-dot-character | string | '\2022' | Unicode character code for the navigation dot icon
271$slick-dot-size | pixels | 6px | Size of the navigation dots
272
273#### Browser support
274
275Slick works on IE8+ in addition to other modern browsers such as Chrome, Firefox, and Safari.
276
277#### Dependencies
278
279jQuery 1.7
280
281#### License
282
283Copyright (c) 2014 Ken Wheeler
284
285Licensed under the MIT license.
286
287Free as in Bacon.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 12:32:08 +0000