Skip to content

Commit a35ec3d

Browse files
authored
Improve the documentation
1 parent e2e56c0 commit a35ec3d

1 file changed

Lines changed: 35 additions & 49 deletions

File tree

README.md

Lines changed: 35 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ For this example CSS, we assume the carousel is contained within an element that
3636
padding: 0;
3737
list-style-type: none;
3838
position: absolute;
39-
-webkit-transform-style: preserve;
40-
-ms-transform-style: preserve;
4139
transform-style: preserve;
4240
}
4341

@@ -65,65 +63,53 @@ window.addEventListener("load", () => {
6563

6664
### Options
6765

68-
duration - duration of slide animation {default: 350ms}
66+
Options are passed as key-values into the object that the ```Itemslide``` constructor gets into the second parameter, for example:
6967

70-
swipe_sensitivity - swiping sensitivity {default: 150}
71-
72-
disable_slide - disable swiping and panning {default: false}
73-
74-
disable_clicktoslide - disable click to slide {default: false}
75-
76-
disable_autowidth - disable the automatic calculation of width (so that you could do it manually) {default: false}
77-
78-
disable_scroll - disable the sliding triggered by mousewheel scrolling {default: false}
79-
80-
start - index of slide that appears when initializing {default: 0}
81-
82-
pan_threshold - can be also considered as panning sensitivity {default: 0.3}(precentage of slide width)
83-
84-
one_item - set this to true if the navigation is full screen or one slide every time. {default: false}
68+
```js
69+
new Itemslide(element, { duration: 100 });
70+
```
8571

86-
parent_width - set this to true if you want the width of the slides to be the width of the parent of ul. {default: false}
72+
Will initialize Itemslide with a custom duration of 100ms.
8773

88-
swipe_out - set this to true to enable the swipe out feature. {default: false} (
74+
Here are the available options:
8975

90-
left_sided - left sided carousel (instead of default force-centered) {default: false}
76+
- ```duration``` - duration of slide animation {default: 350ms}
77+
- ```swipe_sensitivity``` - swiping sensitivity {default: 150}
78+
- ```disable_slide``` - disable swiping and panning {default: false}
79+
- ```disable_clicktoslide``` - disable click to slide {default: false}
80+
- ```disable_autowidth``` - disable the automatic calculation of width (so that you could do it manually) {default: false}
81+
- ```disable_scroll``` - disable the sliding triggered by mousewheel scrolling {default: false}
82+
- ```start``` - index of slide that appears when initializing {default: 0}
83+
- ```pan_threshold``` - can be also considered as panning sensitivity {default: 0.3}(precentage of slide width)
84+
- ```one_item``` - set this to true if the navigation is full screen or one slide every time. {default: false}
85+
- ```parent_width``` - set this to true if you want the width of the slides to be the width of the parent of ul. {default: false}
86+
- ```swipe_out``` - set this to true to enable the swipe out feature. {default: false} (
87+
- ```left_sided``` - left sided carousel (instead of default force-centered) {default: false}
9188

9289
### Methods
9390

94-
getActiveIndex() - get current active slide index
95-
96-
getCurrentPos() - get current position of carousel (pixels)
97-
98-
nextSlide() - goes to next slide
91+
- ```getActiveIndex()``` - get current active slide index
92+
- ```getCurrentPos()``` - get current position of carousel (pixels)
93+
- ```nextSlide()``` - goes to next slide
94+
- ```previousSlide()``` - goes to previous slide
95+
- ```gotoSlide(i)``` - goes to a specific slide by index
96+
- ```reload()``` - recalculates width and center object (recommended to call when resize occures)
97+
- ```addSlide(data)``` - adds in the end of the carousel a new item.
98+
- ```removeSlide(index)``` - removes a specific slide by index.
9999

100-
previousSlide() - goes to previous slide
101-
102-
gotoSlide(i) - goes to a specific slide by index
103-
104-
reload() - recalculates width and center object (recommended to call when resize occures)
105-
106-
addSlide(data) - adds in the end of the carousel a new item.
107-
108-
removeSlide(index) - removes a specific slide by index.
109-
110-
NOTE: addSlide automatically adds li tags.
100+
> NOTE: addSlide automatically adds li tags.
111101
112102
### Events
113103

114-
carouselChangePos - triggered when the position of the carousel is changed
115-
116-
carouselPan - triggered when user pans
117-
118-
carouselChangeActiveIndex - triggered when the current active item has changed
119-
120-
carouselSwipeOut - triggered when user swipes out a slide (if swipe_out is enabled)
121-
122-
> event.slideIndex - get index of swiped out slide
123-
124-
carouselClickSlide - triggered when clicking/tapping a slide
104+
ItemSlide triggers the following events on the element it is initialized on:
125105

126-
> event.slideIndex - get index of the clicked slide
106+
- ```carouselChangePos``` - triggered when the position of the carousel is changed
107+
- ```carouselPan``` - triggered when user pans
108+
- ```carouselChangeActiveIndex``` - triggered when the current active item has changed
109+
- ```carouselSwipeOut``` - triggered when user swipes out a slide (if swipe_out is enabled)
110+
* ```event.slideIndex``` - get index of swiped out slide
111+
- ```carouselClickSlide``` - triggered when clicking/tapping a slide
112+
* ```event.slideIndex``` - get index of the clicked slide
127113

128114
### Classes
129115

0 commit comments

Comments
 (0)