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 be6bda2 commit 47dea1d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Properties | Type | Default | Description | Supported
**slideBuffer** | ```Number``` | 1 | The number of slides should be marked as inview to the left and right | yes
**clickDivide** | ```Number``` | 0.45 | Fraction where the line between previous and next should fall when clicking the slideshow | yes
**infinite** | ```Boolean``` | true | Slideshow is continuous | no
**nullPending** | ```Boolean``` | true | Pending slides are not rendered | no
**pendingNull** | ```Boolean``` | true | Pending slides are not rendered | no

### Public methods on mounted component

Expand All @@ -67,6 +67,8 @@ Slides are the direct child components of a ``<PictureShow/>``. They are cloned
```
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)

_Note: If ```pendingNull``` property is true on ```<PictureShow/>```, then the slide will not render, so you will not need to handle the ```pending``` prop at the slide level. It is there for edge cases where the user wants to define how 'not loading' works_

## License

[MIT](/LICENSE)

0 comments on commit 47dea1d

Please sign in to comment.