blob: 77da3057370ce2021f2ef60828347728dd104079 [file] [log] [blame]
Christophe Dervieuxe1893ae2021-10-07 17:09:02 +02001/**
2 * The default reveal.js config object.
3 */
4export default {
5
6 // The "normal" size of the presentation, aspect ratio will be preserved
7 // when the presentation is scaled to fit different resolutions
8 width: 960,
9 height: 700,
10
11 // Factor of the display size that should remain empty around the content
12 margin: 0.04,
13
14 // Bounds for smallest/largest possible scale to apply to content
15 minScale: 0.2,
16 maxScale: 2.0,
17
18 // Display presentation control arrows
19 controls: true,
20
21 // Help the user learn the controls by providing hints, for example by
22 // bouncing the down arrow when they first encounter a vertical slide
23 controlsTutorial: true,
24
25 // Determines where controls appear, "edges" or "bottom-right"
26 controlsLayout: 'bottom-right',
27
28 // Visibility rule for backwards navigation arrows; "faded", "hidden"
29 // or "visible"
30 controlsBackArrows: 'faded',
31
32 // Display a presentation progress bar
33 progress: true,
34
35 // Display the page number of the current slide
36 // - true: Show slide number
37 // - false: Hide slide number
38 //
39 // Can optionally be set as a string that specifies the number formatting:
40 // - "h.v": Horizontal . vertical slide number (default)
41 // - "h/v": Horizontal / vertical slide number
42 // - "c": Flattened slide number
43 // - "c/t": Flattened slide number / total slides
44 //
45 // Alternatively, you can provide a function that returns the slide
46 // number for the current slide. The function should take in a slide
47 // object and return an array with one string [slideNumber] or
48 // three strings [n1,delimiter,n2]. See #formatSlideNumber().
49 slideNumber: false,
50
51 // Can be used to limit the contexts in which the slide number appears
52 // - "all": Always show the slide number
53 // - "print": Only when printing to PDF
54 // - "speaker": Only in the speaker view
55 showSlideNumber: 'all',
56
57 // Use 1 based indexing for # links to match slide number (default is zero
58 // based)
59 hashOneBasedIndex: false,
60
61 // Add the current slide number to the URL hash so that reloading the
62 // page/copying the URL will return you to the same slide
63 hash: false,
64
65 // Flags if we should monitor the hash and change slides accordingly
66 respondToHashChanges: true,
67
68 // Push each slide change to the browser history. Implies `hash: true`
69 history: false,
70
71 // Enable keyboard shortcuts for navigation
72 keyboard: true,
73
74 // Optional function that blocks keyboard events when retuning false
75 //
76 // If you set this to 'focused', we will only capture keyboard events
77 // for embedded decks when they are in focus
78 keyboardCondition: null,
79
80 // Disables the default reveal.js slide layout (scaling and centering)
81 // so that you can use custom CSS layout
82 disableLayout: false,
83
84 // Enable the slide overview mode
85 overview: true,
86
87 // Vertical centering of slides
88 center: true,
89
90 // Enables touch navigation on devices with touch input
91 touch: true,
92
93 // Loop the presentation
94 loop: false,
95
96 // Change the presentation direction to be RTL
97 rtl: false,
98
99 // Changes the behavior of our navigation directions.
100 //
101 // "default"
102 // Left/right arrow keys step between horizontal slides, up/down
103 // arrow keys step between vertical slides. Space key steps through
104 // all slides (both horizontal and vertical).
105 //
106 // "linear"
107 // Removes the up/down arrows. Left/right arrows step through all
108 // slides (both horizontal and vertical).
109 //
110 // "grid"
111 // When this is enabled, stepping left/right from a vertical stack
112 // to an adjacent vertical stack will land you at the same vertical
113 // index.
114 //
115 // Consider a deck with six slides ordered in two vertical stacks:
116 // 1.1 2.1
117 // 1.2 2.2
118 // 1.3 2.3
119 //
120 // If you're on slide 1.3 and navigate right, you will normally move
121 // from 1.3 -> 2.1. If "grid" is used, the same navigation takes you
122 // from 1.3 -> 2.3.
123 navigationMode: 'default',
124
125 // Randomizes the order of slides each time the presentation loads
126 shuffle: false,
127
128 // Turns fragments on and off globally
129 fragments: true,
130
131 // Flags whether to include the current fragment in the URL,
132 // so that reloading brings you to the same fragment position
133 fragmentInURL: true,
134
135 // Flags if the presentation is running in an embedded mode,
136 // i.e. contained within a limited portion of the screen
137 embedded: false,
138
139 // Flags if we should show a help overlay when the question-mark
140 // key is pressed
141 help: true,
142
143 // Flags if it should be possible to pause the presentation (blackout)
144 pause: true,
145
146 // Flags if speaker notes should be visible to all viewers
147 showNotes: false,
148
149 // Flags if slides with data-visibility="hidden" should be kep visible
150 showHiddenSlides: false,
151
152 // Global override for autoplaying embedded media (video/audio/iframe)
153 // - null: Media will only autoplay if data-autoplay is present
154 // - true: All media will autoplay, regardless of individual setting
155 // - false: No media will autoplay, regardless of individual setting
156 autoPlayMedia: null,
157
158 // Global override for preloading lazy-loaded iframes
159 // - null: Iframes with data-src AND data-preload will be loaded when within
160 // the viewDistance, iframes with only data-src will be loaded when visible
161 // - true: All iframes with data-src will be loaded when within the viewDistance
162 // - false: All iframes with data-src will be loaded only when visible
163 preloadIframes: null,
164
165 // Can be used to globally disable auto-animation
166 autoAnimate: true,
167
168 // Optionally provide a custom element matcher that will be
169 // used to dictate which elements we can animate between.
170 autoAnimateMatcher: null,
171
172 // Default settings for our auto-animate transitions, can be
173 // overridden per-slide or per-element via data arguments
174 autoAnimateEasing: 'ease',
175 autoAnimateDuration: 1.0,
176 autoAnimateUnmatched: true,
177
178 // CSS properties that can be auto-animated. Position & scale
179 // is matched separately so there's no need to include styles
180 // like top/right/bottom/left, width/height or margin.
181 autoAnimateStyles: [
182 'opacity',
183 'color',
184 'background-color',
185 'padding',
186 'font-size',
187 'line-height',
188 'letter-spacing',
189 'border-width',
190 'border-color',
191 'border-radius',
192 'outline',
193 'outline-offset'
194 ],
195
196 // Controls automatic progression to the next slide
197 // - 0: Auto-sliding only happens if the data-autoslide HTML attribute
198 // is present on the current slide or fragment
199 // - 1+: All slides will progress automatically at the given interval
200 // - false: No auto-sliding, even if data-autoslide is present
201 autoSlide: 0,
202
203 // Stop auto-sliding after user input
204 autoSlideStoppable: true,
205
206 // Use this method for navigation when auto-sliding (defaults to navigateNext)
207 autoSlideMethod: null,
208
209 // Specify the average time in seconds that you think you will spend
210 // presenting each slide. This is used to show a pacing timer in the
211 // speaker view
212 defaultTiming: null,
213
214 // Enable slide navigation via mouse wheel
215 mouseWheel: false,
216
217 // Opens links in an iframe preview overlay
218 // Add `data-preview-link` and `data-preview-link="false"` to customise each link
219 // individually
220 previewLinks: false,
221
222 // Exposes the reveal.js API through window.postMessage
223 postMessage: true,
224
225 // Dispatches all reveal.js events to the parent window through postMessage
226 postMessageEvents: false,
227
228 // Focuses body when page changes visibility to ensure keyboard shortcuts work
229 focusBodyOnPageVisibilityChange: true,
230
231 // Transition style
232 transition: 'slide', // none/fade/slide/convex/concave/zoom
233
234 // Transition speed
235 transitionSpeed: 'default', // default/fast/slow
236
237 // Transition style for full page slide backgrounds
238 backgroundTransition: 'fade', // none/fade/slide/convex/concave/zoom
239
240 // Parallax background image
241 parallaxBackgroundImage: '', // CSS syntax, e.g. "a.jpg"
242
243 // Parallax background size
244 parallaxBackgroundSize: '', // CSS syntax, e.g. "3000px 2000px"
245
246 // Parallax background repeat
247 parallaxBackgroundRepeat: '', // repeat/repeat-x/repeat-y/no-repeat/initial/inherit
248
249 // Parallax background position
250 parallaxBackgroundPosition: '', // CSS syntax, e.g. "top left"
251
252 // Amount of pixels to move the parallax background per slide step
253 parallaxBackgroundHorizontal: null,
254 parallaxBackgroundVertical: null,
255
256 // The maximum number of pages a single slide can expand onto when printing
257 // to PDF, unlimited by default
258 pdfMaxPagesPerSlide: Number.POSITIVE_INFINITY,
259
260 // Prints each fragment on a separate slide
261 pdfSeparateFragments: true,
262
263 // Offset used to reduce the height of content within exported PDF pages.
264 // This exists to account for environment differences based on how you
265 // print to PDF. CLI printing options, like phantomjs and wkpdf, can end
266 // on precisely the total height of the document whereas in-browser
267 // printing has to end one pixel before.
268 pdfPageHeightOffset: -1,
269
270 // Number of slides away from the current that are visible
271 viewDistance: 3,
272
273 // Number of slides away from the current that are visible on mobile
274 // devices. It is advisable to set this to a lower number than
275 // viewDistance in order to save resources.
276 mobileViewDistance: 2,
277
278 // The display mode that will be used to show slides
279 display: 'block',
280
281 // Hide cursor if inactive
282 hideInactiveCursor: true,
283
284 // Time before the cursor is hidden (in ms)
285 hideCursorTime: 5000,
286
287 // Script dependencies to load
288 dependencies: [],
289
290 // Plugin objects to register and use for this presentation
291 plugins: []
292
293}