From 2fa3ab6a6bf9083877dfe46257857a2ab019c293 Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Wed, 23 Jan 2019 10:14:40 +0100 Subject: [PATCH] documentation for navigationMode #2307 --- README.md | 24 +++++++++++------------- js/reveal.js | 6 ++---- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d137630..ff58915 100644 --- a/README.md +++ b/README.md @@ -285,10 +285,8 @@ Reveal.initialize({ // Change the presentation direction to be RTL rtl: false, - // When this is enabled, stepping left/right from a vertical stack - // to an adjacent vertical stack will land you at the same vertical - // index instead of the top. - gridNavigation: false, + // . + navigationMode: 'default', // Randomizes the order of slides each time the presentation loads shuffle: false, @@ -523,15 +521,15 @@ Slides can be nested within other slides to create vertical stacks (see [Markup] -#### Grid Navigation -If you are on a vertical slide and step right onto an adjacent vertical stack, you'll arrive at the top of that stack. Consider a deck with six slides organized in two stacks like this: -``` -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. If you prefer remaining at the same vertical index and going directly from 1.3 -> 2.3 you can enable the `gridNavigation` config option: `Reveal.configure({ gridNavigation: true })`. - +#### Navigation Mode +You can finetune the reveal.js navigation behavior by using the `navigationMode` config option. This option supports the following values: + +| 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. | + ### Touch Navigation You can swipe to navigate through a presentation on any touch-enabled device. Horizontal swipes change between horizontal slides, vertical swipes change between vertical slides. If you wish to disable this you can set the `touch` config option to false when initializing reveal.js. diff --git a/js/reveal.js b/js/reveal.js index 5addf75..ba69d1a 100644 --- a/js/reveal.js +++ b/js/reveal.js @@ -116,10 +116,8 @@ // all slides (both horizontal and vertical). // // "linear" - // When this is enabled, the left/right arrow keys step through all - // slides (both horizontal and vertical) in a linear way. If the - // presentation has no vertical slides this setting is identical - // to "default". + // 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