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. Resolves like backgroundImage.

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), or a comma-separated list of sources. Each source is trimmed and resolves like backgroundImage; a data: URI is passed through whole, since it carries a comma of its own.

backgroundVideoLoop

var backgroundVideoLoop: Boolean

Loop the background video.

backgroundVideoMuted

var backgroundVideoMuted: Boolean

Mute the background video.

codeFontSize

var codeFontSize: String

Font size for code blocks (<pre>) on the slide (e.g. "0.60em"). Rendered as a generated CSS class + head rule because reveal.js renders Markdown client-side. Blank inherits reveal.js's default (0.55em).

codeWrap

var codeWrap: Boolean

When true, long code lines wrap (white-space: pre-wrap; word-break: break-word) instead of overflowing horizontally. A slide can set false to override a presentation-level true.

disableTrimIndent

var disableTrimIndent: Boolean

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

fontSize

var fontSize: String

Font size for all content on the slide — any CSS length (e.g. "34px", "0.9em"). Rendered as an inline font-size on the slide's <section>; reveal.js themes size headings/text in em, so everything scales. Blank inherits the theme default.

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.

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.

markdownSeparator

var markdownSeparator: String

(MarkdownSlide only) Horizontal-slide separator regex (data-separator).

markdownVerticalSeparator

var markdownVerticalSeparator: String

(MarkdownSlide only) Vertical-slide separator regex (data-separator-vertical).

transition

var transition: Transition

Slide-transition style for both directions. Transition.UNASSIGNED inherits.

transitionIn

var transitionIn: Transition

Inbound slide transition. Transition.UNASSIGNED uses transition instead.

transitionOut

var transitionOut: Transition

Outbound slide transition. Transition.UNASSIGNED uses transition instead.

transitionSpeed

var transitionSpeed: Speed

Transition speed. Speed.UNASSIGNED inherits.

Functions

merge

open fun merge(other: AbstractConfig)

Merge other into this config in place: every entry from other's two maps is copied into this config's maps, with later puts overwriting earlier keys. This is how the global → presentation → slide cascade resolves (parent merged first, then child).

revealjsOption

open fun revealjsOption(key: String, value: Any)

Set a raw reveal.js config option by key for options kslides does not expose as a typed property (e.g. the menu plugin's themes array). The value is emitted verbatim into the Reveal.initialize({...}) call and participates in the config cascade like any other option. Prefer the typed properties where they exist.