swing-ui/org.jetbrains.compose.swing.defaults

Package-level declarations

Types

ComponentDefaultKey

@Stable

class ComponentDefaultKey<V : Any>

An identity key naming an independent part of a scoped cascade of inheritable modifier declarations.

ProvidedComponentDefault

class ProvidedComponentDefault<V : Any>

A token binding a ComponentDefaultKey to an optional value to be passed to ProvideComponentDefaults.

Properties

current

@get:Composable

@get:ReadOnlyComposable

val <V : Any> ComponentDefaultKey<V>.current: V?

Reads the nearest surviving value provided for this key in the current composition hierarchy, or null when the key is absent or was removed.

DefaultBackground

val DefaultBackground: ComponentDefaultKey<Color>

Key for the default background color applied to descendants via background.

DefaultComponentOrientation

val DefaultComponentOrientation: ComponentDefaultKey<ComponentOrientation>

Key for the default component orientation applied to descendants via componentOrientation.

DefaultCursor

val DefaultCursor: ComponentDefaultKey<Cursor>

Key for the default cursor applied to descendants via cursor.

DefaultEnabled

val DefaultEnabled: ComponentDefaultKey<Boolean>

Key for the default enabled flag applied to descendants via enabled.

DefaultFont

val DefaultFont: ComponentDefaultKey<Font>

Key for the default font applied to descendants via font.

DefaultForeground

val DefaultForeground: ComponentDefaultKey<Color>

Key for the default foreground color applied to descendants via foreground.

DefaultOpaque

val DefaultOpaque: ComponentDefaultKey<Boolean>

Key for the default opaque flag applied to compatible descendants via opaque.

Functions

componentDefaultKeyOf

fun <V : Any> componentDefaultKeyOf(name: String, apply: SwingModifier.(V) -> SwingModifier): ComponentDefaultKey<V>

Creates a new ComponentDefaultKey with identity equality.

ProvideComponentDefaults

@Composable

fun ProvideComponentDefaults(value: ProvidedComponentDefault<*>, content: @Composable () -> Unit)

Scopes a single inherited component default declaration over content.

@Composable

fun ProvideComponentDefaults(vararg values: ProvidedComponentDefault<*>, content: @Composable () -> Unit)

Scopes multiple inherited component default declarations over content.

provides

infix fun <V : Any> ComponentDefaultKey<V>.provides(value: V?): ProvidedComponentDefault<V>

Binds this ComponentDefaultKey to value for use in ProvideComponentDefaults.