kslides-core/com.kslides.config/SlideConfig

SlideConfig

Per-slide configuration that can also be set at the global or presentation level and cascaded. Most values are emitted as data-* attributes on the slide's <section> at render time.

Transitions: set transition for a symmetric in/out transition, or transitionIn / transitionOut for independent directions; unset values fall back to Transition.SLIDE.

Backgrounds: background is a generic color/image string (reveal.js data-background); the more-specific background* properties map to data-background-color, data-background-image, etc.

Constructors

SlideConfig

constructor()

Properties

background

var background: String

reveal.js data-background — any valid color or image reference.

backgroundColor

var backgroundColor: String

Solid background color (data-background-color).

backgroundIframe

var backgroundIframe: String

URL of an iframe shown as the slide background.

backgroundImage

var backgroundImage: String

URL for a full-slide background image (data-background-image).

backgroundInteractive

var backgroundInteractive: Boolean

When true, the background iframe receives user input instead of reveal.js.

backgroundOpacity

var backgroundOpacity: Double

Background opacity in the range 0.0..1.0. -1.0 omits the attribute.

backgroundPosition

var backgroundPosition: String

CSS background-position.

backgroundRepeat

var backgroundRepeat: String

CSS background-repeat.

backgroundSize

var backgroundSize: String

CSS background-size ("cover", "contain", or explicit dimensions).

backgroundTransition

var backgroundTransition: Transition

Transition style for full-page slide backgrounds.

backgroundVideo

var backgroundVideo: String

URL of a video shown as the slide background (data-background-video).

backgroundVideoLoop

var backgroundVideoLoop: Boolean

Loop the background video.

backgroundVideoMuted

var backgroundVideoMuted: Boolean

Mute the background video.

disableTrimIndent

var disableTrimIndent: Boolean

(Markdown + HtmlSlide) When true, the renderer skips trimIndent() on slide content. Set this if your content has meaningful leading whitespace.

indentToken

var indentToken: String

(Markdown + HtmlSlide) Placeholder token the renderer replaces with the slide's current indentation level when including external content via com.kslides.include.

kslidesManagedValues

val kslidesManagedValues: MutableMap<String, Any>

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

markdownCharset

var markdownCharset: String

(MarkdownSlide only) Character set (data-charset) when loading external Markdown.

markdownNotesSeparator

var markdownNotesSeparator: String

(MarkdownSlide only) Speaker-notes separator regex (data-separator-notes). Only emitted when both markdownSeparator and markdownVerticalSeparator are also set; setting data-separator-notes in isolation would disable the default --- / -- separators.