config.js 9.2 KB

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