diff --git a/CHANGELOG.md b/CHANGELOG.md index d84f917..deaef2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +# 1.2.1 (2017-03-02) + +## Bugfixes + +- Scrollbar showing in Firefox + +# 1.2.0 (2017-03-02) + +## New Features + +- [[#48](https://github.com/jlantunez/webslides/issues/48)] Allows to navigate with AvPag & RePag to allow presentation devices to work. +- [[#49](https://github.com/jlantunez/webslides/issues/49)] Allowing to go to first and last slides by using home and end keys respectively. +- [[#50](https://github.com/jlantunez/webslides/issues/50)] Using the keyboard on inputs and editable content won't trigger any events that might cause navigation. +- [[#47](https://github.com/jlantunez/webslides/issues/47)] Allowing options to be configured. [Read More](/docs/technical.md#options). + # 1.1.0 (2017-02-28) ## Bugfixes @@ -20,19 +35,19 @@ It's also possible to scroll horizontally on horizontal presentations to move fo # 1.0.0 (2017-02-23) This release is a special one since it sets up in the path of a better development environment. Although it's far from -perfect, it's a solid beginning. +perfect, it's a solid beginning. -All the code has been migrated from **jQuery** with ES5 to **vanilla JavaScript with ES2015 (or ES6) and is fully modular**. -This means that WebSlides is a (base module)[src/js/modules/webslides.js] with a solid API (few public methods) and +All the code has been migrated from **jQuery** with ES5 to **vanilla JavaScript with ES2015 (or ES6) and is fully modular**. +This means that WebSlides is a (base module)[src/js/modules/webslides.js] with a solid API (few public methods) and it's extended by (plugins)[src/js/plugins]. This leads to more granularity and less code to dive through while fixing a -bug. +bug. **The benefit from this approach is that now it's really easy to extend WebSlides** to achieve what you need. You can also overwrite current plugins. Say you don't like the current navigation with arrows and want to create a menu instead, you can just write that for yourself with your custom needs and register it as `nav` and it will overwrite our nav with your code. -We hope this leads to a better environment in which WebSlides can grow better. +We hope this leads to a better environment in which WebSlides can grow better. All the technical specs live now in [this document](docs/technical.md). diff --git a/README.md b/README.md index 550a0fe..3d9d37f 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ Simply choose a demo and customize it in minutes. Latest version: [webslides.tv/ ### Why WebSlides? Good karma and productivity. Just a basic knowledge of HTML and CSS is required. Designers, marketers, and journalists can now focus on the content. -### Features +## Features -- Navigation (horizontal and vertical sliding): touchpad, keyboard shortcuts, and swipe. +- Navigation (horizontal and vertical sliding): remote presenters, touchpad, keyboard shortcuts, and swipe. - Slide counter. - Permalinks: go to a specific slide. - Autoslide. @@ -27,6 +27,20 @@ Good karma and productivity. Just a basic knowledge of HTML and CSS is required. - Fonts: Roboto, Maitree (Serif), and San Francisco. - Vertical rhythm (use multiples of 8). +### Key Navigation + +There's a handful of keys that can be used to achieve navigation within WebSlides. Here's the list: + +* `←`: If WebSlides is not vertical, it will go to the previous slide. +* `→`: If WebSlides is not vertical, it will go to the next slide. +* `↑`: If WebSlides is vertical, it will go to the previous slide. +* `↓`: If WebSlides is vertical, it will go to the next slide. +* `Page Up`: Go to the previous slide. +* `Page Down`: Go to the next slide. +* `Space`: Go to the next slide. +* `Home`: Go to the first slide. +* `End`: Go to the last slide. + ## Markup - Code is clean and scalable. It uses intuitive markup with popular naming conventions. There's no need to overuse classes or nesting. diff --git a/demos/classes.html b/demos/classes.html index c49013c..be55c38 100644 --- a/demos/classes.html +++ b/demos/classes.html @@ -1910,7 +1910,7 @@
Create your own presentation instantly.
120+ prebuilt slides ready to use.
-
+
diff --git a/demos/components.html b/demos/components.html
index 17804e2..bb76fe1 100644
--- a/demos/components.html
+++ b/demos/components.html
@@ -1733,7 +1733,7 @@
-
+
@@ -3103,7 +3103,7 @@
Create your own presentation instantly.
-
+
diff --git a/demos/index.html b/demos/index.html
index 9de1f39..aa43638 100644
--- a/demos/index.html
+++ b/demos/index.html
@@ -199,7 +199,7 @@
Create your own presentation instantly.
-
+
diff --git a/demos/keynote.html b/demos/keynote.html
index 1cc31f1..4187a04 100644
--- a/demos/keynote.html
+++ b/demos/keynote.html
@@ -815,7 +815,7 @@
120+ prebuilt slides ready to use.
-
+
diff --git a/demos/landings.html b/demos/landings.html
index bf5eb81..e552c92 100644
--- a/demos/landings.html
+++ b/demos/landings.html
@@ -236,7 +236,7 @@
-
+
diff --git a/demos/portfolios.html b/demos/portfolios.html
index 8f00bbe..acacab8 100644
--- a/demos/portfolios.html
+++ b/demos/portfolios.html
@@ -105,7 +105,7 @@
Mercedes-Benz
-
+
Create your own presentation instantly.
-
+
HTML Presentations Made Easy
Start in Seconds
120+ prebuilt slides ready to use.Start in seconds
120+ premium slides ready to use.Start in seconds
HTML Presentations Made Easy
Defining a new platform for the connected car
diff --git a/docs/technical.md b/docs/technical.md
index 85f5e3b..f04cb72 100644
--- a/docs/technical.md
+++ b/docs/technical.md
@@ -25,11 +25,18 @@ WebSlides constructor accepts an object with options.
|-----------|----------------|-----------|-------------------------------------------------------------------------------|
| `autoslide` | `number` or `boolean` | `false` | Amount of milliseconds to wait to go to next slide automatically. |
| `changeOnClick` | `boolean` | `false` | If true, clicking on the page will go to the next slide unless it's a clickable element. See [ClickToNav docs](./click-to-nav.md) for more info. |
+| `minWheelDelta` | `number` | `40` | Controls the amount of scroll needed to trigger a navigation. Lower this number to decrease the scroll resistance. |
+| `scrollWait` | `number` | `450` | Controls the amount of time needed to wait for a scroll transition to happen again. |
+| `slideOffset` | `number` | `50` | Amount of sliding needed to trigger a new navigation. |
```javascript
const ws = new WebSlides({
- autoslide: false
+ autoslide = false,
+ changeOnClick = false,
+ minWheelDelta = 40,
+ scrollWait = 450,
+ slideOffset = 50
});
```
@@ -103,9 +110,13 @@ Registers a plugin to be loaded when the instance is created. It allows
Those being:
- - Navigation
- - Hash
- - Keyboard
+- ClickNav
+- Grid
+- Hash
+- Keyboard
+- Navigation
+- Scroll
+- Touch
| Param | Type | Description |
| --- | --- | --- |
diff --git a/index.html b/index.html
index bd29b9c..79a96dd 100644
--- a/index.html
+++ b/index.html
@@ -109,7 +109,7 @@
Just the essentials and using lovely CSS.
Ready to Start?
120+ premium slides ready to use.