RetainedEffectScope

Artifact: androidx.compose.runtime:runtime-retain

Cmn
```
class RetainedEffectScope
```

Receiver scope for RetainedEffect that offers the onRetire clause that should be the last statement in any call to RetainedEffect.

Summary

Public constructors
`RetainedEffectScope()`	Cmn

Public functions
`inline RetainedEffectResult`	`onRetire(crossinline onRetiredEffect: () -> Unit)` Provide `onRetiredEffect` to the `RetainedEffect` to run when it leaves the composition or its key changes.	Cmn

Public constructors

RetainedEffectScope

Cmn

RetainedEffectScope()

Public functions

onRetire

Cmn

inline fun onRetire(crossinline onRetiredEffect: () -> Unit): RetainedEffectResult

Provide onRetiredEffect to the RetainedEffect to run when it leaves the composition or its key changes.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-06-17 UTC.

X
Follow @AndroidDev on X
YouTube
Check out Android Developers on YouTube
LinkedIn
Connect with the Android Developers community on LinkedIn