dom-dsl/com.j0y.joy.dom.dsl

Package-level declarations

Types

BreakpointBuilder

class BreakpointBuilder

Builder for a Breakpoint: its match conditions plus the per-id node and style overrides.

ElementSink

sealed interface ElementSink

Receiver for the HTML tag helpers in HtmlTags.kt (div, span, p, img, h1–h6, tag).

EventParamsBuilder

class EventParamsBuilder

Builder for an Event's static params map, accumulating typed key/value entries.

JoyDomDsl

@DslMarker

annotation class JoyDomDsl

DslMarker for the joy-dom builder DSL.

LayoutScope

class LayoutScope : ElementSink

ElementSink for a layout { ... } body that captures the single root Node.

MediaQueryBuilder

class MediaQueryBuilder

Builds a list of MediaQuery conditions for a responsive breakpoint.

NodeBuilder

class NodeBuilder(type: String) : ElementSink

Builder for a single Node of element type, collecting its props and children.

NodePropsBuilder

class NodePropsBuilder

Builder for a node's NodeProps: its id, classes, inline style, and event bindings.

SpecBuilder

class SpecBuilder

Builder for a top-level Spec: its style record, breakpoints, and root layout node.

StyleBuilder

class StyleBuilder

Mutable builder for a Style block. Each property mirrors a CSS property of the same name; leaving one null omits it (the cascade/UA defaults apply). build assembles the Style.

Properties

color

val String.color: <Error class: unknown class>

Parses any supported CSS color string into a Color.

percent

val Double.percent: <Error class: unknown class>

This Double as a percentage Length (Length.Unit.Percent), e.g. 33.3.percent.

val Int.percent: <Error class: unknown class>

This Int as a percentage Length (Length.Unit.Percent), e.g. 50.percent.

val Double.px: <Error class: unknown class>

This Double as a pixel Length (Length.Unit.Px), e.g. 0.5.px.

val Int.px: <Error class: unknown class>

This Int as a pixel Length (Length.Unit.Px), e.g. 16.px.

Functions

div

fun ElementSink.div(block: NodeBuilder.() -> Unit = {})

Appends a div element to this sink.

fun ElementSink.h1(block: NodeBuilder.() -> Unit = {})

Appends an h1 heading element to this sink.

fun ElementSink.h2(block: NodeBuilder.() -> Unit = {})

Appends an h2 heading element to this sink.

fun ElementSink.h3(block: NodeBuilder.() -> Unit = {})

Appends an h3 heading element to this sink.

fun ElementSink.h4(block: NodeBuilder.() -> Unit = {})

Appends an h4 heading element to this sink.

fun ElementSink.h5(block: NodeBuilder.() -> Unit = {})

Appends an h5 heading element to this sink.

fun ElementSink.h6(block: NodeBuilder.() -> Unit = {})

Appends an h6 heading element to this sink.

hex

fun hex(value: String): <Error class: unknown class>

Parses a hex color literal (#rgb, #rgba, #rrggbb, or #rrggbbaa) into a Color.Hex.

hsl

fun hsl(hue: Double, saturationPct: Double, lightnessPct: Double, alpha: Double = 1.0): <Error class: unknown class>

Builds a Color.Hsl (hsl(h, s%, l%)).

img

fun ElementSink.img(block: NodeBuilder.() -> Unit = {})

Appends an img element to this sink.

lab

fun lab(lightness: Double, a: Double, b: Double, alpha: Double = 1.0): <Error class: unknown class>

Builds a CIE Color.Lab color.

node

fun node(type: String, block: NodeBuilder.() -> Unit = {}): <Error class: unknown class>

Builds a standalone Node of the given type via NodeBuilder.

oklch

fun oklch(lightness: Double, chroma: Double, hue: Double, alpha: Double = 1.0): <Error class: unknown class>

Builds a Color.Oklch color.

fun ElementSink.p(block: NodeBuilder.() -> Unit = {})

Appends a p (paragraph) element to this sink.

rgb

fun rgb(r: Int, g: Int, b: Int): <Error class: unknown class>

Constructs an opaque Color.Rgb from 0..255 channel ints.

rgba

fun rgba(r: Int, g: Int, b: Int, a: Double): <Error class: unknown class>

Constructs a Color.Rgba with alpha expressed as a 0.0..1.0 fraction (CSS rgba() convention).

span

fun ElementSink.span(block: NodeBuilder.() -> Unit = {})

Appends a span element to this sink.

spec

fun spec(block: SpecBuilder.() -> Unit): <Error class: unknown class>

Entry point of the DSL: builds a Spec document by running block against a SpecBuilder.

style

fun style(block: StyleBuilder.() -> Unit): <Error class: unknown class>

Builds a Style block (a CSS-style rule body) from the DSL block.