1
0
mirror of https://github.com/webslides/WebSlides.git synced 2025-09-08 20:20:48 +02:00

Updating the docs

This commit is contained in:
Antonio Laguna
2017-03-02 10:35:14 +01:00
parent 9bbbd7362b
commit 21f7ba37ca
3 changed files with 38 additions and 5 deletions

View File

@@ -25,11 +25,18 @@ WebSlides constructor accepts an object with options.
|-----------|----------------|-----------|-------------------------------------------------------------------------------|
| `autoslide` | `number` or `boolean` | `false` | Amount of milliseconds to wait to go to next slide automatically. |
| `changeOnClick` | `boolean` | `false` | If true, clicking on the page will go to the next slide unless it's a clickable element. See [ClickToNav docs](./click-to-nav.md) for more info. |
| `minWheelDelta` | `number` | `40` | Controls the amount of scroll needed to trigger a navigation. Lower this number to decrease the scroll resistance. |
| `scrollWait` | `number` | `450` | Controls the amount of time needed to wait for a scroll transition to happen again. |
| `slideOffset` | `number` | `50` | Amount of sliding needed to trigger a new navigation. |
```javascript
const ws = new WebSlides({
autoslide: false
autoslide = false,
changeOnClick = false,
minWheelDelta = 40,
scrollWait = 450,
slideOffset = 50
});
```
@@ -103,9 +110,13 @@ Registers a plugin to be loaded when the instance is created. It allows
Those being:
- Navigation
- Hash
- Keyboard
- ClickNav
- Grid
- Hash
- Keyboard
- Navigation
- Scroll
- Touch
| Param | Type | Description |
| --- | --- | --- |