<section>
in the #webslides element is an individual slide.
+- Each parent `<article id="webslides">
- <section>
- <h1>Slide 1</h1>
- </section>
- <section class="bg-black aligncenter">
- <!-- .wrap = container 1200px -->
- <div class="wrap">
- <h1>Slide 2</h1>
- </div>
- </section>
-</article>
+```
+<article id="webslides" class="vertical">+`
Goes to a given slide.
+Goes to the next slide.
+Goes to the previous slide.
+Registers a plugin to be loaded when the instance is created. It allows +(on purpose) to replace default plugins. +Those being:
+number
| The slide index. |
+| forward | boolean
| Whether we're forcing moving forward/backwards. This parameter is used only from the `goNext`, `goPrev` functions to adjust the scroll animations. |
+
+
+
+### `goNext()`
+Goes to the next slide. If the page is vertical, it will animate the scroll down.
+
+
+
+### `goPrev()`
+Goes to the previous slide. If the page is vertical, it will animate the scroll up
+
+
+
+### `registerPlugin(key, cto)`
+Registers a plugin to be loaded when the instance is created. It allows
+(on purpose) to replace default plugins.
+
+Those being:
+
+ - Navigation
+ - Hash
+ - Keyboard
+
+| Param | Type | Description |
+| --- | --- | --- |
+| key | string
| They key under which it'll be stored inside of the instance, inside the plugins dict. |
+| cto | function
| Plugin constructor. |
+
+### Plugin development
+
+Almost every single feature of WebSlides is a plugin that can be overwritten and you are able to create your custom plugins. Just call `registerPlugin` (as seen above) **before creating** the instance:
+
+```
+// Adding the constructor to WebSlides
+WebSlides.registerPlugin('MyPlugin', MyPlugin);
+
+// Starting WebSlides
+// Your plugin will be constructed at this time and it will receive the webslides instance as the only parameter.
+const ws = new WebSlides();
+// You can also access ws.plugins.MyPlugin now
+```
+
+This allows you to rewrite the navigation to use a menu (for example) or add that missing piece of functionality you'd like to see.
+
+Make sure to let us know so it could get added to the repo!
### What's in the download?
@@ -58,16 +160,17 @@ webslides/
### CSS Syntax (classes)
-- Typography: .text-landing, .text-data, .text-intro...
-- Background Colors: .bg-primary, .bg-apple, .bg-blue...
-- Background Images: .background,.background-center-bottom...
-- Cards: .card-50, .card-40...
-- Flexible Blocks: .flexblock.clients, .flexblock.metrics...
+- Typography: `.text-landing`, `.text-data`, `.text-intro`...
+- Background Colors: `.bg-primary`, `.bg-apple`, `.bg-blue`...
+- Background Images: `.background`,`.background-center-bottom`...
+- Cards: `.card-50`, `.card-40`...
+- Flexible Blocks: `.flexblock.clients`, `.flexblock.metrics`...
### Extensions
You can add:
+
- [Unsplash](https://unsplash.com) photos
- [animate.css](https://daneden.github.io/animate.css)
- [particles.js](https://github.com/VincentGarreau/particles.js)
@@ -83,3 +186,9 @@ Use it to make something cool.
- WebSlides was created by [@jlantunez](https://twitter.com/jlantunez) using [Cactus](https://github.com/eudicots/Cactus).
- Thanks [@LuisSacristan](https://twitter.com/luissacristan) for the javascript code :)
- Based on [SimpleSlides](https://github.com/jennschiffer/SimpleSlides), by [@JennSchiffer](https://twitter.com/jennschiffer).
+
+### Roadmap
+
+* Fix crossbrowser issues. Safari mostly.
+* Make a stable release.
+* Write tests
\ No newline at end of file