# androidx.lifecycle.compose

Common/All

## Interfaces

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecyclePauseOrDisposeEffectResult` | Interface used for `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleResumeEffect.composable#LifecycleResumeEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` to run the effect within the onPauseOrDispose clause when an (ON_PAUSE)`https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event#ON_PAUSE` event is received or when cleanup is | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStopOrDisposeEffectResult` | Interface used for `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` to run the effect within the onStopOrDispose clause when an (ON_STOP)`https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event#ON_STOP` event is received or when cleanup is needed for the work that was kicked off in the ON_START effect. | Cmn |

## Classes

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleResumePauseEffectScope` | Receiver scope for `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleResumeEffect.composable#LifecycleResumeEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` that offers the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleResumePauseEffectScope#onPauseOrDispose(kotlin.Function1)` clause to couple the ON_RESUME effect. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope` | Receiver scope for `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` that offers the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartStopEffectScope#onStopOrDispose(kotlin.Function1)` clause to couple the ON_START effect. | Cmn |

## Composables

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleEventEffect.composable` | Schedule an effect to run when the `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle` receives a specific `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleResumeEffect.composable` | It is an error to call `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(kotlin.Any,androidx.lifecycle.LifecycleOwner,kotlin.Function1)` without at least one `key` parameter. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable` | It is an error to call `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/LifecycleStartEffect.composable#LifecycleStartEffect(androidx.lifecycle.LifecycleOwner,kotlin.Function1)` without at least one `key` parameter. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/collectAsStateWithLifecycle.composable` | Collects values from this `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` and represents its latest value via `https://developer.android.com/reference/kotlin/androidx/compose/runtime/State` in a lifecycle-aware manner. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/currentStateAsState.composable` | Collects values from the `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle#currentStateFlow()` and represents its latest value via `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/dropUnlessResumed.composable` | Returns a new decorated function that will invoke the given `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/package-summary#dropUnlessResumed(androidx.lifecycle.LifecycleOwner,kotlin.Function0)` if the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/package-summary#dropUnlessResumed(androidx.lifecycle.LifecycleOwner,kotlin.Function0)`'s lifecycle state is at least `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State#RESUMED`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/dropUnlessStarted.composable` | Returns a new decorated function that will invoke the given `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/package-summary#dropUnlessStarted(androidx.lifecycle.LifecycleOwner,kotlin.Function0)` if the `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/package-summary#dropUnlessStarted(androidx.lifecycle.LifecycleOwner,kotlin.Function0)`'s lifecycle state is at least `https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.State#STARTED`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/rememberLifecycleOwner.composable` | Remembers a new `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner` with a lifecycle that is a child of the parent composition's lifecycle. | Cmn |

## Top-level properties summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal<https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner>` | `https://developer.android.com/reference/kotlin/androidx/lifecycle/compose/package-summary#LocalLifecycleOwner()` The CompositionLocal containing the current `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner`. | Cmn |

## Top-level properties

### LocalLifecycleOwner

Cmn Artifact: [androidx.lifecycle:lifecycle-runtime-compose](https://developer.android.com/jetpack/androidx/releases/lifecycle) [View Source](https://cs.android.com/search?q=file:androidx/lifecycle/compose/LocalLifecycleOwner.kt+symbol:LocalLifecycleOwner) Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.8.0)

```
val LocalLifecycleOwner: ProvidableCompositionLocal<LifecycleOwner>
```

The CompositionLocal containing the current `https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner`.