aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHakim El Hattab <hakim.elhattab@gmail.com>2012-07-26 22:54:36 -0400
committerHakim El Hattab <hakim.elhattab@gmail.com>2012-07-26 22:54:36 -0400
commite570265a67461cfc110208cbe8562ad937794da8 (patch)
treefdd2b7da8b1777c6d39c0b8afbc780895f64d7aa /README.md
parent1916d2f64adcf3a02ddeee06206b5e586167d0fa (diff)
downloadfosdem-2018-presentation-e570265a67461cfc110208cbe8562ad937794da8.tar
fosdem-2018-presentation-e570265a67461cfc110208cbe8562ad937794da8.tar.gz
adds new api methods (getCurrentSlide, getPreviousSlide, getIndices) closes #73
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 25a6c14..d2f36e7 100644
--- a/README.md
+++ b/README.md
@@ -65,9 +65,10 @@ Reveal.initialize({
### API
-The Reveal class provides a minimal JavaScript API for controlling its navigation:
+The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
```javascript
+// Navigation
Reveal.navigateTo( indexh, indexv );
Reveal.navigateLeft();
Reveal.navigateRight();
@@ -76,6 +77,12 @@ Reveal.navigateDown();
Reveal.navigatePrev();
Reveal.navigateNext();
Reveal.toggleOverview();
+
+// Retrieves the previous and current slide elements
+Reveal.getPreviousSlide();
+Reveal.getCurrentSlide();
+
+Reveal.getIndices(); // { h: 0, v: 0 } }
```
### States
@@ -172,7 +179,9 @@ You can change the appearance of the speaker notes by editing the file at `plugi
## History
#### 1.5 (master/beta)
-- TBD
+- New API method ```Reveal.getPreviousSlide()```
+- New API method ```Reveal.getCurrentSlide()```
+- New API method ```Reveal.getIndices()```
#### 1.4
- Main ```#reveal container``` is now selected via a class instead of ID