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 133a225 commit 75ee592
Showing 1 changed file with 40 additions and 8 deletions.
48 changes: 40 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ A Bare bones slideshow component that handles transitions between slides and exp
Properties | Type | Default | Description | Supported
:--------- | :--- | :------ | :---------- | :--------
**[ratio](#ratio)** | ```Array``` | Null | Shape of the slideshow, for example: `[16,9]` | yes
**animationSpeed** | ```Number``` | 1500 | Speed of slide transitions in px/s | yes
**startingSlide** | ```Number``` | 0 | Initial slide view | yes
**onBeforeTransition** | ```Function``` | noop | Function called before transition starts | yes
**onAfterTransition** | ```Function``` | noop | Function called after transition ends | no
**slideBuffer** | ```Number``` | 1 | The number of slides loaded to the left and right of the slide in view | yes
**clickDivide** | ```Number``` | 0.45 | The division between previous and next when clicking the slideshow | yes
**infinite** | ```Boolean``` | true | Is the Slideshow continuous | no
**suppressPending** | ```Boolean``` | true | Should slides outside the slideBuffer be suppressed | no
**[animationSpeed](#animationSpeed)** | ```Number``` | 1500 | Speed of slide transitions in px/s | yes
**[startingSlide](#startingSlide)** | ```Number``` | 0 | Initial slide view | yes
**[onBeforeTransition](#onBeforeTransition)** | ```Function``` | noop | Function called before transition starts | yes
**[onAfterTransition](#onAfterTransition)** | ```Function``` | noop | Function called after transition ends | no
**[slideBuffer](#slideBuffer)** | ```Number``` | 1 | The number of slides loaded to the left and right of the slide in view | yes
**[clickDivide](#clickDivide)** | ```Number``` | 0.45 | The division between previous and next when clicking the slideshow | yes
**[infinite](#infinite)** | ```Boolean``` | true | Is the Slideshow continuous | no
**[suppressPending](#suppressPending)** | ```Boolean``` | true | Should slides outside the slideBuffer be suppressed | no

### Public methods on mounted component

Expand Down Expand Up @@ -73,6 +73,38 @@ _Note: If ```suppressPending``` property is true on ```<PictureShow/>```, then t

Defines the shape of the slideshow as a fixed ratio so that it can flex inside its parent container.

#### animationSpeed

speed...

#### startingSlide

staring slide...

#### onBeforeTransition

function...

#### onAfterTransition

function...

#### slideBuffer

lazy loading...

#### clickDivide

next and prev...

#### infinite

more stuff...

#### suppressPending

control pending....

## License

[MIT](/LICENSE)

0 comments on commit 75ee592

Please sign in to comment.