aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHakim El Hattab <hakim@squarespace.com>2013-06-04 21:14:13 +0200
committerHakim El Hattab <hakim@squarespace.com>2013-06-04 21:14:17 +0200
commit0ce57f1f91d079b027dc250a2827b8ac4d93bd2d (patch)
tree8763c42c7ccfba42438e8ff735983b006c70df10 /README.md
parent544e090bd12b79ae48c8daa8c1d267d4a83d4f19 (diff)
downloadfosdem-2018-presentation-0ce57f1f91d079b027dc250a2827b8ac4d93bd2d.tar
fosdem-2018-presentation-0ce57f1f91d079b027dc250a2827b8ac4d93bd2d.tar.gz
update background test, documented slide backgrounds in readme (#453)
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 34 insertions, 12 deletions
diff --git a/README.md b/README.md
index 85e7e5c..a496f5d 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,9 @@ Reveal.initialize({
// Transition speed
transitionSpeed: 'default', // default/fast/slow
+ // Transition style for full page backgrounds
+ backgroundTransition: 'default' // default/linear
+
});
```
@@ -211,18 +214,6 @@ Reveal.getCurrentSlide();
Reveal.getIndices(); // { h: 0, v: 0 } }
```
-### States
-
-If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
-
-Furthermore you can also listen to these changes in state via JavaScript:
-
-```javascript
-Reveal.addEventListener( 'somestate', function() {
- // TODO: Sprinkle magic
-}, false );
-```
-
### Ready event
The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.
@@ -245,6 +236,37 @@ Reveal.addEventListener( 'slidechanged', function( event ) {
} );
```
+### States
+
+If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
+
+Furthermore you can also listen to these changes in state via JavaScript:
+
+```javascript
+Reveal.addEventListener( 'somestate', function() {
+ // TODO: Sprinkle magic
+}, false );
+```
+
+### Slide backgrounds
+
+Slides are contained withing a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page background colors or images by applying a ```data-background``` attribute to your ```<section>``` elements. Below are a few examples.
+
+```html
+<section data-background="#ff0000">
+ <h2>All CSS color formats are supported, like rgba() or hsl().</h2>
+</section>
+<section data-background="http://example.com/image.png">
+ <h2>This slide will have a full-size background image.</h2>
+</section>
+<section data-background="http://example.com/image.png" data-background-size="100px" data-background-repeat="repeat">
+ <h2>This background image will be sized to 100px and repeated.</h2>
+</section>
+```
+
+Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'linear'``` to the ```Reveal.initialize()``` call.
+
+
### Internal links
It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):