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 fc43998 commit a00a247
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,19 @@ goToSlide | Go to a specific slide index | yes
disable | Deactivate slideshow | no
enable | Acticate slideshow | no

### How slides work

Slides are the direct child components of a ``<PictureShow/>``. They are cloned with the following additional properties:

```jsx
{
width: (number), // the width of the mounted slideshow
height: (number), // the height of the mounted slideshow
pending: (bool) // whether the slide can be lazyloaded
}
```
By cloning the children with these props, you are free to create 'slide' components that react to them however you want. If the child already has one of these props it will be replaced (even for ```<img/>``` components)

## License

[MIT](/LICENSE)
[MIT](/LICENSE)

0 comments on commit a00a247

Please sign in to comment.