From 23c2d2795cacc5f01139a41528682aadff41819d Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Wed, 23 Jan 2019 10:43:05 +0100 Subject: [PATCH] navigationMode documentation improvements --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff58915..170fe48 100644 --- a/README.md +++ b/README.md @@ -285,7 +285,7 @@ Reveal.initialize({ // Change the presentation direction to be RTL rtl: false, - // . + // See https://github.com/hakimel/reveal.js/#navigation-mode navigationMode: 'default', // Randomizes the order of slides each time the presentation loads @@ -522,13 +522,13 @@ Slides can be nested within other slides to create vertical stacks (see [Markup] #### Navigation Mode -You can finetune the reveal.js navigation behavior by using the `navigationMode` config option. This option supports the following values: +You can finetune the reveal.js navigation behavior by using the `navigationMode` config option. Note that these options are only useful for presnetations that use a mix of horizontal and vertical slides. The following navigation modes are available: | Value | Description | | :--------------------------- | :---------- | | default | Left/right arrow keys step between horizontal slides. Up/down arrow keys step between vertical slides. Space key steps through all slides (both horizontal and vertical). | | linear | Removes the up/down arrows. Left/right arrows step through all slides (both horizontal and vertical). | -| grid | When this is enabled, stepping left/right from a vertical stack to an adjacent vertical stack will land you at the same vertical index.

Consider a deck with six slides ordered in two vertical stacks:
1.1 2.1
1.2 2.2
1.3 2.3

If you're on slide 1.3 and navigate right, you will normally move from 1.3 -> 2.1. With navigationMode set to "grid" the same navigation takes you from 1.3 -> 2.3. | +| grid | When this is enabled, stepping left/right from a vertical stack to an adjacent vertical stack will land you at the same vertical index.

Consider a deck with six slides ordered in two vertical stacks:
`1.1`    `2.1`
`1.2`    `2.2`
`1.3`    `2.3`

If you're on slide 1.3 and navigate right, you will normally move from 1.3 -> 2.1. With navigationMode set to "grid" the same navigation takes you from 1.3 -> 2.3. | ### Touch Navigation