silk-foundation/com.varabyte.kobweb.silk.style

Package-level declarations

Types

ColorModeStrategy

enum ColorModeStrategy : Enum<ColorModeStrategy>

An enum indicating how Silk will register color mode aware styles.

ComponentKind

interface ComponentKind : CssKind

CssKind

sealed interface CssKind

A base interface for all CssStyle types.

CssLayer

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class CssLayer(val name: String)

An annotation that can be applied to a CssStyle property to override its default layer.

CssName

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class CssName(val name: String)

An annotation that can be applied to a CssStyle or CssStyleVariant property to override its default name.

CssPrefix

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class CssPrefix(val prefix: String)

An annotation that can be applied to a CssStyle or CssStyleVariant property to add a prefix to the generated CSS class name.

CssRule

sealed class CssRule

A class which can be used to create type-safe CSS rules that can be applied to a StyleScope instance.

CssStyle

abstract class CssStyle<K : CssKind>

A class which allows a user to define styles that will be added into the site's CSS stylesheet.

CssStyleBaseScope

class CssStyleBaseScope : CssStyleScopeBase

A simplified subset of CssStyleScope.

CssStyleScope

class CssStyleScope : StyleScope, CssStyleScopeBase

An extension to StyleScope which adds extra information only relevant to CssStyle blocks.

CssStyleScopeBase

interface CssStyleScopeBase

Properties that all css style scope implementations promise to support.

CssStyleVariant

abstract class CssStyleVariant<K : ComponentKind>

GeneralKind

sealed interface GeneralKind : CssKind

RestrictedKind

sealed interface RestrictedKind : CssKind

StyleScope

abstract class StyleScope

Class used as the receiver to a callback, allowing the user to define various state-dependent styles (defined via Modifiers).

Properties

useScope

val ColorModeStrategy.useScope: Boolean

Indicates whether color mode aware styles should be registered using the CSS @scope rule.

useSuffix

val ColorModeStrategy.useSuffix: Boolean

Indicates whether color mode aware styles should be registered using _light and _dark suffixes.

Functions

addVariant

fun <K : ComponentKind> CssStyle<K>.addVariant(extraModifier: Modifier = Modifier, init: CssStyleScope.() -> Unit): CssStyleVariant<K>

fun <K : ComponentKind> CssStyle<K>.addVariant(extraModifier: @Composable () -> Modifier, init: CssStyleScope.() -> Unit): CssStyleVariant<K>

addVariantBase

fun <K : ComponentKind> CssStyle<K>.addVariantBase(extraModifier: Modifier = Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyleVariant<K>

fun <K : ComponentKind> CssStyle<K>.addVariantBase(extraModifier: @Composable () -> Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyleVariant<K>

Convenience method when you only care about registering the base style, which can help avoid a few extra lines.

base

fun CssStyle.Companion.base(extraModifier: Modifier = Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<GeneralKind>

fun <K : ComponentKind> CssStyle.Companion.base(extraModifier: Modifier = Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<K>

fun CssStyle.Companion.base(extraModifier: @Composable () -> Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<GeneralKind>

fun <K : ComponentKind> CssStyle.Companion.base(extraModifier: @Composable () -> Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<K>

between

fun StyleScope.between(lower: Breakpoint, upper: Breakpoint, createModifier: () -> Modifier)

Declare a style that applies between a lower breakpoint (inclusive) and an upper breakpoint (exclusive).

combine

fun <K : ComponentKind> Iterable<CssStyleVariant<K>?>.combine(): CssStyleVariant<K>?

A convenience method for folding a list of component variants into one single one that represents all of them.

cssRule

fun StyleScope.cssRule(breakpoint: Breakpoint, suffix: String?, createModifier: () -> Modifier)

Convenience method for tying a general CSS rule to a breakpoint.

fun StyleScope.cssRule(breakpointRange: Breakpoint.Range, suffix: String?, createModifier: () -> Modifier)

Convenience method for tying a general CSS rule to a breakpoint range.

cssRules

fun StyleScope.cssRules(vararg rules: CssRule, createModifier: () -> Modifier)

A way you can define multiple rules which all result in the same style.

CssStyle

fun CssStyle(extraModifier: Modifier = Modifier, init: CssStyleScope.() -> Unit): CssStyle<GeneralKind>

fun <K : ComponentKind> CssStyle(extraModifier: Modifier = Modifier, init: CssStyleScope.() -> Unit): CssStyle<K>

fun CssStyle(extraModifier: @Composable () -> Modifier, init: CssStyleScope.() -> Unit): CssStyle<GeneralKind>

fun <K : ComponentKind> CssStyle(extraModifier: @Composable () -> Modifier, init: CssStyleScope.() -> Unit): CssStyle<K>

extendedBy

fun <K : ComponentKind> CssStyleVariant<K>.extendedBy(extraModifier: Modifier = Modifier, init: CssStyleScope.() -> Unit): CssStyleVariant<K>

fun <K : ComponentKind> CssStyleVariant<K>.extendedBy(extraModifier: @Composable () -> Modifier, init: CssStyleScope.() -> Unit): CssStyleVariant<K>

fun CssStyle<GeneralKind>.extendedBy(extraModifier: Modifier = Modifier, init: CssStyleScope.() -> Unit): CssStyle<GeneralKind>

fun CssStyle<GeneralKind>.extendedBy(extraModifier: @Composable () -> Modifier, init: CssStyleScope.() -> Unit): CssStyle<GeneralKind>

extendedByBase

fun <K : ComponentKind> CssStyleVariant<K>.extendedByBase(extraModifier: Modifier = Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyleVariant<K>

fun <K : ComponentKind> CssStyleVariant<K>.extendedByBase(extraModifier: @Composable () -> Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyleVariant<K>

fun CssStyle<GeneralKind>.extendedByBase(extraModifier: Modifier = Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<GeneralKind>

fun CssStyle<GeneralKind>.extendedByBase(extraModifier: @Composable () -> Modifier, init: CssStyleBaseScope.() -> Modifier): CssStyle<GeneralKind>

plus

operator fun BreakpointQueryProvider.plus(other: CssRule.OfPseudoClass): CssRule.CompositeOpen

operator fun BreakpointQueryProvider.plus(other: CssRule.OfPseudoElement): CssRule.CompositeClosed

thenIf

fun <K : ComponentKind> CssStyleVariant<K>.thenIf(condition: Boolean, other: CssStyleVariant<K>): CssStyleVariant<K>

fun <K : ComponentKind> CssStyleVariant<K>.thenIf(condition: Boolean, produce: () -> CssStyleVariant<K>): CssStyleVariant<K>

thenUnless

fun <K : ComponentKind> CssStyleVariant<K>.thenUnless(condition: Boolean, other: CssStyleVariant<K>): CssStyleVariant<K>

fun <K : ComponentKind> CssStyleVariant<K>.thenUnless(condition: Boolean, produce: () -> CssStyleVariant<K>): CssStyleVariant<K>

toAttrs

@Composable

fun <A : AttrsScope<*>> CssStyle<GeneralKind>.toAttrs(finalHandler: A.() -> Unit? = null): A.() -> Unit

@Composable

fun <A : AttrsScope<*>> Iterable<CssStyle<GeneralKind>>.toAttrs(finalHandler: A.() -> Unit? = null): A.() -> Unit

toModifier

@Composable

fun CssStyle<GeneralKind>.toModifier(): Modifier

@Composable

fun CssStyle<RestrictedKind>.toModifier(): Modifier

@Composable

fun Iterable<CssStyle<GeneralKind>>.toModifier(): Modifier

@Composable

fun <K : ComponentKind> CssStyle<K>.toModifier(vararg variants: CssStyleVariant<K>?): Modifier

until

fun StyleScope.until(breakpoint: Breakpoint, createModifier: () -> Modifier)

Declare a style that applies up until the current breakpoint.