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-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

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
Author: Shalom Gibly <sgibly@google.com>
Link: https://android-review.googlesource.com/3288175

Date pickers Locale support

Expand for full commit details

Date pickers Locale support

This change improves how the DatePicker and DateRangePicker handle
locales when a Locale that was set by the date picker's state wasn't
consistently applied to all its parts, leading to potential
inconsistencies in things like date formatting, weekday names, the
first day of the week, etc.

The DatePickerState and the DateRangePickerState were modified to
include and expose a Locale value that can be used by the various parts
of the UI.

There are two ways to create the state:
- Using remember functions: This will default to your device's locale
  and is the recommended way.
- Using DatePickerState or DateRangePickerState directly: This allows
  you to specify a custom Locale that will be applied most of the date
  picker parts, but not all. Note that the title and the headline's
  default text will need to be adjusted to support a specific Locale in
  case a specific one is set.

Fixes: 326490763
Fixes: 321657276
Test: additional date picker and input tests
Relnote: "Updates to the date pickers to ensure consistent Locale
usage throughout the DatePicker and DateRangePicker when setting a
Locale directly through a DatePickerState or a DateRangePickerState.
Note that when setting Locales directly to the state, it's up to you to
ensure that the title and headline texts are localized accordingly, as
their default text will still be applied according to the default
platform Locale."

Change-Id: I370735477b6adae8628fb967b6aa6c6138216883

Files:

M compose/material3/material3/api/current.txt
M compose/material3/material3/api/restricted_current.txt
M compose/material3/material3/samples/src/main/java/androidx/compose/material3/samples/DatePickerSamples.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DateInputTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DatePickerScreenshotTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DatePickerTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DateRangeInputTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DateRangePickerScreenshotTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/DateRangePickerTest.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/DateInput.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/DatePicker.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/DateRangeInput.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/DateRangePicker.kt

Hash: 2579989ac2b9c281d530ffbf1d1bd9d89fb91270
Date: Mon Sep 30 10:51:27 2024

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

Fixed. Please read the commit details for some "gotchas" when applying the Locale just on the picker's state.

The state's locale will only affect the inner parts of the picker, but not the strings that are displayed at the headline placeholder strings, or title.

To force everything into a non-default Locale, you can do something like this:

 val preferredLocales = LocaleList.forLanguageTags("hr")
 val config = Configuration()
 config.setLocales(preferredLocales)
 val newContext = LocalContext.current.createConfigurationContext(config)

 CompositionLocalProvider(
     LocalContext provides newContext,
     LocalConfiguration provides config
 ) {
      DatePicker(state = rememberDatePickerState())
 }

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

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

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.material3:material3:1.4.0-alpha02
androidx.compose.material3:material3-android:1.4.0-alpha02
androidx.compose.material3:material3-jvmstubs:1.4.0-alpha02
androidx.compose.material3:material3-linuxx64stubs:1.4.0-alpha02

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