[MaterialDatePicker][a11y] Announce current year and day

PiperOrigin-RevId: 479303709

Author: paulfthomas

lib/java/com/google/android/material/datepicker/DateStrings.java

@@ -15,6 +15,9 @@
  */
 package com.google.android.material.datepicker;
 
+import com.google.android.material.R;
+
+import android.content.Context;
 import android.icu.text.DateFormat;
 import android.os.Build.VERSION;
 import android.os.Build.VERSION_CODES;
@@ -198,4 +201,37 @@ static Pair<String, String> getDateRangeString(
     return Pair.create(
         getYearMonthDay(start, Locale.getDefault()), getYearMonthDay(end, Locale.getDefault()));
   }
+
+  /**
+   * Returns the day content description.
+   *
+   * @param context the {@link Context}
+   * @param dayInMillis UTC milliseconds representing the first moment of the day in local timezone
+   * @param isToday boolean representing if the day is today
+   * @return Day content description string
+   */
+  static String getDayContentDescription(Context context, long dayInMillis, boolean isToday) {
+    String dayContentDescription = getOptionalYearMonthDayOfWeekDay(dayInMillis);
+    if (isToday) {
+      return String.format(
+          context.getString(R.string.mtrl_picker_today_description), dayContentDescription);
+    }
+    return dayContentDescription;
+  }
+
+  /**
+   * Returns the year content description.
+   *
+   * @param context the {@link Context}
+   * @param year the year, example: 2020
+   * @return Year content description string
+   */
+  static String getYearContentDescription(Context context, int year) {
+    if (UtcDates.getTodayCalendar().get(Calendar.YEAR) == year) {
+      return String.format(
+          context.getString(R.string.mtrl_picker_navigate_to_current_year_description), year);
+    }
+    return String.format(
+        context.getString(R.string.mtrl_picker_navigate_to_year_description), year);
+  }
 }

lib/java/com/google/android/material/datepicker/MonthAdapter.java

@@ -138,7 +138,9 @@ public TextView getView(int position, @Nullable View convertView, @NonNull ViewG
       Locale locale = dayTextView.getResources().getConfiguration().locale;
       dayTextView.setText(String.format(locale, "%d", dayNumber));
       long dayInMillis = month.getDay(dayNumber);
-      dayTextView.setContentDescription(DateStrings.getOptionalYearMonthDayOfWeekDay(dayInMillis));
+      dayTextView.setContentDescription(
+          DateStrings.getDayContentDescription(
+              dayTextView.getContext(), dayInMillis, isToday(dayInMillis)));
       dayTextView.setVisibility(View.VISIBLE);
       dayTextView.setEnabled(true);
     }
@@ -187,13 +189,14 @@ private void updateSelectedState(@Nullable TextView dayTextView, long date, int
     final CalendarItemStyle style;
     boolean valid = calendarConstraints.getDateValidator().isValid(date);
     boolean selected = false;
+    boolean isToday = isToday(date);
     if (valid) {
       dayTextView.setEnabled(true);
       selected = isSelected(date);
       dayTextView.setSelected(selected);
       if (selected) {
         style = calendarStyle.selectedDay;
-      } else if (UtcDates.getTodayCalendar().getTimeInMillis() == date) {
+      } else if (isToday) {
         style = calendarStyle.todayDay;
       } else {
         style = calendarStyle.day;
@@ -234,13 +237,17 @@ private void updateSelectedState(@Nullable TextView dayTextView, long date, int
               dayNumber,
               valid,
               selected,
-              DateStrings.getOptionalYearMonthDayOfWeekDay(dayInMillis));
+              DateStrings.getDayContentDescription(context, dayInMillis, isToday));
       dayTextView.setContentDescription(decoratorContentDescription);
     } else {
       style.styleItem(dayTextView);
     }
   }
 
+  private boolean isToday(long date) {
+    return UtcDates.getTodayCalendar().getTimeInMillis() == date;
+  }
+
   private boolean isSelected(long date) {
     for (long selectedDay : dateSelector.getSelectedDays()) {
       if (UtcDates.canonicalYearMonthDay(date) == UtcDates.canonicalYearMonthDay(selectedDay)) {

lib/java/com/google/android/material/datepicker/YearGridAdapter.java

@@ -59,13 +59,9 @@ public YearGridAdapter.ViewHolder onCreateViewHolder(@NonNull ViewGroup viewGrou
   @Override
   public void onBindViewHolder(@NonNull YearGridAdapter.ViewHolder viewHolder, int position) {
     int year = getYearForPosition(position);
-    String navigateYear =
-        viewHolder
-            .textView
-            .getContext()
-            .getString(R.string.mtrl_picker_navigate_to_year_description);
     viewHolder.textView.setText(String.format(Locale.getDefault(), "%d", year));
-    viewHolder.textView.setContentDescription(String.format(navigateYear, year));
+    viewHolder.textView.setContentDescription(
+        DateStrings.getYearContentDescription(viewHolder.textView.getContext(), year));
     CalendarStyle styles = materialCalendar.getCalendarStyle();
     Calendar calendar = UtcDates.getTodayCalendar();
     CalendarItemStyle style = calendar.get(Calendar.YEAR) == year ? styles.todayYear : styles.year;

lib/java/com/google/android/material/datepicker/res/values/strings.xml

@@ -48,6 +48,8 @@
   <string name="mtrl_picker_toggle_to_day_selection" description="a11y string to indicate this button switches the user to choosing a day [CHAR_LIMIT=NONE]">Tap to switch to Calendar view</string>
   <string name="mtrl_picker_day_of_week_column_header" description="a11y string to indicate this is a header for a column of days for one day of the week (e.g., Monday) [CHAR_LIMIT=NONE]">Column of days: %1$s</string>
   <string name="mtrl_picker_announce_current_selection" description="a11y string read on selection change to indicate the new selection [CHAR_LIMIT=NONE]">Current selection: %1$s</string>
-  <string name="mtrl_picker_navigate_to_year_description" description="a11y string that informs the user that tapping this button will switch the year [CHAR_LIMIT=NONE]">Navigate to year %1$s</string>
+  <string name="mtrl_picker_navigate_to_year_description" description="a11y string that informs the user that tapping this button will switch the year [CHAR_LIMIT=NONE]">Navigate to year %1$d</string>
+  <string name="mtrl_picker_navigate_to_current_year_description" description="a11y string that informs the user that tapping this button will switch the current year [CHAR_LIMIT=NONE]">Navigate to current year %1$d</string>
+  <string name="mtrl_picker_today_description" description="a11y string that informs the user that the focused day is today [CHAR_LIMIT=NONE]">Today %1$s</string>
 
 </resources>

lib/javatests/com/google/android/material/datepicker/DateStringsTest.java

@@ -15,11 +15,12 @@
  */
 package com.google.android.material.datepicker;
 
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
-import static org.junit.Assert.assertThat;
 
 import android.os.Build.VERSION_CODES;
 import androidx.core.util.Pair;
+import androidx.test.core.app.ApplicationProvider;
 import java.text.SimpleDateFormat;
 import java.util.Calendar;
 import java.util.Locale;
@@ -297,4 +298,37 @@ public void getDateRangeStringMultipleYearsWithUserDefinedDateFormat() {
     assertThat(dateRangeString.first, is("May 30"));
     assertThat(dateRangeString.second, is("Dec 05"));
   }
+
+  @Test
+  public void getDayContentDescription_notToday() {
+    startDate = setupLocalizedCalendar(Locale.US, 2020, 10, 30);
+    String contentDescription =
+        DateStrings.getDayContentDescription(
+            ApplicationProvider.getApplicationContext(), startDate.getTimeInMillis(), false);
+    assertThat(contentDescription, is("Mon, Nov 30, 2020"));
+  }
+
+  @Test
+  public void getDayContentDescription_today() {
+    startDate = setupLocalizedCalendar(Locale.US, 2020, 10, 30);
+    String contentDescription =
+        DateStrings.getDayContentDescription(
+            ApplicationProvider.getApplicationContext(), startDate.getTimeInMillis(), true);
+    assertThat(contentDescription, is("Today Mon, Nov 30, 2020"));
+  }
+
+  @Test
+  public void getYearContentDescription_notCurrent() {
+    String contentDescription =
+        DateStrings.getYearContentDescription(ApplicationProvider.getApplicationContext(), 2020);
+    assertThat(contentDescription, is("Navigate to year 2020"));
+  }
+
+  @Test
+  public void getYearContentDescription_current() {
+    String contentDescription =
+        DateStrings.getYearContentDescription(
+            ApplicationProvider.getApplicationContext(), CURRENT_YEAR);
+    assertThat(contentDescription, is("Navigate to current year " + CURRENT_YEAR));
+  }
 }