kslides-core/com.kslides.slide/DslSlide

DslSlide

Shared contract for slides whose content is authored with the kotlinx.html DSL. Implemented by HorizontalDslSlide and VerticalDslSlide. This is the only slide type that can host the extension DSLs (com.kslides.playground, com.kslides.diagram, com.kslides.codeSnippet, letsPlot{}).

Members prefixed with private_ are implementation details (crossing the DSL/renderer boundary) and should not be called by user code. The exposed global*Config / presentation*Config / *Path accessors are intended for extension DSLs that need to look up merged configuration and output paths when generating iframe content.

Inheritors

HorizontalDslSlide

VerticalDslSlide

Properties

classes

abstract var classes: String

CSS class list applied to the <section>.

globalDiagramConfig

open val globalDiagramConfig: DiagramConfig

Global default com.kslides.config.DiagramConfig for com.kslides.diagram calls.

globalLetsPlotConfig

open val globalLetsPlotConfig: LetsPlotIframeConfig

Global default com.kslides.config.LetsPlotIframeConfig for letsPlot{} calls.

globalPlaygroundConfig

open val globalPlaygroundConfig: PlaygroundConfig

Global default com.kslides.config.PlaygroundConfig for com.kslides.playground calls.

abstract var id: String

HTML id applied to the <section>; blank omits the attribute.

krokiPath

open val krokiPath: String

Filesystem directory where Kroki diagram files are written.

letsPlotJsVersion

open val letsPlotJsVersion: String

Version of the Lets-Plot JS runtime loaded by generated Lets-Plot iframes.

letsPlotPath

open val letsPlotPath: String

Filesystem directory where Lets-Plot iframe HTML files are written.

playgroundPath

open val playgroundPath: String

Filesystem directory where Playground iframe HTML files are written.

presentation

abstract val presentation: Presentation

The Presentation that owns this slide.

presentationDiagramConfig

open val presentationDiagramConfig: DiagramConfig

Per-presentation com.kslides.config.DiagramConfig overrides.

presentationLetsPlotConfig

open val presentationLetsPlotConfig: LetsPlotIframeConfig

Per-presentation com.kslides.config.LetsPlotIframeConfig overrides.

presentationPlaygroundConfig

open val presentationPlaygroundConfig: PlaygroundConfig

Per-presentation com.kslides.config.PlaygroundConfig overrides.

private_dslAssigned

abstract var private_dslAssigned: Boolean

Implementation detail — do not use.

private_dslBlock

abstract var private_dslBlock: SECTION.() -> Unit

Implementation detail — do not use.

private_iframeCount

abstract var private_iframeCount: Int

Implementation detail — counter for per-slide iframe filenames.

private_slideId

abstract val private_slideId: Int

Implementation detail — unique slide id used to generate iframe filenames.

private_useHttp

abstract var private_useHttp: Boolean

Implementation detail — do not use.

style

abstract var style: String

Inline CSS applied to the <section>; blank omits the attribute.

Functions

diagram

context(section: SECTION)
fun DslSlide.diagram(diagramType: DiagramType, diagramBlock: DiagramDescription.() -> Unit): ERROR CLASS: Ambiguity: diagram, [com/kslides/diagram, com/kslides/diagram]

Type-safe overload of diagram taking a DiagramType enum instead of a raw Kroki type string, so a mistyped diagram type is a compile error. Delegates to the String overload.

context(section: SECTION)
fun DslSlide.diagram(diagramType: String, diagramBlock: DiagramDescription.() -> Unit)

Embed a Kroki-rendered diagram inside a DslSlide content{} block. The diagram source is POSTed to Kroki; the resulting image is cached by filename so repeated renders of the same presentation do not re-hit Kroki.

include

fun DslSlide.include(src: String, linePattern: String = "", beginToken: String = "", endToken: String = "", exclusive: Boolean = true, trimIndent: Boolean = true): String

include variant for use inside a com.kslides.slide.DslSlide content{} block. Same semantics as CODE.include — HTML escaping and the indent token are turned off.

krokiFilename

open fun krokiFilename(filename: String): String

Resolve filename in the Kroki output directory, reachable from this slide's page.

letsPlotFilename

open fun letsPlotFilename(filename: String): String

Resolve filename in the Lets-Plot output directory, reachable from this slide's page.

mermaid

context(section: SECTION)
fun DslSlide.mermaid(source: String)

Embed a client-side Mermaid diagram inside a DslSlide content{} block. Unlike diagram (which renders through a Kroki server), the diagram is rendered in the browser by the Mermaid runtime bundled with kslides — no network access or external service is required, so decks keep working offline.

newFilename

open fun newFilename(suffix: String = "html"): String

Generate a unique per-slide filename for iframe or image content. Each call increments the internal counter so multiple playgrounds / diagrams / plots on the same slide get distinct filenames.

playground

context(section: SECTION)
fun DslSlide.playground(srcName: String, vararg otherSrcs: String = emptyArray(), configBlock: PlaygroundConfig.() -> Unit = {})

Embed an interactive Kotlin Playground iframe inside a DslSlide content{} block. The source file referenced by srcName is inlined into the Playground editor; any otherSrcs are attached as hidden <textarea class="hidden-dependency"> elements that Playground loads alongside the main file.

playgroundFilename

open fun playgroundFilename(filename: String): String

Resolve filename in the Playground output directory, reachable from this slide's page.

processSlide

abstract fun processSlide(section: SECTION)

Apply the slide's attributes to the enclosing <section>. Invoked by the renderer.