kslides-core/com.kslides.config/PresentationConfig

PresentationConfig

class PresentationConfig : AbstractConfig

Presentation-level configuration — mirrors the reveal.js config options plus kslides-specific settings for theme, corner links, Google Analytics, and nested sub-configs (menuConfig, copyCodeConfig, slideConfig, playgroundConfig, letsPlotIframeConfig, diagramConfig).

Configured at three levels that merge in order: global → presentation → slide. The global instance is seeded with kslides defaults via assignDefaults; subsequent presentation- and slide-level instances only carry overrides and are merged on top.

Constructors

PresentationConfig

constructor()

Properties

autoAnimate

var autoAnimate: Boolean

Globally disable auto-animate transitions. Individual slides can still opt in via data-auto-animate.

autoAnimateDuration

var autoAnimateDuration: Float

Default duration (seconds) for auto-animate transitions.

autoAnimateEasing

var autoAnimateEasing: String

Default CSS easing function for auto-animate transitions.

autoAnimateMatcher

var autoAnimateMatcher: String

Optional custom element matcher used to decide which elements animate between slides.

autoAnimateStyles

var autoAnimateStyles: List<String>

CSS properties auto-animate can transition. Position and scale are handled separately, so top/left/width/height/margin are not needed here.

autoAnimateUnmatched

var autoAnimateUnmatched: Boolean

When true, elements not matched by auto-animate fade in/out.

autoPlayMedia

var autoPlayMedia: Boolean

Global override for autoplay on embedded media.

autoSlide

var autoSlide: Any

Auto-slide behavior.

autoSlideStoppable

var autoSlideStoppable: Boolean

When true, user input halts auto-sliding until the next manual navigation.

backgroundTransition

var backgroundTransition: Transition

Default transition style for full-page slide backgrounds.

center

var center: Boolean

Vertically center slide content.

controls

var controls: Boolean

Display the arrow controls for navigation.

controlsBackArrows

var controlsBackArrows: String

Visibility of the backwards-navigation arrows. "faded", "hidden", or "visible".

controlsLayout

var controlsLayout: String

Position of the navigation arrows. "edges" or "bottom-right".

controlsTutorial

var controlsTutorial: Boolean

Help the user learn the controls with hints (e.g. bouncing the down arrow the first time a vertical stack is encountered).

defaultTiming

var defaultTiming: Int

Typical time in seconds spent on each slide. Drives the pacing timer in the speaker view; has no effect on actual navigation.

disableLayout

var disableLayout: Boolean

Disable reveal.js's default scaling and centering so that a custom CSS layout can take over.

display

var display: String

CSS display value used when showing slides.

embedded

var embedded: Boolean

Flag the presentation as running in an embedded (non-full-window) context.

enableCodeCopy

var enableCodeCopy: Boolean

Load the CopyCode plugin (adds a copy button to code blocks). See CopyCodeConfig.

enableHighlight

var enableHighlight: Boolean

Load the reveal.js highlight.js plugin for syntax-highlighted code blocks.

enableMarkdown

var enableMarkdown: Boolean

Load the reveal.js Markdown plugin (required for com.kslides.slide.MarkdownSlide).

enableMathJax2

var enableMathJax2: Boolean

Load the math plugin with MathJax 2 support.

enableMathJax3

var enableMathJax3: Boolean

Load the math plugin with MathJax 3 support.

enableMathKatex

var enableMathKatex: Boolean

Load the math plugin with KaTeX support.

enableMenu

var enableMenu: Boolean

Load the reveal.js-menu plugin. See MenuConfig.

enableSearch

var enableSearch: Boolean

Load the reveal.js search plugin (keyboard: ctrl+shift+f).

enableSpeakerNotes

var enableSpeakerNotes: Boolean

Load the reveal.js speaker-notes plugin.

enableZoom

var enableZoom: Boolean

Load the reveal.js zoom plugin (keyboard: alt+click).

focusBodyOnPageVisibilityChange

var focusBodyOnPageVisibilityChange: Boolean

When true, focus the document body on visibility changes so keyboard shortcuts work.

fragmentInURL

var fragmentInURL: Boolean

Include the current fragment index in the URL so reloads land on the same fragment.

fragments

var fragments: Boolean

Globally enable/disable fragments.

gaPropertyId

var gaPropertyId: String

Google Analytics property id. When non-blank, injects the gtag.js loader and config.

hash

var hash: Boolean

When true, the current slide is appended to the URL hash so reloading the page or copying the URL returns the viewer to the same slide.

hashOneBasedIndex

var hashOneBasedIndex: Boolean

When true, # URL links use 1-based indexing to match the slide number.

height

var height: Any

"Normal" presentation height. Same notes as width. reveal.js default: 700.

help

var help: Boolean

Show a help overlay when the question-mark key is pressed.

hideCursorTime

var hideCursorTime: Int

Milliseconds of inactivity before the cursor is hidden (requires hideInactiveCursor).

hideInactiveCursor

var hideInactiveCursor: Boolean

Hide the mouse cursor when it is inactive.

highlight

var highlight: Highlight

Code-highlighting theme (requires enableHighlight).

history

var history: Boolean

Push every slide change into browser history. Implies hash = true.

jumpToSlide

var jumpToSlide: Boolean

Jump-to-slide UI (reveal.js 4.5+). Allows typing a slide number to jump directly.

keyboard

var keyboard: Boolean

Enable keyboard shortcuts for navigation.

keyboardCondition

var keyboardCondition: String

Optional keyboard-event gate. If set to "focused", embedded decks only receive keyboard events when they have focus.

kslidesManagedValues

val kslidesManagedValues: MutableMap<String, Any>

Values consumed by kslides itself (theme, highlight plugin, corner links, iframe sizing, etc.).

loop

var loop: Boolean

Loop the presentation back to the first slide after the last.

margin

var margin: Float

Fraction of the display size left empty around the content. reveal.js default: 0.04.

maxScale

var maxScale: Float

Upper bound on the scale factor applied to fit content in the viewport.

minScale

var minScale: Float

Lower bound on the scale factor applied to fit content in the viewport.

mobileViewDistance

var mobileViewDistance: Int

Like viewDistance but for mobile devices; typically lower to conserve resources.

mouseWheel

var mouseWheel: Boolean

Enable slide navigation via the mouse wheel.

navigationMode

var navigationMode: String

Navigation mode. One of:

overview

var overview: Boolean

Enable the slide overview (keyboard: o or esc).

pause

var pause: Boolean

Allow pausing the presentation (blackout) with the b / . keys.

pdfMaxPagesPerSlide

var pdfMaxPagesPerSlide: Int

Maximum number of pages a single slide can span when printing to PDF (unlimited by default).

pdfPageHeightOffset

var pdfPageHeightOffset: Int

Pixel offset subtracted from each exported PDF page's content height to avoid clipping in specific PDF renderers (CLI tools like phantomjs and wkpdf tend to render one pixel differently from in-browser printing).

pdfSeparateFragments

var pdfSeparateFragments: Boolean

When true, each fragment is printed on a separate PDF page.

postMessage

var postMessage: Boolean

Expose the reveal.js API via window.postMessage.

postMessageEvents

var postMessageEvents: Boolean

Dispatch every reveal.js event to the parent window via postMessage.

preloadIframes

var preloadIframes: Boolean

Global override for iframe lazy loading.

previewLinks

var previewLinks: Boolean

When true, links open in an iframe preview overlay. Individual links can opt out with data-preview-link="false".

progress

var progress: Boolean

Display the presentation progress bar.

respondToHashChanges

var respondToHashChanges: Boolean

When true, reveal.js watches the URL hash and navigates on changes.

revealjsManagedValues

val revealjsManagedValues: MutableMap<String, Any>

Values that correspond to documented reveal.js config options.

rtl

var rtl: Boolean

Right-to-left presentation direction.

scrollActivationWidth

var scrollActivationWidth: Int

Minimum viewport width in pixels before switching to scroll view.

scrollLayout

var scrollLayout: ScrollLayout

Scroll-view layout (reveal.js 5.0+).

scrollProgress

var scrollProgress: Any

Scroll-progress indicator in scroll view.

scrollSnap

var scrollSnap: Any

Scroll-snap behavior (reveal.js 5.0+).

showNotes

var showNotes: Boolean

When true, speaker notes are rendered inline for all viewers instead of in the speaker view.

showSlideNumber

var showSlideNumber: String

Context in which the slide number is displayed. "all", "print" (PDF only), or "speaker" (speaker view only).

shuffle

var shuffle: Boolean

Randomize slide order on each page load.

slideNumber

var slideNumber: Any

Slide-number display.

theme

var theme: PresentationTheme

reveal.js theme.

title

var title: String

Browser tab title. Blank omits the <title> element.

topLeftHref

var topLeftHref: String

URL for the top-left corner link. Blank hides the corner element.

topLeftSvg

var topLeftSvg: String

Inline SVG rendered inside the top-left corner link. Mutually useful with topLeftSvgSrc.

topLeftSvgClass

var topLeftSvgClass: String

CSS class on the top-left corner <img>/SVG.

topLeftSvgSrc

var topLeftSvgSrc: String

URL of an image to display in the top-left corner link (alternative to topLeftSvg).

topLeftSvgStyle

var topLeftSvgStyle: String

Inline CSS on the top-left corner <img>/SVG.

topLeftTarget

var topLeftTarget: HrefTarget

<a target> value for the top-left corner link.

topLeftText

var topLeftText: String

Text rendered inside the top-left corner link (after any SVG).

topLeftTitle

var topLeftTitle: String

Tooltip / screen-reader title for the top-left corner link.

topRightHref

var topRightHref: String

URL for the top-right corner link. Blank hides the corner element.

topRightSvg

var topRightSvg: String

Inline SVG rendered inside the top-right corner link.

topRightSvgClass

var topRightSvgClass: String

CSS class on the top-right corner <img>/SVG.

topRightSvgSrc

var topRightSvgSrc: String

URL of an image for the top-right corner link.

topRightSvgStyle

var topRightSvgStyle: String

Inline CSS on the top-right corner <img>/SVG.

topRightTarget

var topRightTarget: HrefTarget

<a target> value for the top-right corner link.

topRightText

var topRightText: String

Text rendered inside the top-right corner link (after any SVG).

topRightTitle

var topRightTitle: String

Tooltip / screen-reader title for the top-right corner link.

touch

var touch: Boolean

Enable touch navigation on touch-capable devices.

transition

var transition: Transition

Default slide-transition style (see Transition).

transitionSpeed

var transitionSpeed: Speed

Default slide-transition speed (see Speed).

view

var view: ViewType

Presentation view mode (reveal.js 5.0+): classic deck vs scrolling document.

viewDistance

var viewDistance: Int

Number of slides in each direction that remain in the DOM for smooth transitions.

width

var width: Any

"Normal" presentation width. Aspect ratio is preserved when scaling to the viewport. May be an integer (pixels) or a percentage string. reveal.js default: 960.