Package-level declarations

Types

Link copied to clipboard
annotation class ExperimentalHazeApi
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Default values for the hazeSource and hazeEffect modifiers.

Link copied to clipboard
interface HazeEffectScope
Link copied to clipboard
sealed interface HazeInputScale

Value classes used for HazeEffectScope.inputScale.

Link copied to clipboard
object HazeLogger
Link copied to clipboard
sealed interface HazeProgressive

Parameters for applying a progressive blur effect.

Link copied to clipboard
class HazeState(initialBlurEnabled: Boolean)
Link copied to clipboard
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.

Link copied to clipboard
data class HazeTint

Describes a 'tint' drawn by the haze effect.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class Poko

Properties

Link copied to clipboard

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

Functions

Link copied to clipboard
Link copied to clipboard
fun Modifier.hazeChild(state: HazeState, style: HazeStyle = HazeStyle.Unspecified, block: HazeEffectScope.() -> Unit? = null): Modifier
Link copied to clipboard
fun HazeDialog(hazeState: HazeState, onDismissRequest: () -> Unit, properties: DialogProperties = DialogProperties(), content: @Composable () -> Unit)
Link copied to clipboard
fun Modifier.hazeEffect(style: HazeStyle = HazeStyle.Unspecified, block: HazeEffectScope.() -> Unit? = null): Modifier

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

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

Draw the 'haze' effect behind the attached node.

Link copied to clipboard
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.

Link copied to clipboard
fun rememberHazeState(blurEnabled: Boolean = HazeDefaults.blurEnabled()): HazeState