DatePicker Ignores Explicit locale Setting in DatePickerState, Defaulting to System Locale [326490763]

Fixed

Bug

Status Update

No update yet.

Description

rr...@gmail.com

created issue #1

Feb 23, 2024 12:56PM

Environment

Jetpack Compose version: BOM 2024.02.01
Jetpack Compose component used: DatePicker
Android Studio Build: Android Studio Hedgehog | 2023.1.1 Patch 2
Kotlin version: 1.9.0

Description

The DatePicker component in Jetpack Compose Material 3 does not respect the locale setting provided through DatePickerState. Despite explicitly setting a locale (e.g., Locale("hr", "HR")), the DatePicker continues to use the system's default locale as determined by LocalConfiguration.current.locales[0]. The specified locale is installed on the device.

Expected Behavior

When a locale is explicitly set in DatePickerState, the DatePicker UI should adapt to use this locale for localizing labels, captions, titles, etc. If the specified locale is not installed on the device, it should fall back to using LocalConfiguration.current.locales[0].

Current Behavior

The DatePicker ignores the explicitly set locale in DatePickerState and always uses the system's default locale. This results in the UI not being localized according to the specified locale, affecting user experience for non-default language users.

Steps to Reproduce

Install additional device input language for example Croatian/Croatia
Leave English/United State as a default system language
Implement a DatePicker composable with DatePickerState explicitly set to the Croatian locale (Locale("hr", "HR")).
Observe that the DatePicker UI elements are not localized to Croatian and instead use the system's default locale.

Code sample

@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun SimpleDatePicker() {
    // Setup initial date and state
    val calendar = CalendarHelper.getLocalInstance().toStartOfDay()
    val initialDateInUtcMillis = calendar.timeInMillis.toUtcMillisFromLocal()
    val datePickerState = DatePickerState(
        initialSelectedDateMillis = initialDateInUtcMillis,
        initialDisplayedMonthMillis = initialDateInUtcMillis,
        initialDisplayMode = DisplayMode.Picker,
        locale = Locale("hr", "HR")
    )

    DatePicker(
        state = datePickerState,
        modifier = Modifier.fillMaxSize()
    )
}

Probable Cause

The DatePicker implementation seems to ignore the locale parameter in DatePickerState, defaulting to the system's default locale. This is evident in the construction of the calendarModel within the DatePicker, where defaultLocale() is always used regardless of the locale specified in the state.

Suggested Fix

Modify the DatePicker implementation to respect the locale provided in DatePickerState when creating the calendarModel, ensuring that UI elements are correctly localized.

Additional Information

While the recommended approach for managing DatePickerState is through rememberDatePickerState, it does not allow for explicit localization settings via the locale parameter. This limitation becomes apparent in use cases requiring specific locale settings that differ from the system default. Although it's possible to manually implement a rememberSaveable solution that includes the locale, providing a first-class support or clearer guidance for such scenarios within the Compose framework would enhance its usability and flexibility for developers facing similar localization requirements.

Comments

ma...@google.com <ma...@google.com> #2Feb 26, 2024 07:41PM

Reassigned to ma...@google.com.

Project: platform/frameworks/support
Branch: androidx-main

commit 0154910724cdc44253af1d2f8cede76264783226
Author: Aurimas Liutikas <aurimas@google.com>
Date: Thu Jun 27 15:25:02 2024

Expand native target support for annotation and collection libraries

- Enable watchos and tvos download in importMaven
- Add support for watchos and tvos targets in AndroidXMultiplatformExtension
- Enable watchos and tvos in :annotation:annotation
- Enable linuxArm64, watchos, and tvos in :collection:collection

This work is required as we work towards setting up native stubs for
compose projects.

Test: ./gradlew collection:collection:publish
Bug: 349894318
Change-Id: Idfd1faa3a826bb91ee14722f7437bdcf99cf0018

M annotation/annotation/build.gradle
M buildSrc/private/src/main/kotlin/androidx/build/AndroidXMultiplatformExtension.kt
M buildSrc/public/src/main/kotlin/androidx/build/KmpPlatforms.kt
M collection/collection/build.gradle
M development/build_log_simplifier/messages.ignore
M development/importMaven/src/main/kotlin/androidx/build/importMaven/KmpConfig.kt

https://android-review.googlesource.com/3151736

sg...@google.com <sg...@google.com> Sep 30, 2024 04:46PM

Accepted by sg...@google.com.

ap...@google.com <ap...@google.com> #3Oct 9, 2024 07:51PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-main

commit 39cd1e9f7579513bde139c17f9c51f9012d56152
Author: Aurimas Liutikas <aurimas@google.com>
Date: Thu Jun 27 15:25:02 2024

Expand native target support for annotation and collection libraries

Reland

r.android.com/3151736 now with workaround for

https://youtrack.jetbrains.com/issue/KT-62653

- Enable watchos and tvos download in importMaven
- Add support for watchos and tvos targets in AndroidXMultiplatformExtension
- Enable watchos and tvos in :annotation:annotation
- Enable linuxArm64, watchos, and tvos in :collection:collection

This work is required as we work towards setting up native stubs for
compose projects.

Test: ./gradlew collection:collection:publish
Bug: 349894318
Change-Id: Ic795af8486db48b31633799e06665717d08398db

M annotation/annotation/build.gradle
M buildSrc/private/src/main/kotlin/androidx/build/AndroidXMultiplatformExtension.kt
M buildSrc/public/src/main/kotlin/androidx/build/KmpPlatforms.kt
M collection/collection/build.gradle
M development/build_log_simplifier/messages.ignore
M development/importMaven/src/main/kotlin/androidx/build/importMaven/KmpConfig.kt

https://android-review.googlesource.com/3156121

sg...@google.com <sg...@google.com> #4Oct 9, 2024 07:59PM

Project: platform/frameworks/support
Branch: androidx-main

commit c3a06e79cf427aef1cf0ede1bacb463eb89472be
Author: Aurimas Liutikas <aurimas@google.com>
Date: Thu Jun 27 15:25:02 2024

Expand native target support for annotation and collection libraries

Reland

r.android.com/3151736 /

r.android.com/3156121 but now with
moving to project(":annotation:annotation") in commonMain as due to

https://youtrack.jetbrains.com/issue/KT-62653 we cannot depend on
project in one source set and prebuilt in the other.

- Enable watchos and tvos download in importMaven
- Add support for watchos and tvos targets in AndroidXMultiplatformExtension
- Enable watchos and tvos in :annotation:annotation
- Enable linuxArm64, watchos, and tvos in :collection:collection

This work is required as we work towards setting up native stubs for
compose projects.

Test: ./gradlew collection:collection:publish
Bug: 349894318
Change-Id: I7f2a1bddbe79ab5e920cdb01ca6a428950a8c2c3

M annotation/annotation/build.gradle
M buildSrc/private/src/main/kotlin/androidx/build/AndroidXMultiplatformExtension.kt
M buildSrc/public/src/main/kotlin/androidx/build/KmpPlatforms.kt
M busytown/androidx_multiplatform_mac_host_tests_arm64.sh
M camera/integration-tests/avsynctestapp/build.gradle
M collection/collection/build.gradle
M development/build_log_simplifier/messages.ignore
M development/importMaven/src/main/kotlin/androidx/build/importMaven/KmpConfig.kt
M test/uiautomator/integration-tests/testapp/build.gradle
M wear/compose/integration-tests/navigation/build.gradle

https://android-review.googlesource.com/3156423

Message last modified on Oct 9, 2024 08:07PM

na...@google.com <na...@google.com> #5Oct 16, 2024 05:48PM

Project: platform/frameworks/support
Branch: androidx-main

commit c56a2faf24c82bf961cb10440156745bf3cf30bd
Author: Aurimas Liutikas <aurimas@google.com>
Date: Wed Jul 03 11:10:40 2024

Add linuxX64Stubs for compose runtime libraries

- Add support for linuxX64Stubs
- Add these linuxX64Stubs to compose runtime projects
- Move OperationsTest from commonTest to jvmTest as it has
jvm-reflection usages

Bug: 349894318
Test: ./gradlew -p compose/runtime build
Change-Id: Ia600fafb174b585cf5a0d7a7f3c3726d10b4cc92

M buildSrc/private/src/main/kotlin/androidx/build/AndroidXMultiplatformExtension.kt
M buildSrc/public/src/main/kotlin/androidx/build/KmpPlatforms.kt
M compose/runtime/runtime-saveable/build.gradle
M compose/runtime/runtime-test-utils/build.gradle
A compose/runtime/runtime-test-utils/src/commonMain/kotlin/androidx/compose/runtime/mock/SynchronizedObject.kt
M compose/runtime/runtime-test-utils/src/commonMain/kotlin/androidx/compose/runtime/mock/TestMonotonicFrameClock.kt
A compose/runtime/runtime-test-utils/src/jvmMain/kotlin/androidx/compose/runtime/mock/SynchronizedObject.jvm.kt
A compose/runtime/runtime-test-utils/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/mock/SynchronizedObject.linuxx64Stubs.kt
M compose/runtime/runtime/build.gradle
M compose/runtime/runtime/src/commonMain/kotlin/androidx/compose/runtime/Stack.kt
M compose/runtime/runtime/src/commonMain/kotlin/androidx/compose/runtime/collection/ScopeMap.kt
M compose/runtime/runtime/src/commonMain/kotlin/androidx/compose/runtime/snapshots/SnapshotStateSet.kt
M compose/runtime/runtime/src/commonTest/kotlin/androidx/compose/runtime/CompositionTestExtensions.kt
M compose/runtime/runtime/src/jvmTest/kotlin/androidx/compose/runtime/changelist/OperationsTest.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/MonotonicFrameClock.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/NotImplemented.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/SynchronizedObject.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/TestOnly.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/Atomic.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/ComposableLambda.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/JvmDefaultWithCompatibility.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/Thread.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/Utils.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/internal/WeakReference.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsMain/kotlin/androidx/compose/runtime/snapshots/SnapshotContextElement.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsTest/kotlin/kotlinx/test/IgnoreAndroidUnitTestTarget.linuxx64Stubs.kt
A compose/runtime/runtime/src/linuxx64StubsTest/kotlin/kotlinx/test/IgnoreJsTarget.linuxx64Stubs.kt

https://android-review.googlesource.com/3159861

Issue 326490763

Description

Environment

Description

Expected Behavior

Current Behavior

Steps to Reproduce

Code sample

Probable Cause

Suggested Fix

Additional Information

Issue summary

Comments

ma...@google.com <ma...@google.com> #2Feb 26, 2024 07:41PM

sg...@google.com <sg...@google.com> Sep 30, 2024 04:46PM

ap...@google.com <ap...@google.com> #3Oct 9, 2024 07:51PM

sg...@google.com <sg...@google.com> #4Oct 9, 2024 07:59PM

na...@google.com <na...@google.com> #5Oct 16, 2024 05:48PM

Add comment

Issue metadata