Lifecycle
This table lists all the artifacts in the androidx.lifecycle
group.
Artifact | Stable Release | Release Candidate | Beta Release | Alpha Release |
---|---|---|---|---|
lifecycle-* | 2.8.7 | - | - | 2.9.0-alpha06 |
lifecycle-viewmodel-compose | 2.8.7 | - | - | 2.9.0-alpha06 |
Declaring dependencies
To add a dependency on Lifecycle, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.
Add the dependencies for the artifacts you need in the build.gradle
file for
your app or module:
Kotlin
Groovy
dependencies { def lifecycle_version = "2.8.7" def arch_version = "2.2.0" // ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version" // ViewModel utilities for Compose implementation "androidx.lifecycle:lifecycle-viewmodel-compose:$lifecycle_version" // LiveData implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version" // Lifecycles only (without ViewModel or LiveData) implementation "androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version" // Lifecycle utilities for Compose implementation "androidx.lifecycle:lifecycle-runtime-compose:$lifecycle_version" // Saved state module for ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version" // Annotation processor kapt "androidx.lifecycle:lifecycle-compiler:$lifecycle_version" // alternately - if using Java8, use the following instead of lifecycle-compiler implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version" // optional - helpers for implementing LifecycleOwner in a Service implementation "androidx.lifecycle:lifecycle-service:$lifecycle_version" // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version" // optional - ReactiveStreams support for LiveData implementation "androidx.lifecycle:lifecycle-reactivestreams-ktx:$lifecycle_version" // optional - Test helpers for LiveData testImplementation "androidx.arch.core:core-testing:$arch_version" // optional - Test helpers for Lifecycle runtime testImplementation "androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version" }
Kotlin
dependencies { val lifecycle_version = "2.8.7" val arch_version = "2.2.0" // ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version") // ViewModel utilities for Compose implementation("androidx.lifecycle:lifecycle-viewmodel-compose:$lifecycle_version") // LiveData implementation("androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version") // Lifecycles only (without ViewModel or LiveData) implementation("androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version") // Lifecycle utilities for Compose implementation("androidx.lifecycle:lifecycle-runtime-compose:$lifecycle_version") // Saved state module for ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version") // Annotation processor kapt("androidx.lifecycle:lifecycle-compiler:$lifecycle_version") // alternately - if using Java8, use the following instead of lifecycle-compiler implementation("androidx.lifecycle:lifecycle-common-java8:$lifecycle_version") // optional - helpers for implementing LifecycleOwner in a Service implementation("androidx.lifecycle:lifecycle-service:$lifecycle_version") // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation("androidx.lifecycle:lifecycle-process:$lifecycle_version") // optional - ReactiveStreams support for LiveData implementation("androidx.lifecycle:lifecycle-reactivestreams-ktx:$lifecycle_version") // optional - Test helpers for LiveData testImplementation("androidx.arch.core:core-testing:$arch_version") // optional - Test helpers for Lifecycle runtime testImplementation ("androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version") }
Java
Groovy
dependencies { def lifecycle_version = "2.8.7" def arch_version = "2.2.0" // ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version" // LiveData implementation "androidx.lifecycle:lifecycle-livedata:$lifecycle_version" // Lifecycles only (without ViewModel or LiveData) implementation "androidx.lifecycle:lifecycle-runtime:$lifecycle_version" // Saved state module for ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version" // Annotation processor annotationProcessor "androidx.lifecycle:lifecycle-compiler:$lifecycle_version" // alternately - if using Java8, use the following instead of lifecycle-compiler implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version" // optional - helpers for implementing LifecycleOwner in a Service implementation "androidx.lifecycle:lifecycle-service:$lifecycle_version" // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version" // optional - ReactiveStreams support for LiveData implementation "androidx.lifecycle:lifecycle-reactivestreams:$lifecycle_version" // optional - Test helpers for LiveData testImplementation "androidx.arch.core:core-testing:$arch_version" // optional - Test helpers for Lifecycle runtime testImplementation "androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version" }
Kotlin
dependencies { val lifecycle_version = "2.8.7" val arch_version = "2.2.0" // ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version") // LiveData implementation("androidx.lifecycle:lifecycle-livedata:$lifecycle_version") // Lifecycles only (without ViewModel or LiveData) implementation("androidx.lifecycle:lifecycle-runtime:$lifecycle_version") // Saved state module for ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version") // Annotation processor annotationProcessor("androidx.lifecycle:lifecycle-compiler:$lifecycle_version") // alternately - if using Java8, use the following instead of lifecycle-compiler implementation("androidx.lifecycle:lifecycle-common-java8:$lifecycle_version") // optional - helpers for implementing LifecycleOwner in a Service implementation("androidx.lifecycle:lifecycle-service:$lifecycle_version") // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation("androidx.lifecycle:lifecycle-process:$lifecycle_version") // optional - ReactiveStreams support for LiveData implementation("androidx.lifecycle:lifecycle-reactivestreams:$lifecycle_version") // optional - Test helpers for LiveData testImplementation("androidx.arch.core:core-testing:$arch_version") // optional - Test helpers for Lifecycle runtime testImplementation("androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version") }
For more information about dependencies, see Add Build Dependencies.
Feedback
Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.
See the Issue Tracker documentation for more information.
Version 2.9
Version 2.9.0-alpha06
October 30, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha06
is released. Version 2.9.0-alpha06 contains these commits.
Behavior Changes
- The
Lifecycle.DESTROYED
state is terminal, and any attempt to move aLifecycle
from it to any other state will now result in anIllegalStateException
. (I116c4, b/370577987) SavedStateHandle
no longer includes anySavedStateProvider.saveState()
where the returnedBundle
is empty. (I910b5, b/370577987)
Bug Fixes
Lifecycle.eventFlow
now correctly complete whenLifecycle
isDESTROYED
(I293b2, b/374043130)
Version 2.9.0-alpha05
October 16, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha05
is released with no notable changes. Version 2.9.0-alpha05 contains these commits.
Version 2.9.0-alpha04
October 2, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha04
is released. Version 2.9.0-alpha04 contains these commits.
Kotlin Multiplatform
- The
lifecycle-viewmodel-savedstate
module is now configured to be KMP compatible in preparation for APIs likeSavedStateHandle
being made available in the common source set in a future release. (I503ed, I48764, b/334076622)
Version 2.9.0-alpha03
September 18, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha03
is released. Version 2.9.0-alpha03 contains these commits.
Bug Fixes
- From Lifecycle
2.8.6
: TheNullSafeMutableLiveData
Lint error has improved support for smart casts, avoiding false positives. (85fed6, b/181042665)
Dependency Updates
- From Lifecycle
2.8.6
: Lifecycle Runtime Compose now depends on Compose Runtime1.7.1
- Lifecycle Runtime now depends on ProfileInstaller
1.4.0
Version 2.9.0-alpha02
September 4, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha02
is released. Version 2.9.0-alpha02 contains these commits.
Bug Fixes
- From Lifecycle
2.8.5
: Update theandroidx.lifecycle.ReportFragment
ProGuard rules to allow obfuscation . (ff898e1)
External Contribution
- Move
androidx.compose.ui.platform.LocalLifecycleOwner
to common source set (KMP). Thanks Ivan Matkov from JetBrains for the contribution. (8cd5d03) - From Lifecycle
2.8.5
: SavedStateHandle.saveable` extension delegate now supports nullable values. Thanks Roman Kalukiewicz for the contribution. (0d78ea6)
Version 2.9.0-alpha01
August 7, 2024
androidx.lifecycle:lifecycle-*:2.9.0-alpha01
is released. Version 2.9.0-alpha01 contains these commits.
Kotlin Multiplatform
lifecycle-testing
is now KMP compatible. (Iea41e)- Add support for
linuxArm64
kotlin multiplatform target (I139d3, b/338268719)
New Features
- A new
androidx.lifecycle:lifecycle-viewmodel-testing
KMP artifact is available that provides aViewModelScenario
class for testing ViewModels in isolation, with support foronCleared
(all platforms) andSavedStateHandle
(Android only). (337f68d, c9b3409, 9799a95c, b/264602919) - Creating a
ViewModel
withViewModelProvider
is now thread safe;@MainThread
annotations have been removed. (Ifd978, b/237006831)
API Changes
- Add the
CreationExtras.Key()
factory function to simplify the creation of anonymousCreationExtras.Key
objects. (I970ee) CreationExtras
now includes map-like operator overloads to enable idiomatic manipulation of content in Kotlin. It allows the use ofin
,+=
, and+
withCreationExtras
. (Ib4353)CreationExtras
now implementsequals
,hashCode
, andtoString
methods. (Ib4353)NewInstanceFactory
is now available on JVM Desktop and Android targets. (d3d0892)- Inline extension property to expose underlying Application safely in Kotlin language version 2.0 (I39df2)
Bug Fixes
- Removed manual outlining of access to new platform APIs since this happens automatically via API modeling when using R8 with AGP 7.3 or later (e.g. R8 version 3.3) and for all builds when using AGP 8.1 or later (e.g. D8 version 8.1). Clients who are not using AGP are advised to update to D8 version 8.1 or later. See this article for more details. (If6b4c, b/345472586)
Version 2.8
Version 2.8.7
October 30, 2024
androidx.lifecycle:lifecycle-*:2.8.7
is released. Version 2.8.7 contains these commits.
API Changes
androidx.compose.ui.platform.LocalLifecycleOwner
is now available in the common source set (KMP). (6a3f5b3)lifecycle-runtime-compose
:desktop
artifacts were removed and-jvmStubs
and-linuxx64Stubs
artifacts were added. None of these targets are meant to be used, they are placeholders to help Jetbrains Compose efforts. (6a3f5b3)
Version 2.8.6
September 18, 2024
androidx.lifecycle:lifecycle-*:2.8.6
is released. Version 2.8.6 contains these commits.
Bug Fixes
- The
NullSafeMutableLiveData
Lint error has improved support for smart casts, avoiding false positives. (85fed6, b/181042665)
Dependency Updates
- Lifecycle Runtime Compose now depends on Compose Runtime
1.7.1
Version 2.8.5
September 4, 2024
androidx.lifecycle:lifecycle-*:2.8.5
is released. Version 2.8.5 contains these commits.
Bug Fixes
- Update the
androidx.lifecycle.ReportFragment
ProGuard rules to allow obfuscation . (ff898e1)
External Contribution
SavedStateHandle.saveable
extension delegate now supports nullable values. Thanks Roman Kalukiewicz for the contribution. (0d78ea6)
Version 2.8.4
July 24, 2024
androidx.lifecycle:lifecycle-*:2.8.4
is released. Version 2.8.4 contains these commits.
Bug Fixes
LiveData.asFlow()
now correctly handles cases where the returned Flow is immediately completed after receiving a value already set on theLiveData
(for example, when usingtake(1)
). (I9c566)Lifecycle*Effect
completion is now idempotent (i.e., if theonStopOrDispose
was called because of the Lifecycle being stopped, it won’t be called a second time upon disposal unless the Lifecycle goes back up toSTARTED
again). (I5f607, b/352364595)
Version 2.8.3
July 1, 2024
androidx.lifecycle:lifecycle-*:2.8.3
is released. Version 2.8.3 contains these commits.
Bug Fixes
- Fixed an issue with Lifecycle 2.8’s backward compatibility with Compose 1.6.0 and lower when using code shrinking. (aosp/3133056, b/346808608)
Version 2.8.2
June 12, 2024
androidx.lifecycle:lifecycle-*:2.8.2
is released. Version 2.8.2 contains these commits.
Bug Fixes
- Fixed
CompositionLocal LocalLifecycleOwner not present
errors when using Lifecycle 2.8.X with Compose 1.6.X or earlier - you can now use Lifecycle 2.8.2 with any version of Compose without any workarounds required. (aosp/3105647, b/336842920) ViewModelProvider
will no longer crash when mixing previous versions ofcompileOnly
Lifecycle dependencies with versions 2.8+, fixing issues with libraries such as LeakCanary. (I80383, b/341792251)
Version 2.8.1
May 29, 2024
androidx.lifecycle:lifecycle-*:2.8.1
is released. Version 2.8.1 contains these commits.
Bug Fixes
lifecycle-viewmodel-compose
now only has a common dependency oncompose-runtime
, removing its common dependency oncompose-ui
. The Android artifact retains itscompose-ui
for compatibility. (aosp/3079334, b/339562627)ViewModel
’ssaveable
integration using property delegates now uses the class name as part of the auto-generated key, avoiding conflicts if multiple classes use the sameSavedStateHandle
. (aosp/3063463)
Version 2.8.0
May 14, 2024
androidx.lifecycle:lifecycle-*:2.8.0
is released. Version 2.8.0 contains these commits.
Important changes since 2.7.0
LocalLifecycleOwner
has been moved from Compose UI tolifecycle-runtime-compose
so that its Compose-based helper APIs can be used outside of Compose UI.- The
lifecycle-runtime-compose
artifact now contains thedropUnlessResumed
anddropUnlessStarted
APIs which allow you to drop click or other events that occur even after theLifecycleOwner
has dropped below the givenLifecycle.State
. For example, this can be used with Navigation Compose to avoid handling click events after a transition to another screen has already begun:onClick: () -> Unit = dropUnlessResumed { navController.navigate(NEW_SCREEN) }
ViewModel.viewModelScope
is now an overridable constructor parameter, allowing you to inject your own dispatcher andSupervisorJob()
or to override the default by using thebackgroundScope
available withinrunTest
. (I2817c, b/264598574)class MyViewModel( // Make Dispatchers.Main the default, rather than Dispatchers.Main.immediate viewModelScope: CoroutineScope = Dispatchers.Main + SupervisorJob() ) : ViewModel(viewModelScope) { // Use viewModelScope as before, without any code changes } // Allows overriding the viewModelScope in a test fun Test() = runTest { val viewModel = MyViewModel(backgroundScope) }
ViewModel
has been rewritten in Kotlin and now usesAutoClosable
instead ofCloseable
. It now supports addingAutoCloseable
objects with akey
that allows retrieving them viagetCloseable()
.Calling
LifecycleStartEffect
andLifecycleResumeEffect
without a key is now an error, following the same convention as theDisposableEffect
API that these APIs mirror.Deprecated
LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData)
in favor ofLiveData.toPublisher(lifecycleOwner)
.The
lifecycle-livedata-core-ktx
kotlin extensions have now been moved to thelifecycle-livedata-core
module.The
NullSafeMutableLiveData
has been refactored to avoid many false positives.
Lifecycle Kotlin Multiplatform Compatibility
The core Lifecycle APIs in Lifecycle
, LifecycleOwner
, LifecycleObserver
, Lifecycle.State
, Lifecycle.Event
, and LifecycleRegistry
are now shipped in artifacts compatible with Kotlin Multiplatform.
Artifacts impacted:
lifecycle-common
moves most APIs tocommon
and supports jvm and iOS in addition to Android.lifecycle-runtime
moves most APIs tocommon
and supports jvm and iOS in addition to Android.lifecycle-runtime-ktx
is now empty, with all APIs being moved intolifecycle-runtime
.lifecycle-runtime-compose
moves all APIs tocommon
and ships an Android artifact, matching the multiplatform support ofandroidx.compose
.
ViewModel Kotlin Multiplatform Compatibility
The lifecycle-viewmodel
artifact and APIs like ViewModel
, ViewModelStore
, ViewModelStoreOwner
, and ViewModelProvider
are now shipped in artifacts compatible with Kotlin Multiplatform.
To accommodate this change, methods such as those on ViewModelProvider
that took a java.lang.Class<T>
now have an equivalent method that takes a kotlin.reflect.KClass<T>
.
Binary compatibility on Android has been maintained, but there are a few notable changes when comparing the Android API surface to the common API surface:
- Constructing a
ViewModelProvider
instance is now done through theViewModelProvider.create()
methods rather than directly calling its constructor. ViewModelProvider.NewInstanceFactory
andViewModelProvider.AndroidViewModelFactory
are only available on Android.- Custom Factories are recommended to extend from
ViewModelProvider.Factory
and use thecreate
method that takes aCreationExtras
or use theviewModelFactory
Kotlin DSL.
- Custom Factories are recommended to extend from
- Using
ViewModelProvider
without a custom factory on non-JVM platforms will result in anUnsupportedOperationException
. On JVM platforms, compatibility is preserved by using the no-args ViewModel constructor if a custom factory is not provided. viewModelScope
will fallback to anEmptyCoroutineContext
in platforms whereDispatchers.Main
is not available (e.g., Linux).
Artifacts impacted:
lifecycle-viewmodel
moves most APIs tocommon
and supports jvm and iOS in addition to Android.lifecycle-viewmodel-ktx
is now empty, with all APIs being moved intolifecycle-viewmodel
.lifecycle-viewmodel-compose
moves all APIs tocommon
and ships an Android artifact, matching the multiplatform support ofandroidx.compose
.
Behavior Changes
InitializerViewModelFactory
(includingviewModelFactory
builder function) will now throw anIllegalArgumentException
if ainitializer
with the sameclazz: KClass<VM : ViewModel>
has already been added. (Ic3a36)
Known Issues
lifecycle-*:2.8.0
requires a minimum Compose version of 1.7.0-alpha05 (b/336842920).
Version 2.8.0-rc01
May 1, 2024
androidx.lifecycle:lifecycle-*:2.8.0-rc01
is released. Version 2.8.0-rc01 contains these commits.
Bug Fixes
- Fixed an issue where the Baseline Profile for
lifecycle-common
classes was not properly packaged. These are now packaged in thelifecycle-runtime
AAR. (aosp/3038274, b/322382422) - Fixed an unintentional ordering change in how
AutoCloseable
instances attached to a ViewModel are cleared - the previous order ofaddCloseable(String, AutoCloseable)
, thenaddClosable(AutoCloseable)
, thenonCleared()
has been restored. (aosp/3041632) - Improve the default creation behavior for
viewModelScope
for native and JVM Desktop environments. (aosp/3039221)
External Contribution
- Thanks Victor Kropp for improving the checking for the main thread on JVM Desktop. (aosp/3037116)
Version 2.8.0-beta01
April 17, 2024
androidx.lifecycle:lifecycle-*:2.8.0-beta01
is released. Version 2.8.0-beta01 contains these commits.
New Features
- The
lifecycle-runtime-compose
artifact is now compatible with Kotlin Multiplatform, moving its code tocommon
and ships an Android artifact, matching the multiplatform support forandroidx.compose
. (If7a71, I4f4a0, b/331769623)
Version 2.8.0-alpha04
April 3, 2024
androidx.lifecycle:lifecycle-*:2.8.0-alpha04
is released. Version 2.8.0-alpha04 contains these commits.
New Features
- The
lifecycle-viewmodel-compose
artifact is now compatible with Kotlin Multiplatform, moving its code tocommon
and ships an Android artifact, matching the multiplatform support ofandroidx.compose
. The accommodate this change, the ComposableviewModel
method now accepts aKClass
in addition to ajava.lang.Class
. (b/330323282)
Bug Fixes
- The
NullSafeMutableLiveData
has been refactored to avoid many false positives. (I2d8c1, Iafb18, I03463, I7ecef)
Dependency update
- The
lifecycle-viewmodel-compose
artifact now depends on Compose 1.6.0. - Lifecycle now depends on Profile Installer 1.3.1.
Version 2.8.0-alpha03
March 20, 2024
androidx.lifecycle:lifecycle-*:2.8.0-alpha03
is released. Version 2.8.0-alpha03 contains these commits.
New Features
ViewModel.viewModelScope
is now an overridable constructor parameter, allowing you to inject your own dispatcher andSupervisorJob()
or to override the default by using thebackgroundScope
available withinrunTest
. (I2817c, b/264598574)class MyViewModel( // Make Dispatchers.Main the default, rather than Dispatchers.Main.immediate viewModelScope: CoroutineScope = Dispatchers.Main + SupervisorJob() ) : ViewModel(viewModelScope) { // Use viewModelScope as before, without any code changes } // Allows overriding the viewModelScope in a test fun Test() = runTest { val viewModel = MyViewModel(backgroundScope) }
Kotlin Multiplatform Compatibility
The lifecycle-viewmodel
artifact and APIs like ViewModel
, ViewModelStore
, ViewModelStoreOwner
, and ViewModelProvider
are now shipped in artifacts compatible with Kotlin Multiplatform. (b/214568825)
To accommodate this change, methods such as those on ViewModelProvider
that took a java.lang.Class<T>
now have an equivalent method that takes a kotlin.reflect.KClass<T>
.
Binary compatibility on Android has been maintained, but there are a few notable changes when comparing the Android API surface to the common API surface:
- Constructing a
ViewModelProvider
instance is now done through theViewModelProvider.create()
methods rather than directly calling its constructor. ViewModelProvider.NewInstanceFactory
andViewModelProvider.AndroidViewModelFactory
are only available on Android.- Custom Factories are recommended to extend from
ViewModelProvider.Factory
and use thecreate
method that takes aCreationExtras
or use theviewModelFactory
Kotlin DSL.
- Custom Factories are recommended to extend from
- Using
ViewModelProvider
without a custom factory on non-JVM platforms will result in anUnsupportedOperationException
. On JVM platforms, compatibility is preserved by using the no-args ViewModel constructor if a custom factory is not provided. viewModelScope
will fallback to anEmptyCoroutineContext
in platforms whereDispatchers.Main
is not available (e.g., Linux).
Behavior Changes
InitializerViewModelFactory
(includingviewModelFactory
builder function) will now throw anIllegalArgumentException
if ainitializer
with the sameclazz: KClass<VM : ViewModel>
has already been added. (Ic3a36)
Bug Fixes
ViewModel.getCloseable
now handles duplicated keys: if thekey
already has anAutoCloseable
resource associated with it, the old resource will be replaced and closed immediately. (Ibeb67)- Accessing the
viewModelScope
of aViewModel
is now thread safe. (If4766, b/322407038)
External Contribution
LocalLifecycleOwner
moved from Compose UI to lifecycle-runtime-compose so that its Compose-based helper APIs can be used outside of Compose UI. Thanks Jake Wharton for the contribution. (I6c41b, b/328263448)
Version 2.8.0-alpha02
February 21, 2024
androidx.lifecycle:lifecycle-*:2.8.0-alpha02
is released. Version 2.8.0-alpha02 contains these commits.
New Features
- The
dropUnlessResumed
anddropUnlessStarted
APIs have been added which allow you to drop click or other events that occur even after theLifecycleOwner
has dropped below the givenLifecycle.State
. For example, this can be used with Navigation Compose to avoid handling click events after a transition to another screen has already begun:onClick: () -> Unit = dropUnlessResumed { navController.navigate(NEW_SCREEN) }
(Icba83, b/317230685)
Kotlin Conversions
ViewModel
is now written in Kotlin (I16f26, b/214568825)- The
lifecycle-viewmodel-ktx
kotlin extensions have now been moved to the base lifecycle module. (Id787b, b/274800183) - The
lifecycle-runtime-ktx
kotlin extensions have now been moved to the base lifecycle module. (Ic3686, b/274800183) - The
lifecycle-livedata-core-ktx
kotlin extensions have now been moved to the base lifecycle module. (I54a3d, b/274800183)
Kotlin Multiplatform Compatibility
- The core Lifecycle APIs in
Lifecycle
,LifecycleOwner
,LifecycleObserver
,Lifecycle.State
,Lifecycle.Event
, andLifecycleRegistry
are now shipped in artifacts compatible with Kotlin Multiplatform. (b/317249252)
API Changes
- Calling
LifecycleStartEffect
andLifecycleResumeEffect
without a key is now an error, following the same convention as theDisposableEffect
API that these APIs mirror. (Ib0e0c, b/323518079) ViewModel
now usesAutoCloseable
instead ofCloseable
. That is a backward compatible change. (I27f8e, b/214568825)- Deprecated
LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData)
in favor ofLiveData.toPublisher(lifecycleOwner)
. (Iabe29, b/262623005)
External Contribution
- Thanks Ivan Matkov from Jetbrains for helping move Lifecycle to Kotlin Multiplatform. (aosp/2926690, I0c5ac, If445d)
Version 2.8.0-alpha01
January 24, 2024
androidx.lifecycle:lifecycle-*:2.8.0-alpha01
is released. Version 2.8.0-alpha01 contains these commits.
New Features
ViewModel
now supports addingCloseable
objects with akey
that allows retrieving them viagetCloseable()
. (I3cf63)
Version 2.7
Version 2.7.0
January 10, 2024
androidx.lifecycle:lifecycle-*:2.7.0
is released. Version 2.7.0 contains these commits.
Important changes since 2.6.0
TestLifecycleOwner
now includes a suspending functionsetCurrentState()
which ensures that the state change and allLifecycleObserver
callbacks are completed before returning. Notably, unlike setting thecurrentState
property directly, this does not userunBlocking
, making it safe to use within a coroutine such as one provided byrunTest
.- The
LiveData
extensions ofmap
andswitchMap
now mirror the behavior ofdistinctUntilChanged
- if theLiveData
has avalue
set, themap
/switchMap
function will be immediately called to populate thevalue
of the returnedLiveData
. This ensures that the initial value will be set as part of the first composition (when used withobserveAsState()
), but does not change the observation behavior - updates values from the sourceLiveData
will still only apply once you start observing theLiveData
. - This release fixes an issue where
SavedStateHandle
would not properly restore customParcelable
classes after process death and recreation. Due to type information that is lost by the Android framework, arrays of custom Parcelables require additional work (manually creating a typed array of the right type) and the documentation onget
,getLiveData
, andgetStateFlow
now specifically calls this limitation out. - The proguard keep rules associated with
LifecycleObserver
have been removed. This means that proguarded code that wishes to use APIs via reflection (such as using the long since deprecated@OnLifecycleEvent
annotation) will need to provide their own keep rules for their specific use case.
Lifecycle Event Observability
- As an alternative to using a
LifecycleEventObserver
, you can now observe aFlow
ofLifecycle.Event
via theLifecycle.asFlow()
extension method. - Jetpack Compose users can now use
LifecycleEventEffect
to run Compose side effects based onLifecycle.Event
.
@Composable
fun HomeScreen(viewModel: HomeViewModel = viewModel()) {
LifecycleEventEffect(Lifecycle.Event.ON_RESUME) {
viewModel.refreshData()
}
// …
}
- Jetpack Compose users can use
LifecycleStartEffect
andLifecycleResumeEffect
to handle pairs of events - started to stopped and resumed to paused, respectively. This API mirrors the one found inDisposableEffect
and is suitable for cases where the change being made when the state is going up needs to be reversed when going back down.
fun HomeScreen(viewModel: HomeViewModel = viewModel()) {
LifecycleStartEffect(viewModel) {
val timeTracking = viewModel.startTrackingTimeOnScreen()
onStopOrDispose {
timeTracking.stopTrackingTimeOnScreen()
}
}
// …
}
See Run code on lifecycle events for more information.
Lifecycle State Observability
- The current
Lifecycle.State
can now be observed via theLifecycle.currentStateFlow
property, which returns aStateFlow
where thevalue
is the currentLifecycle.State
. - Jetpack Compose users can use the
Lifecycle.currentStateAsState()
extension to directly exposeLifecycle.State
as ComposeState
. This is equivalent (and a shorter alternative) tolifecycle.currentStateFlow.collectAsState()
.
See Collect lifecycle state with flows for more information.
Version 2.7.0-rc02
December 13, 2023
androidx.lifecycle:lifecycle-*:2.7.0-rc02
is released. Version 2.7.0-rc02 contains these commits.
Bug Fixes
- Fixed an issue where
SavedStateHandle
would not properly restore customParcelable
classes after process death and recreation. Due to type information that is lost by the Android framework, arrays of custom Parcelables require additional work (manually creating a typed array of the right type) and the documentation onget
,getLiveData
, andgetStateFlow
now specifically calls this limitation out. (I0b55a)
Version 2.7.0-rc01
November 15, 2023
androidx.lifecycle:lifecycle-*:2.7.0-rc01
is released. Version 2.7.0-rc01 contains these commits.
Bug Fixes
LifecycleStartEffect
andLifecycleResumeEffect
now correctly dispose and recreate the effect block if theLifecycleOwner
is changed. (Ia25c6)
Version 2.7.0-beta01
November 1, 2023
androidx.lifecycle:lifecycle-*:2.7.0-beta01
is released with no changes. Version 2.7.0-beta01 contains these commits.
- A beta version bump, no major changes to this release version.
Version 2.7.0-alpha03
October 18, 2023
androidx.lifecycle:lifecycle-*:2.7.0-alpha03
is released. Version 2.7.0-alpha03 contains these commits.
New Features
lifecycle-runtime-testing
now contains a new Lint check to avoid setting theLifecycle.State
of theTestLifecycleOwner
by using thecurrentState
field when inside of a coroutine. The Lint check now suggests the suspendingsetCurrentState
which allows setting theLifecycle.State
without blocking. (Icf728, b/297880630)
Bug Fixes
- Fixed an issue with
LiveData.switchMap
where returning the sameLiveData
instance both on the initial call and a subsequent call would prevent theLiveData
instance from being added as a source. (Ibedcba7)
Version 2.7.0-alpha02
September 6, 2023
androidx.lifecycle:lifecycle-*:2.7.0-alpha02
is released. Version 2.7.0-alpha02 contains these commits.
New Features
TestLifecycleOwner
now includes the suspending functionsetCurrentState()
to give users the option of usingTestLifecycleOwner
from within a coroutine such as one provided byrunTest
. (I329de, b/259344129)
API Changes
- All files from the
lifecycle-livedata-ktx
modules have been moved into the mainlifecycle-livedata
module. (I10c6f, b/274800183)
Behavior Changes
- The
LiveData.map()
andLiveData.switchMap()
extensions now sets thevalue
of the returnedLiveData
if the previousLiveData
has had a value set on it, ensuring that using the resulting LiveData in Jetpack Compose has the right state on the initial composition. (I91d2b, b/269479952) ViewModel
'saddCloseable()
now immediately closes theCloseable
if theViewModel
has already received a call toonCleared()
. (I4712e, b/280294730)
Bug Fixes
- From Lifecycle
2.6.2
: Fixed an issue whereSavedStateHandle
would not correctly be restored after process death if the state was restored,save()
was called without actually saving the state in the parentSavedStateRegistry
, and then the state was restored again. This fixes the interaction betweenrememberSaveable
and Navigation Compose’sNavHost
. (aosp/2729289)
Version 2.7.0-alpha01
July 26, 2023
androidx.lifecycle:lifecycle-*:2.7.0-alpha01
is released. Version 2.7.0-alpha01 contains these commits.
API Changes
Lifecycle.State
is now Compose-observable viaLifecycle.currentStateFlow
, which returns aStateFlow
where thevalue
is the currentLifecycle.State
. (Ib212d, b/209684871)Lifecycle.Event
s can now able to be observed as aFlow
withLifecycle.asFlow().
(If2c0f, b/176311030)LifecycleResumeEffect
API has been added to run ComposeSideEffect
s based on bothLifecycle.Event.ON_RESUME
andLifecycle.Event.ON_PAUSE
event callbacks. (I60386, b/235529345)LifecycleStartEffect
API has been added to run ComposeSideEffect
s based onLifecycle.Event.ON_START
andLifecycle.Event.ON_STOP
event callbacks. (I5a8d1, b/235529345)LifecycleEventEffect
API has been added to run ComposeSideEffect
s based onLifecycle.Event
. (Ic9794, b/235529345)Lifecycle.collectAsState()
extension has been added to directly exposeLifecycle.State
as ComposeState
. This is equivalent (and a shorter alternative) tolifecycle.currentStateFlow.collectAsState()
. (I11015, b/235529345)
Bug Fixes
- The
LiveData.distinctUntilChanged()
extension now sets thevalue
of the returnedLiveData
if the previousLiveData
has had a value set on it. This does not change the observation behavior - updated values from the sourceLiveData
will still only apply once you start observing theLiveData
returned fromdistinctUntilChanged()
. (Ib482f) - The proguard keep rules associated with
LifecycleObserver
have been removed. This means that proguarded code that wishes to use APIs via reflection will need to provide their own keep rules for their specific use case. (Ia12fd)
Version 2.6
Version 2.6.2
September 6, 2023
androidx.lifecycle:lifecycle-*:2.6.2
is released. Version 2.6.2 contains these commits.
Bug Fixes
- Fixed an issue where
SavedStateHandle
would not correctly be restored after process death if the state was restored,save()
was called without actually saving the state in the parentSavedStateRegistry
, and then the state was restored again. This fixes the interaction betweenrememberSaveable
and Navigation Compose’sNavHost
. (aosp/2729289)
Version 2.6.1
March 22, 2023
androidx.lifecycle:lifecycle-*:2.6.1
is released. Version 2.6.1 contains these commits.
Dependency Updates
lifecycle-viewmodel-savedstate
now depends on SavedState1.2.1
. (cd7251)- Lifecycle now depends on ProfileInstaller
1.3.0
. (f9d30b)
Version 2.6.0
March 8, 2023
androidx.lifecycle:lifecycle-*:2.6.0
is released. Version 2.6.0 contains these commits.
Important changes since 2.5.0
LiveData
now includes a newisInitialized
property that indicates whether an explicit value has ever been set on theLiveData
, allowing you to distinguish betweenliveData.value
returningnull
because no value has ever been set or an explicitnull
value.MediatorLiveData
now includes a constructor to set an initial value.- Added a new extension on
StateFlow
andFlow
ofcollectAsStateWithLifecycle()
that collect from flows and represents its latest value as Compose State in a lifecycle-aware manner. Lifecycle.launchWhenX
methods andLifecycle.whenX
methods have been deprecated as the use of a pausing dispatcher can lead to wasted resources in some cases. It is recommended to useLifecycle.repeatOnLifecycle
. For more information about one-time suspending work, please see this explanation on why this is inherently unsafe.- Kotlin Conversion - A large number of Lifecycle classes have been converted to Kotlin. All converted classes still retain their binary compatibility with previous versions. The following classes have source incompatible changes for classes written in Kotlin:
ViewTreeLifecycleOwner
,LiveDataReactiveStreams
,HasDefaultViewModelProviderFactory
,ViewTreeViewModelStoreOwner
,Transformations
,ViewModelStoreOwner
,LifecycleOwner
The table below provides the source conversions for the new version of lifecycle.
Lifecycle 2.5 | Lifecycle 2.5 (KTX) | Lifecycle 2.6 |
---|---|---|
Transformations.switchMap(liveData) {...} |
liveData.switchMap {...} |
liveData.switchMap {...} |
Transformations.map(liveData) {...} |
liveData.map {...} |
liveData.map {...} |
Transformations.distinctUntilChanged(liveData) {...} |
liveData.distinctUntilChanged{...} |
liveData.distinctUntilChanged{...} |
LiveDataReactiveStreams.fromPublisher(publisher) |
publisher.toLiveData() |
publisher.toLiveData() |
LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData) |
liveData.toPublisher(lifecycleOwner) |
liveData.toPublisher(lifecycleOwner) |
override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory = factory |
override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory = factory |
override val defaultViewModelProviderFactory = factory |
override fun getDefaultViewModelCreationExtras(): CreationExtras = extras |
override fun getDefaultViewModelCreationExtras(): CreationExtras = extras |
override val defaultViewModelProviderCreationExtras = extras |
ViewTreeLifecycleOwner.set(view, owner) |
ViewTreeLifecycleOwner.set(view, owner) |
view.setViewTreeLifecycleOwner(owner) |
ViewTreeLifecycleOwner.get(view) |
view.findViewTreeLifecycleOwner() |
view.findViewTreeLifecycleOwner() |
override fun getViewModelStore(): ViewModelStore = store |
override fun getViewModelStore(): ViewModelStore = store |
override val viewModelStore: ViewModelStore = store |
override fun getLifecycle(): Lifecycle = registry |
override fun getLifecycle(): Lifecycle = registry |
override val lifecycle: Lifecycle get() = registry |
- The nullability of the
onChanged
method of aObserver
created in Kotlin now matches the nullability of the generic type. If you wantObserver.onChanged()
to accept a nullable type, you must instantiate theObserver
with a nullable type. - These classes were also converted to Kotlin, but remain source compatible:
DefaultLifecycleObserver
,LifecycleEventObserver
,Lifecycle
,LifecycleRegistry
,LifecycleObserver
,ViewModelStore
,AndroidViewModel
,AbstractSavedStateViewModelFactory
,LifecycleService
,ServiceLifecycleDispatcher
, andProcessLifecycleOwner
Version 2.6.0-rc01
February 22, 2023
androidx.lifecycle:lifecycle-*:2.6.0-rc01
is released. Version 2.6.0-rc01 contains these commits.
Bug Fixes
- The
LiveData.distinctUntilChanged()
extension now sets thevalue
of the returnedLiveData
if the previousLiveData
has had a value set on it. This does not change the observation behavior - updated values from the sourceLiveData
will still only apply once you start observing theLiveData
returned fromdistinctUntilChanged()
. (Ib482f)
Version 2.6.0-beta01
February 8, 2023
androidx.lifecycle:lifecycle-*:2.6.0-beta01
is released. Version 2.6.0-beta01 contains these commits.
Kotlin Conversions
LifecycleOwner
is now written in Kotlin. This is a source incompatible change for classes written in Kotlin - they must now override thelifecycle
property rather than implementing the previousgetLifecycle()
function. (I75b4b, b/240298691)ViewModelStoreOwner
is now in Kotlin. This is a source incompatible change for classes written in Kotlin - they must now override theviewModelStore
property rather than implementing the previousgetViewModelStore()
function. (I86409, b/240298691)- The Kotlin extension on
LifecycleOwner
that provides thelifecycleScope
field has been moved to thelifecycle-common
artifact fromlifecycle-runtime-ktx
. (I41d78, b/240298691) - The Kotlin extension on
Lifecycle
that provides thecoroutineScope
field has been moved to thelifecycle-common
artifact fromlifecycle-runtime-ktx
. (Iabb91, b/240298691)
Version 2.6.0-alpha05
January 25, 2023
androidx.lifecycle:lifecycle-*:2.6.0-alpha05
is released. Version 2.6.0-alpha05 contains these commits.
Kotlin Conversions
Transformations
is now written in Kotlin. This is a source incompatible change for those classes written in Kotlin that were directly using syntax such asTransformations.map
- Kotlin code must now use the Kotlin extension method syntax that was previously only available when usinglifecycle-livedata-ktx
. When using the Java programming language, the versions of these methods that take anandroidx.arch.core.util.Function
method are deprecated and replaced with the versions that take a KotlinFunction1
. This change maintains binary compatibility. (I8e14f)ViewTreeViewModelStoreOwner
is now written in Kotlin. This is a source incompatible change for those classes written in Kotlin - you must now directly import and use the Kotlin extension methods onView
ofandroidx.lifecycle.setViewTreeViewModelStoreOwner
andandroidx.lifecycle.findViewTreeViewModelStoreOwner
to set and find a previously set owner. This is binary compatible and remains source compatible for implementations written in the Java programming language. (Ia06d8, Ib22d8, b/240298691)- The
HasDefaultViewModelProviderFactory
interface is now written in Kotlin. This is a source incompatible change for classes written in Kotlin - they must now override thedefaultViewModelProviderFactory
anddefaultViewModelCreationExtras
properties rather than implementing the previous corresponding functions. (Iaed9c, b/240298691) Observer
is now written in Kotlin. ItsonChanged()
method now uses the namevalue
for its parameter. (Iffef2, I4995e, b/240298691)AndroidViewModel
,AbstractSavedStateViewModelFactory
,LifecycleService
,ServiceLifecycleDispatcher
, andProcessLifecycleOwner
are now written in Kotlin (I2e771, Ibae40, I160d7, I08884, I1cda7, b/240298691)
Version 2.6.0-alpha04
January 11, 2023
androidx.lifecycle:lifecycle-*:2.6.0-alpha04
is released. Version 2.6.0-alpha04 contains these commits.
New Features
LiveData
now includes a newisInitialized
property that indicates whether an explicit value has ever been set on theLiveData
, allowing you to distinguish betweenliveData.value
returningnull
because no value has ever been set or an explicitnull
value. (Ibd018)
API Changes
- The
collectAsStateWithLifecycle()
APIs oflifecycle-runtime-compose
are no longer in experimental status. (I09d42, b/258835424) Lifecycle.launchWhenX
methods andLifecycle.whenX
methods have been deprecated as the use of a pausing dispatcher can lead to wasted resources in some cases. It is recommended to useLifecycle.repeatOnLifecycle
. (Iafc54, b/248302832)
Kotlin Conversions
ViewTreeLifecycleOwner
is now written in Kotlin. This is a source incompatible change for those classes written in Kotlin - you must now directly import and use the Kotlin extension methods onView
ofandroidx.lifecycle.setViewTreeLifecycleOwner
andandroidx.lifecycle.findViewTreeLifecycleOwner
to set and find a previously set owner. This replaces the previous Kotlin extension inlifecycle-runtime-ktx
. This is binary compatible and remains source compatible for implementations written in the Java programming language. (I8a77a, I5234e, b/240298691)LiveDataReactiveStreams
is now written in Kotlin. The Kotlin extensions previously inlifecycle-reactivestreams-ktx
have been moved into thelifecycle-reactivestreams
module and have become the primary surface for code written in Kotlin. This is a source incompatible change for code written in Kotlin if you were not already using the Kotlin extension method APIs. (I2b1b9, I95d22, b/240298691)DefaultLifecycleObserver
,LifecycleEventObserver
,Lifecycle
,LifecycleRegistry
,LifecycleObserver
, andViewModelStore
are now written in Kotlin (Iadffd, (I60034, I8c52c, I9593d, I01fe1, I59a23, b/240298691)
Bug Fixes
SavedStateHandle
no longer crashes with aClassCastException
when callingget()
with the incorrect class type. (I6ae7c)
Version 2.6.0-alpha03
October 24, 2022
androidx.lifecycle:lifecycle-*:2.6.0-alpha03
is released. Version 2.6.0-alpha03 contains these commits.
Bug Fixes
- Fixed an issue with constraints between different Lifecycle modules not working as intended. (I18d0d, b/249686765)
- Errors thrown by
LifecycleRegistry.moveToState()
now include a more helpful error messaging that informs developers of the component causing the error. (Idf4b2, b/244910446)
Version 2.6.0-alpha02
September 7, 2022
androidx.lifecycle:lifecycle-*:2.6.0-alpha02
is released. Version 2.6.0-alpha02 contains these commits.
API Changes
MediatorLiveData
now includes a constructor to set an initial value. (Ib6cc5, b/151244085)
Bug Fixes
Lifecycle
artifacts now include constraints that ensure that all inter-dependent Lifecycle artifacts use the same version, automatically upgrading other dependencies when one is upgraded. b/242871265FlowLiveData.asFlow()
now creates acallbackFlow
rather than using its ownChannel
implementation to ensure thread-safety and context preservation. (I4a8b2, b/200596935)FlowLiveData
'sasLiveData
function will now preserve the initial value of aStateFlow
when creating the newLiveData
object. (I3f530, b/157380488)- From Lifecycle
2.5.1
: Custom implementations ofAndroidViewModelFactory
now correctly calls thecreate(modelClass)
function when using the stateful constructor withLifecycle
2.4+ (I5b315, b/238011621)
Version 2.6.0-alpha01
June 29, 2022
androidx.lifecycle:lifecycle-*:2.6.0-alpha01
is released. Version 2.6.0-alpha01 contains these commits.
New Features
- Added a new extension on
StateFlow
andFlow
ofcollectAsStateWithLifecycle
that collect from flows and represents its latest value as Compose State in a lifecycle-aware manner. The flow is collected and the new emission is set to the State's value when the lifecycle is at least in a certainLifecycle.State
. When the lifecycle falls below thatLifecycle.State
, the flow collection stops and the State's value is not updated. (I1856e, b/230557927)
Version 2.5
Version 2.5.1
July 27, 2022
androidx.lifecycle:lifecycle-*:2.5.1
is released. Version 2.5.1 contains these commits.
Bug Fixes
- Custom implementations of
AndroidViewModelFactory
now correctly call thecreate(modelClass)
function when using the statefulAndroidViewModelFactory
constructor withLifecycle
2.4+. (I5b315, b/238011621)
Version 2.5.0
June 29, 2022
androidx.lifecycle:lifecycle-*:2.5.0
is released. Version 2.5.0 contains these commits.
Important changes since 2.4.0
SavedStateHandle
now offers agetStateFlow()
API that returns a KotlinStateFlow
for monitoring value changes as an alternative to usingLiveData
.ViewModel CreationExtras - when writing a custom
ViewModelProvider.Factory
, it is no longer required to extendAndroidViewModelFactory
orAbstractSavedStateViewModelFactory
to gain access to anApplication
orSavedStateHandle
, respectively. Instead, these fields are provided to everyViewModelProvider.Factory
subclass asCreationExtras
via the new overload ofcreate
:create(Class<T>, CreationExtras)
. These extras are provided automatically by your Activity or Fragment when using Activity1.5.0
and Fragment1.5.0
, respectively.class CustomFactory : ViewModelProvider.Factory { override fun <T : ViewModel> create(modelClass: Class<T>, extras: CreationExtras): T { return when (modelClass) { HomeViewModel::class -> { // Get the Application object from extras val application = checkNotNull(extras[ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY]) // Pass it directly to HomeViewModel HomeViewModel(application) } DetailViewModel::class -> { // Create a SavedStateHandle for this ViewModel from extras val savedStateHandle = extras.createSavedStateHandle() DetailViewModel(savedStateHandle) } else -> throw IllegalArgumentException("Unknown class $modelClass") } as T } }
lifecycle-viewmodel
now provides aviewModelFactory
Kotlin DSL that allows you define yourViewModelProvider.Factory
in terms of one or more lambda initializers, one for each particularViewModel
class your custom factory supports, usingCreationExtras
as the primary data source.val customFactory = viewModelFactory { // The return type of the lambda automatically sets what class this lambda handles initializer { // Get the Application object from extras provided to the lambda val application = checkNotNull(get(ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY)) HomeViewModel(application) } initializer { val savedStateHandle = createSavedStateHandle() DetailViewModel(savedStateHandle) } }
lifecycle-viewmodel-compose
now offers aviewModel()
API that takes a lambda factory for creating aViewModel
instance without requiring the creation of a customViewModelProvider.Factory
.// Within a @Composable, you can now skip writing a custom Factory // and instead write a lambda to do the initialization of your ViewModel val detailViewModel = viewModel { // This lambda is only called the first time the ViewModel is created // and all CreationExtras are available inside the lambda val savedStateHandle = createSavedStateHandle() DetailViewModel(savedStateHandle) }
SavedStateHandle Compose Saver Integration - the
lifecycle-viewmodel-compose
artifact now contains new experimental APIs inSavedStateHandle.saveable
that allowrememberSaveable
like behavior backed by theSavedStateHandle
of a `ViewModel.class ListScreenViewModel(handle: SavedStateHandle): ViewModel() { // This value survives both configuration changes and process death and recreation val editMode by handle.saveable { mutableStateOf(false) } }
Added an
addCloseable()
API and a new constructor overload that allow you to add one or moreCloseable
objects to theViewModel
that will be closed when theViewModel
is cleared without requiring any manual work inonCleared()
.For instance, to create a coroutine scope that you can inject into a ViewModel, but control via testing, you can create a
CoroutineScope
that implementsCloseable
:class CloseableCoroutineScope( context: CoroutineContext = SupervisorJob() + Dispatchers.Main.immediate ) : Closeable, CoroutineScope { override val coroutineContext: CoroutineContext = context override fun close() { coroutineContext.cancel() } }
Which can then be used in your
ViewModel
constructor while maintaining the same lifetime asviewModelScope
:class TestScopeViewModel( val customScope: CloseableCoroutineScope = CloseableCoroutineScope() ) : ViewModel(customScope) { // You can now use customScope in the same way as viewModelScope }
Behavior changes
- Attempting to move the
Lifecycle.State
fromINITIALIZED
toDESTROYED
will now always throw anIllegalStateException
regardless of whether theLifecycle
has an attached observer. LifecycleRegistry
will now clear their observers when they reach theDESTROYED
state.
Version 2.5.0-rc02
June 15, 2022
androidx.lifecycle:lifecycle-*:2.5.0-rc02
is released. Version 2.5.0-rc02 contains these commits.
Bug Fixes
ViewModelProvider
will no longer crash when mixing previous versions of compileOnly Lifecycle dependencies with versions 2.5+. (I81a66, b/230454566)
Version 2.5.0-rc01
May 11, 2022
androidx.lifecycle:lifecycle-*:2.5.0-rc01
is released. Version 2.5.0-rc01 contains these commits.
Bug Fixes
MediatorLiveData.addSource()
now throws aNullPointerException
when passed anull
source instead of propagating thenull
source to observers.(Ibd0fb, b/123085232)
Version 2.5.0-beta01
April 20, 2022
androidx.lifecycle:lifecycle-*:2.5.0-beta01
is released. Version 2.5.0-beta01 contains these commits.
API Changes
- Added
SavedStateHandle.saveable
property delegates to use property names as keys for persisting state into theSavedStateHandle
(I8bb86, b/225014345)
Bug Fixes
- Fixed an issue where nesting one
NavHost
within anotherNavHost
in a non-primary bottom navigation tab would lead to anIllegalStateException
when using multiple back stacks. (I11bd5, b/228865698)
Version 2.5.0-alpha06
April 6, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha06
is released. Version 2.5.0-alpha06 contains these commits.
New Features
- Add experimental
MutableState
overload toSavedStateHandle.saveable
for parity withrememberSaveable
(I38cfe, b/224565154)
API Changes
CreationExtras
is now abstract instead of sealed. (Ib8a7a)
Bug Fixes
- Fixed an
IllegalStateException: Already attached to lifecycleOwner
error caused bySavedStateHandleController
. (I7ea47, b/215406268)
Version 2.5.0-alpha05
March 23, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha05
is released. Version 2.5.0-alpha05 contains these commits.
New Features
- The
lifecycle-viewmodel-compose
module now providesSavedStateHandleSaver
, an experimental API that ensures values in aSavedStateHandle
are integrated correctly with the same saved instance state thatrememberSaveable
uses. (Ia88b7, b/195689777)
API Changes
- Fixed a compatibility issue with Lifecycle 2.3 and newer Lifecycle versions in Java. (I52c8a, b/219545060)
Bug Fixes
SavedStateViewFactory
now supports usingCreationExtras
even when it was initialized with aSavedStateRegistryOwner
. If extras are provided, the initialized arguments are ignored. (I6c43b, b/224844583)
Version 2.5.0-alpha04
March 9, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha04
is released. Version 2.5.0-alpha04 contains these commits.
API Changes
SavedStateHandle
now offers agetStateFlow()
API that returns a KotlinStateFlow
for monitoring value changes as an alternative to usingLiveData
. (Iad3ab, b/178037961)
Version 2.5.0-alpha03
February 23, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha03
is released. Version 2.5.0-alpha03 contains these commits.
New Features
- Added an
addCloseable()
API and a new constructor overload that allow you to add one or moreCloseable
objects to theViewModel
that will be closed when theViewModel
is cleared without requiring any manual work inonCleared()
. (I55ea0) lifecycle-viewmodel
now provides anInitializerViewModelFactory
that allows you to add lambda for handling particularViewModel
classes, usingCreationExtras
as the primary data source. (If58fc, b/216687549)lifecycle-viewmodel-compose
now offers aviewModel()
API that takes a lambda factory for creating aViewModel
instance without requiring the creation of a customViewModelProvider.Factory
. (I97fbb, b/216688927)
API Changes
- You can now create a
ViewModel
withCreationExtras
vialifecycle-viewmodel-compose
. (I08887, b/216688927)
Behavior changes
- Attempting to move the
Lifecycle.State
fromINITIALIZED
toDESTROYED
will now always throw anIllegalStateException
regardless of whether theLifecycle
has an attached observer. (I7c390, b/177924329) LifecycleRegistry
will now clear their observers when they reach theDESTROYED
state. (I4f8dd, b/142925860)
Version 2.5.0-alpha02
February 9, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha02
is released. Version 2.5.0-alpha02 contains these commits.
API Changes
SavedStateHandle
andSavedStateViewModelFactory
have been converted to Kotlin. This has improved the nullability of the generics in both classes. (Ib6ce2, b/216168263, I9647a, b/177667711)- The
LiveData
switchMap
function parameter can now have a nullable output. (I40396, b/132923666) - The
LiveData
-ktx extensions are now annotated with@CheckResult
to enforce that the result is used when calling these functions. (Ia0f05, b/207325134)
Behavior changes
SavedStateHandle
now properly stores the defaultValue when no value for the specified key exists. (I1c6ce, b/178510877)
Bug Fixes
- From Lifecycle
2.4.1
: Updatedlifecycle-process
to depend on Startup 1.1.1 to ensure that fixes that preventProcessLifecycleInitializer
from throwing aStartupException
are available by default. (Ib01df, b/216490724) - There is now an improved error message when custom
AndroidViewModel
classes have parameters in the wrong order and attempt to create aViewModel
. (I340f7, b/177667711) - You can now create a view model via
CreationExtras
using theAndroidViewModelFactory
without setting an application. (I6ebef, b/217271656)
Version 2.5.0-alpha01
January 26, 2022
androidx.lifecycle:lifecycle-*:2.5.0-alpha01
is released. Version 2.5.0-alpha01 contains these commits.
ViewModel CreationExtras
With this release, we are laying the groundwork for restructuring how a ViewModel
is constructed. Instead of a rigid set of subclasses of ViewModelProvider.Factory
that each add additional functionality (allowing an Application
constructor parameter via AndroidViewModelFactory
, allowing a SavedStateHandle
constructor parameter via SavedStateViewModelFactory
and AbstractSavedStateViewModelFactory
, etc.), we are moving to a world of stateless factories that rely on a new concept, CreationExtras
. (Ia7343, b/188691010, b/188541057)
With this change, ViewModelProvider
no longer makes direct calls into the previous create(Class<T>)
method of ViewModelProvider.Factory
. Instead, it calls into a new overload of create
: create(Class<T>, CreationExtras)
. This means that any direct implementation of the ViewModelProvider.Factory
instance now has access to each of these new CreationExtras
:
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY
: thisString
provides access to the custom key you passed toViewModelProvider.get()
.ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY
provides access to theApplication
class.SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY
provides access to theSavedStateRegistryOwner
that is being used to construct this ViewModel.SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY
provides access to theViewModelStoreOwner
that is being used to construct this ViewModel.SavedStateHandleSupport.DEFAULT_ARGS_KEY
provides access to theBundle
of arguments that should be used to construct aSavedStateHandle
.
These extras are provided by default when using Activity 1.5.0-alpha01
, Fragment 1.5.0-alpha01
, and Navigation 2.5.0-alpha01
. If you use an earlier version of those libraries, your CreationExtras
will be empty - all of the existing subclasses of ViewModelProvider.Factory
have been rewritten to support both the legacy creation path used by earlier versions of those libraries and the CreationExtras
path which will be used going forward.
These CreationExtras
allow you to construct a ViewModelProvider.Factory
that passes just the information you need to each ViewModel
without relying on a strict hierarchy of Factory subclasses:
class CustomFactory : ViewModelProvider.Factory {
override fun <T : ViewModel> create(modelClass: Class<T>, extras: CreationExtras): T {
return when (modelClass) {
HomeViewModel::class -> {
// Get the Application object from extras
val application = checkNotNull(extras[ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY])
// Pass it directly to HomeViewModel
HomeViewModel(application)
}
DetailViewModel::class -> {
// Create a SavedStateHandle for this ViewModel from extras
val savedStateHandle = extras.createSavedStateHandle()
DetailViewModel(savedStateHandle)
}
else -> throw IllegalArgumentException("Unknown class $modelClass")
} as T
}
}
We use the createSavedStateHandle()
Kotlin extension function on CreationExtras
from SavedStateHandleSupport
to construct a SavedStateHandle
only for the one ViewModel that needs it. (Ia6654, b/188541057)
Custom CreationExtras
can be provided by overriding getDefaultViewModelCreationExtras()
in your ComponentActivity
or Fragment
, thus making them available to your custom ViewModelProvider.Factory
as a built in form of assisted injection. These extras will automatically be made available to your custom Factory when used directly with ViewModelProvider
or when using the by viewModels()
and by activityViewModels()
Kotlin property extensions. (I79f2b, b/207012584, b/207012585, b/207012490)
Bug Fixes
- Fixed an issue where the default value provided
to a
SavedStateHandle
would reappear after process death and recreation, even if it was specifically removed from theSavedStateHandle
. As a consequence of this,SavedStateHandle
will no longer merge default values and restored values together, instead only using the restored values as the source of truth. (I53a4b)
Version 2.4
Version 2.4.1
February 9, 2022
androidx.lifecycle:lifecycle-*:2.4.1
is released. Version 2.4.1 contains these commits.
Bug Fixes
- Backported from Lifecycle
2.5.0-alpha01
: Fixed an issue where the default value provided to aSavedStateHandle
would re-appear after process death and recreation, even if it was specifically removed from theSavedStateHandle
. As a consequence of this,SavedStateHandle
will no longer merge default values and restored values together, instead only using the restored values as the source of truth. (I53a4b) lifecycle-process
now depends on Androidx Startup 1.1.1 which fixed a regression in where usingProcessLifecycleInitializer
would cause anStartupException
. (b/216490724)
Version 2.4.0
October 27, 2021
androidx.lifecycle:lifecycle-*:2.4.0
is released. Version 2.4.0 contains these commits.
Important changes since 2.3.0
@OnLifecycleEvent
was deprecated.LifecycleEventObserver
orDefaultLifecycleObserver
should be used instead.androidx.lifecycle:lifecycle-viewmodel-compose
library was added. It providesviewModel()
composable andLocalViewModelStoreOwner
.- Source-breaking change:
ViewModelProvider
has been rewritten in Kotlin.ViewModelProvider.Factory.create
method no longer allows nullable generic.
- Source-breaking change:
- New coroutines API were added to
androidx.lifecycle:lifecycle-runtime-ktx
: Lifecycle.repeatOnLifecycle
, API that executes a block of code in a coroutine when the Lifecycle is at least in a certain state. The block will cancel and re-launch as the lifecycle moves in and out of the target state;Flow.flowWithLifecycle
, API that emits values from the upstream Flow when the lifecycle is at least in a certain state.DefaultLifecycleObserver
was moved fromlifecycle.lifecycle-common-java8
tolifecycle.lifecycle-common
.lifecycle.lifecycle-common-java8
doesn't provide anymore any additional functionality on top oflifecycle.lifecycle-common
, so dependency on it can be replaced bylifecycle.lifecycle-common
.- Non coroutines API from
lifecycle-viewmodel-ktx
have been moved to thelifecycle-viewmodel
module. lifecycle-process
now usesandroidx.startup
to initialize theProcessLifecycleOwner
.Previously, this was being done by
androidx.lifecycle.ProcessLifecycleOwnerInitializer
.If you used
tools:node="remove"
theContentProvider
being used to initialize process lifecycle in the past, then you need to do the following instead.<provider android:name="androidx.startup.InitializationProvider" android:authorities=\"${applicationId}.androidx-startup" android:exported="false" tools:node=\"merge"> <!-- If you are using androidx.startup to initialize other components --> <meta-data android:name="androidx.lifecycle.ProcessLifecycleInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
(or)
<!-- If you want to disable androidx.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove"> </provider>
Version 2.4.0-rc01
September 29, 2021
androidx.lifecycle:lifecycle-*:2.4.0-rc01
is released with no changes from Lifecycle 2.4.0-beta01. Version 2.4.0-rc01 contains these commits.
Version 2.4.0-beta01
September 15, 2021
androidx.lifecycle:lifecycle-*:2.4.0-beta01
is released. Version 2.4.0-beta01 contains these commits.
API Changes
@OnLifecycleEvent
was deprecated.LifecycleEventObserver
orDefaultLifecycleObserver
should be used instead. (I5a8fa)- DefaultLifecycleObserver was moved from
androidx.lifecycle.lifecycle-common-java8
toandroidx.lifecycle.lifecycle-common
.androidx.lifecycle.lifecycle-common-java8
doesn't provide anymore any additional functionality on top ofandroidx.lifecycle.lifecycle-common
, so dependency on it can be replaced byandroidx.lifecycle.lifecycle-common
. (I021aa) - Non coroutines API from
lifecycle-viewmodel-ktx
have been moved to thelifecycle-viewmodel
module. (I6d5b2)
External Contribution
Version 2.4.0-alpha03
August 4, 2021
androidx.lifecycle:lifecycle-*:2.4.0-alpha03
is released. Version 2.4.0-alpha03 contains these commits.
API Changes
- Source-breaking change: ViewModelProvider has been rewritten in Kotlin.
ViewModelProvider.Factory.create
method no longer allows nullable generic. (I9b9f6)
Behavior Changes
- The
Lifecycle.repeatOnLifecycle
:block
is now always invoked serially when repeating execution. (Ibab33)
External Contribution
- Thanks chao2zhang for fixing the code snippets in the
repeatOnLifecycle
documentation. #205.
Version 2.4.0-alpha02
June 16, 2021
androidx.lifecycle:lifecycle-*:2.4.0-alpha02
is released. Version 2.4.0-alpha02 contains these commits.
New Features
- Added a new
RepeatOnLifecycleWrongUsage
lint check tolifecycle-runtime-ktx
that detects whenrepeateOnLifecycle
is incorrectly used inonStart()
oronResume()
. (706078, b/187887400)
API Changes
- The
LifecycleOwner.addRepeatingJob
API is removed in favor ofLifecycle.repeatOnLifecycle
that respects structured concurrency and is easier to reason about. (I4a3a8) - Make
ProcessLifecycleInitializer
public so otherandroidx.startup.Initializer
s can use these as dependencies. (I94c31)
Bug Fixes
- Fixed an issue with the
NullSafeMutableLiveData
lint check when the field has modifiers. (#147, b/183696616) - Fixed another issue with the
NullSafeMutableLiveData
lint check when using generics. (#161, b/184830263)
External Contribution
- Thanks maxsav for improving the
NullSafeMutableLiveData
lint check. (#147, b/183696616) - Thanks kozaxinan for improving the
NullSafeMutableLiveData
lint check. (#161, b/184830263)
Version 2.4.0-alpha01
March 24, 2021
androidx.lifecycle:lifecycle-*:2.4.0-alpha01
is released. Version 2.4.0-alpha01 contains these commits.
Behavior Changes
lifecycle-process
now usesandroidx.startup
to initialize theProcessLifecycleOwner
.Previously, this was being done by
androidx.lifecycle.ProcessLifecycleOwnerInitializer
.If you used
tools:node="remove"
theContentProvider
being used to initialize process lifecycle in the past, then you need to do the following instead.<provider android:name="androidx.startup.InitializationProvider" android:authorities=\"${applicationId}.androidx-startup" android:exported="false" tools:node=\"merge"> <!-- If you are using androidx.startup to initialize other components --> <meta-data android:name="androidx.lifecycle.ProcessLifecycleInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
(or)
<!-- If you want to disable androidx.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove"> </provider>
API Changes
- Added a
Flow.flowWithLifecycle
API that emits values from the upstream Flow when the lifecycle is at least in a certain state using theLifecycle.repeatOnLifecycle
API. This is an alternative to the also newLifecycleOwner.addRepeatinJob
API. (I0f4cd)
Bug Fixes
- From Lifecycle 2.3.1: The
NonNullableMutableLiveData
lint rule can now properly differentiate between field variables with different nullability. (b/169249668)
Lifecycle Viewmodel Compose Version 1.0.0
Version 1.0.0-alpha07
June 16, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha07
is released. Version 1.0.0-alpha07 contains these commits.
Breaking API Changes
viewModel()
now takes an optionalViewModelStoreOwner
, making it easier to work with owners other than theLocalViewModelStoreOwner
. For example, you can now useviewModel(navBackStackEntry)
to retrieve a ViewModel associated with a particular navigation graph. (I2628d, b/188693123)
Version 1.0.0-alpha06
June 2, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha06
is released. Version 1.0.0-alpha06 contains these commits.
Updated to be compatible with Compose version 1.0.0-beta08
.
Version 1.0.0-alpha05
May 18, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha05
is released. Version 1.0.0-alpha05 contains these commits.
New Features
- Updated to be compatible with Compose version
1.0.0-beta07
.
Bug Fixes
- The AndroidManifest files from ui-test-manifest and ui-tooling-data are now compatible with Android 12 (I6f9de, b/184718994)
Version 1.0.0-alpha04
April 7, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha04
is released. Version 1.0.0-alpha04 contains these commits.
Dependency Changes
- This version allows
androidx.hilt:hilt-navigation-compose
andandroidx.navigation:navigation-compose
to sync dependencies onandroidx.compose.compiler:compiler:1.0.0-beta04
andandroidx.compose.runtime:runtime:1.0.0-beta04
. For 1.0.0, it is required that the compiler and runtime match.
Version 1.0.0-alpha03
March 10, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha03
is released. Version 1.0.0-alpha03 contains these commits.
API Changes
LocalViewModelStoreOwner.current
now returns a nullableViewModelStoreOwner
to better determine whether aViewModelStoreOwner
is available in the current composition. APIs that require aViewModelStoreOwner
, such asviewModel()
andNavHost
, still throw an exception if aViewModelStoreOwner
is not set. (Idf39a)
Lifecycle-Viewmodel-Compose Version 1.0.0-alpha02
February 24, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha02
is released. Version 1.0.0-alpha02 contains these commits.
API Changes
LocalViewModelStoreOwner
now has aprovides
functions that can be used withCompositionLocalProvider
, replacing theasProvidableCompositionLocal()
API. (I45d24)
Lifecycle-Viewmodel-Compose Version 1.0.0-alpha01
February 10, 2021
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha01
is released. Version 1.0.0-alpha01 contains these commits.
New Features
- The
viewModel()
composable andLocalViewModelStoreOwner
were moved fromandroidx.compose.ui.viewinterop
to this artifact in theandroidx.lifecycle.viewmodel.compose
package. (I7a374)
Version 2.3.1
Lifecycle Version 2.3.1
March 24, 2021
androidx.lifecycle:lifecycle-*:2.3.1
is released. Version 2.3.1 contains these commits.
Bug Fixes
- The
NonNullableMutableLiveData
lint rule can now properly differentiate between field variables with different nullability. (b/169249668)
Version 2.3.0
Version 2.3.0
February 10, 2021
androidx.lifecycle:lifecycle-*:2.3.0
is released. Version 2.3.0 contains these commits.
Major changes since 2.2.0
SavedStateHandle
support for non-parcelable classes:SavedStateHandle
now supports lazy serialization by allowing you to callsetSavedStateProvider()
for a given key, providing aSavedStateProvider
that will get a callback tosaveState()
when theSavedStateHandle
is asked to save its state. See Saving non-parcelable classes.- Lifecycle Behavior Enforcement:
- LifecycleRegistry now enforces
DESTROYED
as a terminal state. LifecycleRegistry
now verifies that its methods are called on main thread. It was always a requirement for lifecycles of activities, fragments etc. An addition of observers from non-main threads resulted in hard to catch crashes in runtime. ForLifecycleRegistry
objects that owned by your own components, you can explicitly opt out from checks by usingLifecycleRegistry.createUnsafe(...)
, but then you have to ensure that a proper synchronization is in place when thisLifecycleRegistry
is accessed from different threads.
- LifecycleRegistry now enforces
- Lifecycle State and Event Helpers: Added static helper methods of
downFrom(State)
,downTo(State)
,upFrom(State)
,upTo(State)
toLifecycle.Event
for generating theEvent
given aState
and transition direction. Added thegetTargetState()
method that provides theState
that the Lifecycle will transition to directly following theEvent
. withStateAtLeast
: AddedLifecycle.withStateAtLeast
APIs that await a lifecycle state and run a non-suspending block of code synchronously at the point of state change, then resume with the result. These APIs differ from the existingwhen*
methods as they do not permit running suspending code and do not employ a custom dispatcher. (aosp/1326081)ViewTree
APIs: A newViewTreeLifecycleOwner.get(View)
andViewTreeViewModelStoreOwner.get(View)
API allows you to retrieve the containingLifecycleOwner
andViewModelStoreOwner
, respectively, given aView
instance. You must upgrade to Activity1.2.0
and Fragment1.3.0
, and AppCompat 1.3.0-alpha01 or higher to populate this correctly. ThefindViewTreeLifecycleOwner
andfindViewTreeViewModelStoreOwner
Kotlin extensions are available inlifecycle-runtime-ktx
andlifecycle-viewmodel-ktx
, respectively.LiveData.observe()
Kotlin extension deprecation: TheLiveData.observe()
Kotlin extension necessary to use lambda syntax is now deprecated as it is not necessary when using Kotlin 1.4.
Version 2.3.0-rc01
December 16, 2020
androidx.lifecycle:lifecycle-*:2.3.0-rc01
is released. Version 2.3.0-rc01 contains these commits.
Bug Fixes
- The
keys()
method ofSavedStateHandle
is now consistent before and after the state is saved - it now includes keys previously used withsetSavedStateProvider()
in addition to the keys used withset()
andgetLiveData()
. (aosp/1517919, b/174713653)
External Contribution
- The APIs to suspend Lifecycle-aware coroutines now better handle calls to
yield()
. Thanks Nicklas Ansman Giertz! (aosp/1430830, b/168777346)
Version 2.3.0-beta01
October 1, 2020
androidx.lifecycle:lifecycle-*:2.3.0-beta01
is released. Version 2.3.0-beta01 contains these commits.
API Changes
- The
LiveData.observe()
Kotlin extension necessary to use lambda syntax is now deprecated as it is not necessary when using Kotlin 1.4. (I40d3f)
Bug Fixes
- Upgrade androidx to use Kotlin 1.4 (Id6471, b/165307851, b/165300826)
Documentation Changes
- The
liveData
builder andasLiveData()
docs have been updated to include details about changing the given timeout values. (aosp/1122324)
Version 2.3.0-alpha07
August 19, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha07
is released. Version 2.3.0-alpha07 contains these commits.
Bug Fixes
- Fixed a crash issue in the
NullSafeMutableLiveData
Lint check. (aosp/1395367)
Version 2.3.0-alpha06
July 22, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha06
is released. Version 2.3.0-alpha06 contains these commits.
New Features
- Added static helper methods of
downFrom(State)
,downTo(State)
,upFrom(State)
,upTo(State)
toLifecycle.Event
for generating theEvent
given aState
and transition direction. Added thegetTargetState()
method that provides theState
that the Lifecycle will transition to directly following theEvent
. (I00887) - Added
Lifecycle.withStateAtLeast
APIs that await a lifecycle state and run a non-suspending block of code synchronously at the point of state change, then resume with the result. These APIs differ from the existingwhen*
methods as they do not permit running suspending code and do not employ a custom dispatcher. (aosp/1326081)
Behavior Changes
- LifecycleRegistry now enforces
DESTROYED
as a terminal state. (I00887) LifecycleRegistry
now verifies that its methods are called on main thread. It was always a requirement for lifecycles of activities, fragments etc. An addition of observers from non-main threads resulted in hard to catch crashes in runtime. ForLifecycleRegistry
objects that owned by your own components, you can explicitly opt out from checks by usingLifecycleRegistry.createUnsafe(...)
, but then you have to ensure that a proper synchronization is in place when thisLifecycleRegistry
is accessed from different threads (Ie7280, b/137392809)
Bug Fixes
- Fixed a crash in
NullSafeMutableLiveData
. (b/159987480) - Fixed an
ObsoleteLintCustomCheck
for Lint checks bundled withlifecycle-livedata-core-ktx
(and specificallyNullSafeMutableLiveData
). (b/158699265)
Version 2.3.0-alpha05
June 24, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha05
is released. Version 2.3.0-alpha05 contains these commits.
Bug Fixes
LiveData
now better handles reentrant cases, avoiding duplicate calls toonActive()
oronInactive()
. (b/157840298)- Fixed an issue where Lint checks would not run when using Android Studio 4.1 Canary 6 or higher. (aosp/1331903)
Version 2.3.0-alpha04
June 10, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha04
is released. Version 2.3.0-alpha04 contains these commits.
Bug Fixes
- Fixed a crash in the
NonNullableMutableLiveData
Lint check. (b/157294666) - The
NonNullableMutableLiveData
Lint check now covers significantly more cases where anull
value was set on aMutableLiveData
with a non-null type parameter. (b/156002218)
Version 2.3.0-alpha03
May 20, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha03
are released. Version 2.3.0-alpha03 contains these commits.
New Features
SavedStateHandle
now supports lazy serialization by allowing you to callsetSavedStateProvider()
for a given key, providing aSavedStateProvider
that will get a callback tosaveState()
when theSavedStateHandle
is asked to save its state. (b/155106862)- A new
ViewTreeViewModelStoreOwner.get(View)
API allows you to retrieve the containingViewModelStoreOwner
given aView
instance. You must upgrade to Activity1.2.0-alpha05
, Fragment1.3.0-alpha05
, and AppCompat1.3.0-alpha01
to populate this correctly. AfindViewModelStoreOwner()
Kotlin extension has been added tolifecycle-viewmodel-ktx
. (aosp/1295522)
Bug Fixes
- Fixed an issue that caused the
MutableLiveData
Lint checks released in Lifecycle2.3.0-alpha01
from being published alongside thelifecycle-livedata-core-ktx
artifact. (b/155323109)
Version 2.3.0-alpha02
April 29, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha02
is released. Version 2.3.0-alpha02 contains these commits.
API Changes
SavedStateViewModelFactory
now allows you to pass a nullApplication
to its constructor to better support cases where one is not readily available and support forAndroidViewModel
is not needed. (aosp/1285740)
Bug Fixes
- Improved cold start performance by avoiding class verification failure on API 28 and lower devices. (aosp/1282118)
Version 2.3.0-alpha01
March 4, 2020
androidx.lifecycle:lifecycle-*:2.3.0-alpha01
is released. Version 2.3.0-alpha01 contains these commits.
New Features
- A new
ViewTreeLifecycleOwner.get(View)
API allows you to retrieve the containingLifecycleOwner
given aView
instance. You must upgrade to Activity1.2.0-alpha01
and Fragment1.3.0-alpha01
to populate this correctly. AfindViewTreeLifecycleOwner
Kotlin extension is available inlifecycle-runtime-ktx
. (aosp/1182361, aosp/1182956) - Added a new Lint check that warns you when setting a
null
value on aMutableLiveData
that has been defined in Kotlin as non-null. This is available when using thelivedata-core-ktx
orlivedata-ktx
artifacts. (aosp/1154723, aosp/1159092) - A new
lifecycle-runtime-testing
artifact is available that provides aTestLifecycleOwner
that implementsLifecycleOwner
and provides a thread safe mutableLifecycle
. (aosp/1242438)
Bug fixes
- The
lifecycle-runtime
artifact now has a unique package name. (aosp/1187196)
Version 2.2.0
ViewModel-Savedstate Version 2.2.0
February 5, 2020
androidx.lifecycle:lifecycle-viewmodel-savedstate:2.2.0
is released. Version 2.2.0 contains these commits.
Lifecycle ViewModel SavedState now shares the same version as other Lifecycle artifacts. The behavior of 2.2.0
is identical to the behavior of 1.0.0
.
Version 2.2.0
January 22, 2020
androidx.lifecycle:lifecycle-*:2.2.0
is released. Version 2.2.0 contains these commits.
Important changes since 2.1.0
- Lifecycle Coroutine Integration: The new
lifecycle-runtime-ktx
artifact adds integration between Lifecycle and Kotlin coroutines. Thelifecycle-livedata-ktx
has also been expanded to take advantage of coroutines. See Use Kotlin coroutines with Architecture Components for more details. ViewModelProviders.of()
deprecation:ViewModelProviders.of()
has been deprecated. You can pass aFragment
orFragmentActivity
to the newViewModelProvider(ViewModelStoreOwner)
constructor to achieve the same functionality when using Fragment1.2.0
.lifecycle-extensions
Artifact Deprecation: With the above deprecation ofViewModelProviders.of()
, this release marks the deprecation of the last API inlifecycle-extensions
and this artifact should now be considered deprecated in its entirety. We strongly recommend depending on the specific Lifecycle artifacts you need (such aslifecycle-service
if you’re usingLifecycleService
andlifecycle-process
if you’re usingProcessLifecycleOwner
) rather thanlifecycle-extensions
as there will not be a future2.3.0
release oflifecycle-extensions
.- Gradle Incremental Annotation Processor: Lifecycle's annotation processor is incremental by default.
If your app is written in the Java 8 programming language you can use
DefautLifecycleObserver
instead; and if it's written in the Java 7 programming language you can useLifecycleEventObserver
.
Version 2.2.0-rc03
December 4, 2019
androidx.lifecycle:lifecycle-*:2.2.0-rc03
is released. Version 2.2.0-rc03 contains these commits.
Bug fixes
- Fixed a failure occurring when a mocked
ViewModel
was stored inViewModelStore
and queried later with default factory. - Fix a usage of
Dispatchers.Main.immediate
inlaunchWhenCreated
and similar methods to be called synchronously during corresponding lifecycle event. (aosp/1156203)
External contributions
- Thanks to Anders Järleberg for contributing the fix! (aosp/1156203)
- Thanks to Vsevolod Tolstopyatov from Jetbrains for reviewing an implementation of inlined execution.
Dependency changes
- Lifecycle Extensions now depends on Fragment
1.2.0-rc03
.
Version 2.2.0-rc02
November 7, 2019
androidx.lifecycle:lifecycle-*:2.2.0-rc02
is released. Version 2.2.0-rc02 contains these commits.
Bug fixes
- Fixed a bug in the proguard setup of the library that affected devices running API 28+ if the target API is below 29. (b/142778206)
Version 2.2.0-rc01
October 23, 2019
androidx.lifecycle:lifecycle-*:2.2.0-rc01
is released. Version 2.2.0-rc01 contains these commits.
Bug fixes
- Fixed an issue where
launchWhenCreated
and related methods would run one frame later than the associated lifecycle method due to its use ofDispatchers.Main
instead ofDispatchers.Main.immediate
. (aosp/1145596)
External contributions
- Thanks to Nicklas Ansman for contributing the fix! (aosp/1145596)
Version 2.2.0-beta01
October 9, 2019
androidx.lifecycle:lifecycle-*:2.2.0-beta01
is released. Version 2.2.0-beta01 contains these commits.
Bug fixes
- Fixed a regression introduced in Lifecycle 2.2.0-alpha05 in the ordering of
ProcessLifecycleOwner
and the activity’sLifecycleOwner
moving to started and resumed on Android 10 devices. (aosp/1128132) - Fixed a regression introduced in Lifecycle
2.2.0-alpha05
which would cause aNullPointerException
when using version2.0.0
or2.1.0
oflifecycle-process
. (b/141536990)
Version 2.2.0-alpha05
September 18, 2019
androidx.lifecycle:lifecycle-*:2.2.0-alpha05
is released. Version 2.2.0-alpha05 contains these commits.
Bug fixes
- Fixed a race condition in coroutine livedata builder. b/140249349
Version 2.2.0-alpha04
September 5, 2019
androidx.lifecycle:lifecycle-*:2.2.0-alpha04
is released. The commits included in this version can be found here.
New features
lifecycleScope
,whenCreated
,whenStarted
,whenResumed
,viewModelScope
, and the underlying implementation ofliveData
now useDispatchers.Main.immediate
instead ofDispatchers.Main
. (b/139740492)
External contributions
- Thanks to Nicklas Ansman for contributing the move to
Dispatchers.Main.immediate
! (aosp/1106073)
Version 2.2.0-alpha03
August 7, 2019
androidx.lifecycle:lifecycle-*:2.2.0-alpha03
is released. The commits included in this version can be found here.
New features
- Implementations of
ViewModelStoreOwner
can now optionally implementHasDefaultViewModelProviderFactory
to provide a defaultViewModelProvider.Factory
. This has been done for Activity1.1.0-alpha02
, Fragment1.2.0-alpha02
, and Navigation2.2.0-alpha01
. (aosp/1092370, b/135716331)
API changes
ViewModelProviders.of()
has been deprecated. You can pass aFragment
orFragmentActivity
to the newViewModelProvider(ViewModelStoreOwner)
constructor to achieve the same functionality. (aosp/1009889)
Version 2.2.0-alpha02
July 2, 2019
androidx.lifecycle:*:2.2.0-alpha02
is released. The commits included in this version can be found here.
API changes
- Replaced
LiveDataScope.initialValue
withLiveDataScope.latestValue
which will track the current emitted value of theliveData
block. - Added a new overload to the
liveData
builder that receivestimeout
parameter as typeDuration
Version 2.2.0-alpha01
May 7, 2019
androidx.lifecycle:*:2.2.0-alpha01
is released. The commits included in this version can be found here.
New features
- This release adds new features that adds support for Kotlin coroutines for Lifecycle and LiveData. Detailed documentation on them can be found here.
ViewModel-SavedState Version 1.0.0
Version 1.0.0
January 22, 2020
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0
is released. Version 1.0.0 contains these commits.
Important features in 1.0.0
- New SavedStateHandle class was added. It enables your
ViewModel
classes to access and to contribute to the saved state. This object can be received in constructor ofViewModel
class and factories provided by default by Fragments and AppCompatActivity will injectSavedStateHandle
automatically. - AbstractSavedStateViewModelFactory was added. It allows you to create custom factories for your
ViewModel
and provide them access toSavedStateHandle
.
ViewModel-Savedstate Version 1.0.0-rc03
December 4, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc03
is released. Version 1.0.0-rc03 contains these commits.
Dependency changes
- Lifecycle ViewModel SavedState now depends on Lifecycle
2.2.0-rc03
.
Viewmodel-Savedstate Version 1.0.0-rc02
November 7, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc02
is released. Version 1.0.0-rc02 contains these commits.
Dependency changes
- Now depends on lifecycle
2.2.0-rc02
.
ViewModel-SavedState Version 1.0.0-rc01
October 23, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc01
is released with no changes from 1.0.0-beta01
. Version 1.0.0-rc01 contains these commits.
ViewModel-Savedstate Version 1.0.0-beta01
October 9, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-beta01
is released. Version 1.0.0-beta01 contains these commits.
Bug fixes
- Fixed an issue where accessing a SavedState ViewModel for the first time in
Activity.onActivityResult()
would result in anIllegalStateException
. (b/139093676) - Fixed an
IllegalStateException
when usingAbstractSavedStateViewModelFactory
. (b/141225984)
ViewModel-SavedState Version 1.0.0-alpha05
September 18, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha05
is released. Version 1.0.0-alpha05 contains these commits.
API changes
SavedStateViewModelFactory
no longer extendsAbstractSavedStateViewModelFactory
andSavedStateHandle
is created only for ViewModels that requested have it (aosp/1113593)
ViewModel-SavedState Version 1.0.0-alpha03
August 7, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha03
is released. The commits included in this version can be found here.
Breaking Changes
lifecycle-viewmodel-savedstate
no longer depends onfragment
and the relatedSavedStateViewModelFactory(Fragment)
andSavedStateViewModelFactory(FragmentActivity)
constructors have been removed. Instead,SavedStateViewModelFactory
is now the default factory for Activity1.1.0-alpha02
, Fragment1.2.0-alpha02
, and Navigation2.2.0-alpha01
. (b/135716331)
ViewModel-SavedState Version 1.0.0-alpha02
July 2, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha02
is released. The commits included in this version can be found here.
New features
- Added
SavedStateHandle.getLiveData()
overload which accepts a default value.
API Changes
SavedStateVMFactory
is renamed toSavedStateViewModelFactory
.AbstractSavedStateVMFactory
is renamed toAbstractSavedStateViewModelFactory
.
ViewModel-Savedstate Version 1.0.0-alpha01
March 13, 2019
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha01
is released. The full commit log for this initial release can be found here.
New features
- Now
ViewModels
can contribute to savedstate. To do that you use newly introduced viewmodel’s factorySavedStateVMFactory
and your ViewModel should have a constructor that receivesSavedStateHandle
object as a parameter.
Version 2.1.0
Important changes since 2.0.0
- Added
LifecycleEventObserver
for the cases when a stream of lifecycle events is needed. It is a public API instead of a hiddenGenericLifecycleObserver
class. - Added ktx extensions for
LiveData.observe
methods andTransformations.*
methods. - Added
Transformations.distinctUntilChanged
, which creates a new LiveData object that does not emit a value until the sourceLiveData
value has been changed. - Added coroutine support in ViewModels by adding the extension property
ViewModel.viewModelScope
.
Version 2.1.0
September 5, 2019
androidx.lifecycle:lifecycle-*:2.1.0
is released. The commits included in this version can be found here.
Version 2.1.0-rc01
July 2, 2019
androidx.lifecycle:*:2.1.0-rc01
is released with no changes from androidx.lifecycle:*:2.1.0-beta01
. The commits included in this version can be found here.
Version 2.1.0-beta01
May 7, 2019
androidx.lifecycle:*:2.1.0-beta01
is released. The commits included in this version can be found here.
New features
- Lifecycles are graduated to beta: api introduced in previous alphas such as
liveData
extension functions for transformations and observations,ViewModel
initialisation with property delegation and others are stabilised and not going to change.
Version 2.1.0-alpha04
April 3, 2019
androidx.lifecycle:*:2.1.0-alpha04
is released. The commits included in this version can be found here.
API changes
- Breaking change: the underlying API behind
by viewModels()
andby activityViewModels()
has been changed to support aViewModelStore
directly, rather than only aViewModelStoreOwner
. (aosp/932932)
Version 2.1.0-alpha03
March 13, 2019
androidx.lifecycle:*:2.1.0-alpha03
is released. The full list of commits included in this version can be found here.
API changes
ViewModelProvider.KeyedFactory
was removed. Second interface in addition toViewModelProvider.Factory
didn’t compose well with new features as property delegation in Kotlinby viewmodels {}
. (aosp/914133)
Version 2.1.0-alpha02
January 30, 2019
androidx.lifecycle 2.1.0-alpha02
is released.
API changes
LifecycleRegistry
now contains asetCurrentState()
method that replaces the now deprecatedsetState()
method. (aosp/880715)
Bug fixes
- Fixed an issue where mock
ViewModel
instances would crash when the containingViewModelStore
was cleared. b/122273087
Version 2.1.0-alpha01
December 17, 2018
androidx.lifecycle 2.1.0-alpha01
is released.
New features
- Added
LifecycleEventObserver
for the cases when a stream of lifecycle events is needed. It is a public api instead of a hiddenGenericLifecycleObserver
class. - Added ktx extensions for
LiveData.observe
methods andTransformations.*
methods. - Method
Transformations.distinctUntilChanged
was added. It creates a newLiveData
object that does not emit a value until the source LiveData value has been changed. - Coroutine support in ViewModels: extension property
ViewModel.viewModelScope
was added. - Added
ViewModelProvider.KeyedFactory
, a factory for ViewModels that receiveskey
andClass
increate
method.
Version 2.0.0
Version 2.0.0
September 21, 2018
Lifecycle 2.0.0
is released with one bugfix from 2.0.0-rc01
in ViewModel.
Bug Fixes
- Fixed a ViewModel proguard rule that incorrectly removed constructors b/112230489
Version 2.0.0-beta01
July 2, 2018
Bug Fixes
- Fixed LifecycleObserver proguard rule to keep only implementations, not subinterfaces b/71389427
- Fixed ViewModel proguard rules to allow obfuscation and shrinking
Pre-AndroidX Versions
For the pre-AndroidX versions of Lifecycle that follow, include these dependencies:
dependencies {
def lifecycle_version = "1.1.1"
// ViewModel and LiveData
implementation "android.arch.lifecycle:extensions:$lifecycle_version"
// alternatively - just ViewModel
implementation "android.arch.lifecycle:viewmodel:$lifecycle_version" // For Kotlin use viewmodel-ktx
// alternatively - just LiveData
implementation "android.arch.lifecycle:livedata:$lifecycle_version"
// alternatively - Lifecycles only (no ViewModel or LiveData).
// Support library depends on this lightweight import
implementation "android.arch.lifecycle:runtime:$lifecycle_version"
annotationProcessor "android.arch.lifecycle:compiler:$lifecycle_version" // For Kotlin use kapt instead of annotationProcessor
// alternately - if using Java8, use the following instead of compiler
implementation "android.arch.lifecycle:common-java8:$lifecycle_version"
// optional - ReactiveStreams support for LiveData
implementation "android.arch.lifecycle:reactivestreams:$lifecycle_version"
// optional - Test helpers for LiveData
testImplementation "android.arch.core:core-testing:$lifecycle_version"
}
Version 1.1.1
March 21, 2018
Only one small change: android.arch.core.util.Function
is moved from arch:runtime
to arch:common
. This allows it to be used without the runtime dependency, e.g. in paging:common
below.
lifecycle:common
is a dependency of lifecycle:runtime
, so this change doesn’t affect lifecycle:runtime
directly, only modules that depend directly on lifecycle:common
, as Paging does.
Version 1.1.0
January 22, 2018
Packaging Changes
New, much smaller dependencies are now available:
android.arch.lifecycle:livedata:1.1.0
android.arch.lifecycle:viewmodel:1.1.0
API Changes
- The deprecated
LifecycleActivity
andLifecycleFragment
have now been removed - please useFragmentActivity
,AppCompatActivity
or supportFragment
. @NonNull
annotations have been added toViewModelProviders
andViewModelStores
ViewModelProviders
constructor has been deprecated - please use its static methods directlyViewModelProviders.DefaultFactory
has been deprecated - please useViewModelProvider.AndroidViewModelFactory
- The static
ViewModelProvider.AndroidViewModelFactory.getInstance(Application)
method has been added to retrieve a staticFactory
suitable for creatingViewModel
andAndroidViewModel
instances.