Migrate the Material Date pickers to M3. by darrenaustin · Pull Request #118603 · flutter/flutter

darrenaustin · 2023-01-17T08:59:26Z

Part of: #91605

Updated the Date Pickers with support for Material Design 3.

In order to use the date pickers with the new Material 3 defaults, turn on the useMaterial3 flag in the ThemeData:

  return MaterialApp(
    theme: ThemeData(useMaterial3: true),
    // ...
  );

This PR includes a new DatePickerTheme that can be used to configure the look of the components used in the date picker widgets (i.e. showDatePicker, showDateRangePicker, DatePickerDialog, DateRangePickerDialog, CalendarDatePicker, and InputDatePickerTextField.

Fixes: #101481

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I signed the [CLA].
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is [test-exempt].
All existing and new tests are passing.

gspencergoog · 2023-01-17T18:17:36Z

dev/tools/gen_defaults/data/date_picker_modal.json

  "md.comp.date-picker.modal.range-selection.container.shape": "md.sys.shape.corner.none",
  "md.comp.date-picker.modal.range-selection.date.in-range.focus.state-layer.color": "onPrimaryContainer",
-  "md.comp.date-picker.modal.range-selection.date.in-range.focus.state-layer.opcaity": "md.sys.state.focus.state-layer-opacity",
+  "md.comp.date-picker.modal.range-selection.date.in-range.focus.state-layer.opacity": "md.sys.state.focus.state-layer-opacity",


Nice catch!

gspencergoog · 2023-01-17T18:22:31Z

packages/flutter/lib/src/material/date_picker.dart


-const Size _calendarPortraitDialogSize = Size(330.0, 518.0);
+// The M3 sizes are coming from the tokens, but are hand coded,
+// as the current token DB does not contain landscape versions.


Could you put these values into the template so that if they add the landscape versions we only need to change the template?

I attempted this. Unfortunately only the portrait dialog dimensions, "md.comp.date-picker.modal.container{.width,height}" appear literally in the tokens data. The other four sizes used by date_picker.dart aren't given explicitly. Additionally: exposing these sizes in the date picker's theme would be difficult because so much of the layout depends on the overall size of each container. Loosening up the layout interdependencies to enable developers to customize the size of each dialog variation, might yield more complexity than it's worth.

So for now, I'd like to leave this internal size constants as they are.

The way I handled this for the time picker was to have an intermediary abstract class for the defaults that had some local size values that could be used in the code, but weren't exposed in the public Theme API. For example, here. They could then be overridden for M2 and M3 variants.

The other advantage of that approach was that all of the properties can be changed to return non-nullable versions, so that none of the references in the code need to have a ! on them.

gspencergoog · 2023-01-17T18:23:54Z

packages/flutter/lib/src/material/date_picker.dart


  Size _dialogSize(BuildContext context) {
    final Orientation orientation = MediaQuery.orientationOf(context);
+    final bool useMaterial3 = Theme.of(context).useMaterial3;


Maybe move this into the switch statements, so that in the case where it's landscape, it doesn't need to set up an inheritance dependency on Theme? I mean, I know it's probably going to have one anyhow, but if we convert theme to an InheritedModel or something someday, that will be important.

See #118603 (comment)

gspencergoog · 2023-01-17T18:25:50Z

packages/flutter/lib/src/material/date_picker.dart

-    final TextTheme textTheme = theme.textTheme;
+    final DatePickerThemeData datePickerTheme = DatePickerTheme.of(context);
+    final DatePickerThemeData defaults = DatePickerTheme.defaults(context);
+    final bool useMaterial3 = Theme.of(context).useMaterial3;


You could move the Theme.of(context) to a local final theme variable to avoid looking it up three times.

Addressed in 70d860d

gspencergoog · 2023-01-17T18:28:44Z

packages/flutter/lib/src/material/date_picker.dart

@@ -581,14 +597,24 @@ class _DatePickerDialogState extends State<DatePickerDialog> with RestorationMix
          : localizations.datePickerHelpText.toUpperCase()


Use the new useMaterial3 variable here instead.

Addressed in 70d860d

gspencergoog · 2023-01-17T18:39:26Z

packages/flutter/lib/src/material/date_picker_theme.dart

+  /// The text style used for each individual day label in the grid of the
+  /// date picker.
+  ///
+  /// The color of the [dayStyle] is not used directly, as


Same comment here about it sounding deprecated.

Addressed in 024dad5

gspencergoog · 2023-01-17T18:41:14Z

packages/flutter/lib/src/material/date_picker_theme.dart

+  /// The text style used to paint each of the year entries in the year
+  /// selector of the date picker.
+  ///
+  /// The color of the [yearStyle] is not used directly, as


Same comment about deprecation.

Addressed in 024dad5

gspencergoog · 2023-01-17T18:41:51Z

packages/flutter/lib/src/material/date_picker_theme.dart

+  /// The color used for text labels and icons in the header of a full
+  /// screen [DateRangePickerDialog]
+  ///
+  /// This is used instead of any colors provided by


So why do those exist?

This kind of issue comes up all of the time with compound visual style properties like BorderSide and TextStyle. The motive for setting up TextStyle properties with a separate text color property is two common cases:

Use the default TextStyle but override the default text color. Don't make the user create a TextStyle that matches the default just to change the color.

Override the default TextStyle but do not override the default text color. Similar to above and note that the default color for a TextTheme TextStyle is likely to be wrong.

gspencergoog · 2023-01-17T18:45:19Z

packages/flutter/lib/src/material/date_picker_theme.dart

+      dayForegroundColor: dayForegroundColor ?? this.dayForegroundColor,
+      dayBackgroundColor: dayBackgroundColor ?? this.dayBackgroundColor,
+      dayOverlayColor: dayOverlayColor ?? this.dayOverlayColor,
+      todayForegroundColor: todayForegroundColor ?? this.todayForegroundColor,


What about todayBackgroundColor?

Nice catch! Addressed in 024dad5

gspencergoog · 2023-01-17T18:47:15Z

packages/flutter/lib/src/material/input_date_picker_form_field.dart

@@ -239,9 +239,13 @@ class _InputDatePickerFormFieldState extends State<InputDatePickerFormField> {
  Widget build(BuildContext context) {
    final MaterialLocalizations localizations = MaterialLocalizations.of(context);
    final InputDecorationTheme inputTheme = Theme.of(context).inputDecorationTheme;


You could separate out a theme final var here too.

Addressed in 70d860d

HansMuller · 2023-01-24T00:20:10Z

This PR has been continued in a new PR: #119033

Migrate the Material Date pickers to M3.

2c89b0e

flutter-dashboard bot added f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. c: contributor-productivity Team-specific productivity, code health, technical debt. labels Jan 17, 2023

darrenaustin requested review from HansMuller and gspencergoog January 17, 2023 08:59

gspencergoog reviewed Jan 17, 2023

View reviewed changes

HansMuller mentioned this pull request Jan 24, 2023

Migrate the Material Date pickers to M3 Reprise #119033

Merged

8 tasks

HansMuller closed this Jan 24, 2023

		@@ -581,14 +597,24 @@ class _DatePickerDialogState extends State<DatePickerDialog> with RestorationMix
		: localizations.datePickerHelpText.toUpperCase()

Conversation

darrenaustin commented Jan 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gspencergoog Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HansMuller Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HansMuller commented Jan 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

darrenaustin commented Jan 17, 2023 •

edited

Loading

gspencergoog Jan 24, 2023 •

edited

Loading

HansMuller Jan 24, 2023 •

edited

Loading