Skip to content

Update options descriptions #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vincentorback wants to merge 2 commits into
base: master
Choose a base branch
from
+33 −28
Open

Update options descriptions #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad57a5f
remove deprecated and added missing options
vincentorback Feb 7, 2018
c3406a8
sync options descriptions in lib with readme
vincentorback Feb 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,21 +89,25 @@ instance.destroy();
```

# Options
* pageClass: classname selector for all elments that should provide a page
* direction: "horizontal" or "vertical"
* minDragDistance: minuimum distance (in pixel) the user has to drag to trigger swip
* page: Number of page to load on start
* scribe: pixel value for a possible scribe
* onSwipeStart: callback function before the animation
* onSwipeEnd: callback function after the animation
* onDrag: callback on drag
* onDragEnd: callback on dragend
* afterInitialize:
* borderBetweenPages: if you need space between pages add a pixel value
* duration
* hammerSettings
* preventDrag: if want to prevent user interactions and only swipe manualy
* disableScroll: prevent scroll on mobile version
Default value in parenthesize.
* `pageClass`: classname of page elements. (`"dragend-page"`)
* `direction` : "horizontal" or "vertical" direction of transitions. (`"horizontal"`)
* `minDragDistance` : minimum distance (in pixels) the user has to drag to trigger swipe. (`"40"`)
* `onSwipeStart`: callback before page transition
* `onSwipeEnd`: callback after page transition
* `onDragStart`: callback on drag start
* `onDrag`: callback on drag
* `onDragEnd`: callback on drag end
* `afterInitialize`: called after the pages are sized
* `keyboardNavigation`: if you want to enable keyboard navigation. (`false`)
* `stopPropagation`: prevent event propagation. (`false`)
* `itemsInPage`: number of items in a page . (`1`)
* `scribe`: pixel value for a possible scribe . (`0`)
* `page`: number of the page to load on start. (`1`)
* `borderBetweenPages`: space (in pixels) between pages. (`0`)
* `duration`: transition duration. (`300`)
* `preventDrag`: prevent user interactions and only swipe manually. (`false`)
* `disableScroll`: prevent touch scroll. (`false`)

# CHANGELOG

Expand Down
27 changes: 14 additions & 13 deletions dragend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,22 +59,23 @@
//
// You can use the following options:
//
// * pageClass: classname selector for all elments that should provide a page
// * pageClass: classname of page elements
// * direction: "horizontal" or "vertical"
// * minDragDistance: minuimum distance (in pixel) the user has to drag
// to trigger swip
// * page: Number of page to load on start
// * scribe: pixel value for a possible scribe
// * onSwipeStart: callback function before the animation
// * onSwipeEnd: callback function after the animation
// * minDragDistance: minimum distance (in pixels) the user has to drag to trigger swipe
// * onSwipeStart: callback before page transition
// * onSwipeEnd: callback after page transition
// * onDragStart: called on drag start
// * onDrag: callback on drag
// * onDragEnd: callback on dragend
// * borderBetweenPages: if you need space between pages add a pixel value
// * duration
// * stopPropagation
// * afterInitialize called after the pages are size
// * preventDrag if want to prevent user interactions and only swipe manualy
// * onDragEnd: callback on drag end
// * afterInitialize: called after the pages are sized
// * keyboardNavigation: if you want to enable keyboard navigation
// * stopPropagation: prevent event propagation
// * itemsInPage: number of items in a page
// * scribe: pixel value for a possible scribe
// * page: number of the page to load on start
// * borderBetweenPages: space (in pixels) between pages
// * preventDrag: prevent user interactions and only swipe manually
// * disableScroll: prevent touch scroll

var

Expand Down