haze/dev.chrisbanes.haze

Package-level declarations

Types

ExperimentalHazeApi

annotation class ExperimentalHazeApi

HazeArea

@Stable

class HazeArea

HazeChildScope

interface ~~HazeChildScope~~ : HazeEffectScope

HazeDefaults

object HazeDefaults

Default values for the hazeSource and hazeEffect modifiers.

HazeEffectNode

class HazeEffectNode(var state: HazeState? = null, style: HazeStyle = HazeStyle.Unspecified, var block: HazeEffectScope.() -> Unit? = null) : Modifier.Node, CompositionLocalConsumerModifierNode, GlobalPositionAwareModifierNode, LayoutAwareModifierNode, ObserverModifierNode, DrawModifierNode, TraversableNode, HazeEffectScope

The Modifier.Node implementation used by Modifier.hazeEffect.

HazeEffectScope

interface HazeEffectScope

HazeInputScale

sealed interface HazeInputScale

Value classes used for HazeEffectScope.inputScale.

HazeLogger

object HazeLogger

HazeProgressive

@Immutable

sealed interface HazeProgressive

Parameters for applying a progressive blur effect.

HazeSourceNode

class HazeSourceNode(state: HazeState, zIndex: Float = 0.0f, key: Any? = null) : Modifier.Node, CompositionLocalConsumerModifierNode, GlobalPositionAwareModifierNode, LayoutAwareModifierNode, DrawModifierNode, TraversableNode, ObserverModifierNode

The Modifier.Node implementation used by Modifier.hazeSource.

HazeState

@Stable

class HazeState(initialBlurEnabled: Boolean)

HazeStyle

@Immutable

data class HazeStyle(val backgroundColor: Color = Color.Unspecified, val tints: List<HazeTint> = emptyList(), val blurRadius: Dp = Dp.Unspecified, val noiseFactor: Float = -1f, val fallbackTint: HazeTint = HazeTint.Unspecified)

A holder for the style properties used by Haze.

HazeTint

@Stable

data class HazeTint

Describes a 'tint' drawn by the haze effect.

Poko

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Poko

Properties

LocalHazeStyle

val LocalHazeStyle: ProvidableCompositionLocal<HazeStyle>

A ProvidableCompositionLocal which provides the default HazeStyle for all hazeEffect layout nodes placed within this composition local's content.

Functions

haze

@Stable

fun Modifier.~~haze~~(state: HazeState): Modifier

hazeChild

@Stable

fun Modifier.~~hazeChild~~(state: HazeState, style: HazeStyle = HazeStyle.Unspecified, block: HazeEffectScope.() -> Unit? = null): Modifier

HazeDialog

@Composable

fun ~~HazeDialog~~(hazeState: HazeState, onDismissRequest: () -> Unit, properties: DialogProperties = DialogProperties(), content: @Composable () -> Unit)

hazeEffect

@Stable

fun Modifier.hazeEffect(style: HazeStyle = HazeStyle.Unspecified, block: HazeEffectScope.() -> Unit? = null): Modifier

Draw the 'haze' effect, using this node's content as the source.

@Stable

fun Modifier.hazeEffect(state: HazeState?, style: HazeStyle = HazeStyle.Unspecified, block: HazeEffectScope.() -> Unit? = null): Modifier

Draw the 'haze' effect behind the attached node.

hazeSource

@Stable

fun Modifier.hazeSource(state: HazeState, zIndex: Float = 0.0f, key: Any? = null): Modifier

Captures background content for hazeEffect child nodes, which will be drawn with a blur in a 'glassmorphism' style.

rememberHazeState

@Composable

fun rememberHazeState(blurEnabled: Boolean = HazeDefaults.blurEnabled()): HazeState