ProvidedValue

Artifact: androidx.compose.runtime:runtime

View Source

Added in 1.0.0

Common/AllAndroid/JVMNative/C/iOSJavaScript

• Cmn

  class ProvidedValue<T : Any?>

---

An instance to hold a value provided by CompositionLocalProvider and is created by the ProvidableCompositionLocal.provides infix operator. If canOverride is false, the provided value will not overwrite a potentially already existing value in the scope.

This value cannot be created directly. It can only be created by using one of the provides operators of ProvidableCompositionLocal.

See also
provides
providesDefault
providesComputed

Summary

Public properties
Boolean	canOverride This value is true if the provided value will override any value provided above it.	Cmn
CompositionLocal<T>	compositionLocal The composition local that is provided by this value.	Cmn
T	value The value provided by the ProvidableCompositionLocal.provides infix operator.	Cmn

Public properties

canOverride

Cmn

Added in 1.0.0

val canOverride: Boolean

This value is true if the provided value will override any value provided above it. This value is true when using ProvidableCompositionLocal.provides but false when using ProvidableCompositionLocal.providesDefault.

See also
provides
providesDefault

compositionLocal

Cmn

Added in 1.0.0

val compositionLocal: CompositionLocal<T>

The composition local that is provided by this value. This is the left-hand side of the ProvidableCompositionLocal.provides infix operator.

value

Cmn

Added in 1.0.0

val value: T

The value provided by the ProvidableCompositionLocal.provides infix operator. This is the right-hand side of the operator.