Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skiano committed Mar 4, 2015
1 parent 3d8acca commit e69295d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ The package includes lib/PictureShow.css and src/PictureShow.scss.

Properties | Type | Default | Description | Supported
:--------- | :--- | :------ | :---------- | :--------
**ratio** | array ```[w,h]``` | Null | Creates a fixed-ratio slideshow / otherwise it stretches to fill its parent, for example `[16,9]` | yes
**animationSpeed** | number | 1500 | Roughly how many px/s the slide should move during transitions | yes
**startingSlide** | number | 0 | The index of the slide to view first | yes
**onBeforeTransition** | function | noop | ``function (currentIdx, nextIdx) {}`` | yes
**onAfterTransition** | function | noop | ``function (previousIdx, currentIdx) {}`` | no
**slideBuffer** | number | 1 | The number of slides should be marked as inview to the left and right | yes
**clickDivide** | number ```0–1``` | 0.45 | Where the line between previous and next should fall when clicking the slideshow | yes
**ratio** | ```array [w,h]``` | Null | Creates a fixed-ratio slideshow / otherwise it stretches to fill its parent, for example `[16,9]` | yes
**animationSpeed** | ```number``` | 1500 | Roughly how many px/s the slide should move during transitions | yes
**startingSlide** | ```number``` | 0 | The index of the slide to view first | yes
**onBeforeTransition** | ```function``` | noop | ``function (currentIdx, nextIdx) {}`` | yes
**onAfterTransition** | ```function``` | noop | ``function (previousIdx, currentIdx) {}`` | no
**slideBuffer** | ```number``` | 1 | The number of slides should be marked as inview to the left and right | yes
**clickDivide** | ```number 0–1``` | 0.45 | Where the line between previous and next should fall when clicking the slideshow | yes
**infinite** | bool | true | Slideshow is continuous | no

### Public methods on mounted component
Expand Down

0 comments on commit e69295d

Please sign in to comment.