From a00a247cb601c5a5af4c3cc55a549fae5d637cc0 Mon Sep 17 00:00:00 2001 From: skiano Date: Wed, 4 Mar 2015 05:34:39 -0500 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d4ced3e..89ab849 100644 --- a/README.md +++ b/README.md @@ -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 ````. 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 `````` components) + ## License -[MIT](/LICENSE) \ No newline at end of file +[MIT](/LICENSE)