commit | 3a465bec0f12c68d9478eed4cf1d557ef8dbdefd | [log] [tgz] |
---|---|---|
author | Marcello Galhardo <mgalhardo@google.com> | Wed Apr 30 11:13:47 2025 +0100 |
committer | Marcello Galhardo <mgalhardo@google.com> | Wed Apr 30 14:46:44 2025 -0700 |
tree | c6820cee95cd0b6c51b5aa089eb8e3219f0aabd2 | |
parent | 2384f5f61687f562f6da53756df5c25751a2f85c [diff] |
Deprecate `rememberSaveable` with custom key parameter The custom `key` parameter in `rememberSaveable` bypassed standard position-based state scoping (`currentCompositeKeyHash`), leading to inconsistent behavior and potential bugs. Consequently, a mix of position-based and globally keyed state emerged, leading to problematic edge cases. State could be unintentionally shared or become lost due to factors like key uniqueness and timing. If keys weren't globally unique, unrelated code sections could interfere with each other's state. This issue was notably observed in nested `LazyLayout`, where using `rememberSaveable` with a custom key caused state loss, a problem not seen when the content was wrapped in `movableContentOf` (which relies on positional scoping). These subtle failures highlight the importance of avoiding global keys and instead using composition-local scoping. To ensure consistent and predictable behaviour, all `rememberSaveable` variants accepting a custom `key` are now deprecated. Developers should migrate to the default `rememberSaveable` which relies on `currentCompositeKeyHash`. RelNote: "Deprecated 'rememberSaveable' with a custom 'key'. It bypasses positional scoping, leading to state bugs and inconsistent behavior (e.g., unintentional state sharing or loss, issues in nested LazyLayouts). Please remove the 'key' parameter to use positional scoping for consistent, locally-scoped state. See https://r.android.com/3610053 for details." Test: Existing tests passes Bug: 357685851 Change-Id: I5e6ff7f527aafea4845f21a104500a902951fe10
Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.
Jetpack comprises the androidx.*
package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.
Our official AARs and JARs binaries are distributed through Google Maven.
You can learn more about using it from Android Jetpack landing page.
For contributions via GitHub, see the GitHub Contribution Guide.
Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:
When contributing to Jetpack, follow the code review etiquette.
We are not currently accepting new modules.
Head over to the onboarding docs to learn more about getting set up and the development workflow!
Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.
Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:
Generate a HTTPS password: https://android-review.googlesource.com/new-password
Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement
AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal
and prebuilts/androidx/external
directories in your checkout. All the dependencies in these directories are also available from google()
, or mavenCentral()
. We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.