Docs: Update date picker theme day color properties doc #166122

rkishan516 · 2025-03-28T07:09:50Z

Docs: Update date picker theme day color properties doc
fixes: #161052
Part 2 of #164972

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].
I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
All existing and new tests are passing.

flutter-dashboard · 2025-04-09T03:36:06Z

Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #166122 at sha e75d24b

MitchellGoodwin

I've been thinking about this PR, and I'm not convinced that these properties are necessary. The combinations of dayOverlayColor, dayForegroundColor and dayBackgroundColor should cover the necessary styling options. These properties seem like they clash with dayOverlayColor, and what do they do differently from adding the logic to look for the selected property in dayBackgroundColor and dayForegroundColor?

rkishan516 · 2025-04-11T01:13:35Z

I've been thinking about this PR, and I'm not convinced that these properties are necessary. The combinations of dayOverlayColor, dayForegroundColor and dayBackgroundColor should cover the necessary styling options. These properties seem like they clash with dayOverlayColor, and what do they do differently from adding the logic to look for the selected property in dayBackgroundColor and dayForegroundColor?

Make sense, by looking at #161052 (comment) I thought dayOverlayColor, dayForegroundColor and dayBackgroundColor are of type Color but actually its of type WidgetStateProperty.

So, I think here making doc change is enough rather than adding property.

MitchellGoodwin

Thank you for converting to a documentation change. I think this will really improve clarity.

MitchellGoodwin · 2025-04-15T19:51:41Z

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

  /// This will be used instead of the color provided in [dayStyle].
+  ///
+  /// This supports different colors based on the [WidgetState]s of
+  /// the day button, such as [WidgetState.selected], [WidgetState.hovered],


Nit: slightly prefer using ` instead of [. I think linking directly to the values of WidgetState currently breaks.

If i am not wrong, then In theme properties, we don't directly use values, because user can give their own theme rather that default provided theme.

Sorry, I meant the documentation breaks. Dart doc seem to handle some enums poorly.

https://api.flutter.dev/flutter/widgets/WidgetStateColor-class.html

If you click on WidgetState.pressed it goes to an invalid page. Same with the others.

Ohh, Sorry I misunderstood. Yaa, I saw a open issue related to this.
I have pushed the change as you mentioned.

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

MitchellGoodwin

LGTM! Thank you for making these changes.

QuncCccccc

LGTM:) Thank you for adding the doc!

QuncCccccc · 2025-04-17T18:00:18Z

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

+  ///   if (states.contains(WidgetState.selected)) {
+  ///     return Theme.of(context).colorScheme.primary;
+  ///   }
+  ///   return Colors.transparent;


We can set this else part to null to remind developers that setting to null will just return the default color:)

Suggested change

/// return Colors.transparent;

/// return null; // Use the default color.

QuncCccccc · 2025-04-17T18:01:14Z

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

+  ///   if (states.contains(WidgetState.selected)) {
+  ///     return Theme.of(context).colorScheme.primary;
+  ///   }
+  ///   return Colors.transparent;


Here as well and below:)

I have updated based on your review.

justinmc

LGTM, just a question for the future. Thanks for improving the docs.

justinmc · 2025-04-17T18:03:18Z

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

+  /// This supports different colors based on the [WidgetState]s of
+  /// the day button, such as `WidgetState.selected`, `WidgetState.hovered`,
+  /// `WidgetState.focused`, and `WidgetState.disabled`.


Should we expect to add a comment like this on every WidgetStateProperty?

I think it would be good if we could clarify which WidgetStates are supported in doc:)

~~If so, then should this comment be more precise instead of saying "such as"? That makes it seem like it might support other WidgetStates too.~~

Edit: Scratch that, in this case it's up to the app developer which states they're going to do anything with :)

QuncCccccc · 2025-04-18T20:40:11Z

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

+  ///   if (states.contains(WidgetState.focused)) {
+  ///     return Colors.blue.withOpacity(0.12);
+  ///   }
+  ///   return Colors.transparent;


Would be good to do the same update here:) Colors.transparent is also fine. I just feel providing a null example contains more info.

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

…utter/flutter#166122)

flutter/flutter@3ed38e2...cfb887c 2025-04-20 [email protected] Roll Fuchsia Linux SDK from 0U_vEALFF7qRJZ_cE... to RGmU4KeQhrxqE7hsr... (flutter/flutter#167447) 2025-04-19 [email protected] Roll Skia from 3dc3ffeb45f0 to bd9ef4955aad (1 revision) (flutter/flutter#167434) 2025-04-19 [email protected] Roll Fuchsia Linux SDK from MwYckh5OvwwmIYLx0... to 0U_vEALFF7qRJZ_cE... (flutter/flutter#167430) 2025-04-19 [email protected] Roll Skia from 177a2929e32f to 3dc3ffeb45f0 (1 revision) (flutter/flutter#167428) 2025-04-19 [email protected] Revert "Reduce app startup latency by initializing the engine on a separate thread (#166918)" (flutter/flutter#167427) 2025-04-18 [email protected] Fix keyboard cover SearchAnchor list results (flutter/flutter#165382) 2025-04-18 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Mark `windows_host_engine_test` flaky (#167419)" (flutter/flutter#167425) 2025-04-18 [email protected] Docs: Update date picker theme day color properties doc (flutter/flutter#166122) 2025-04-18 [email protected] Add ktlint test for generated files from templates (flutter/flutter#167378) 2025-04-18 [email protected] Revert "[Windows] Enable merged platform and UI thread by default" (flutter/flutter#167420) 2025-04-18 [email protected] Add a DrivenScrollActivity.simulation constructor (flutter/flutter#166730) 2025-04-18 [email protected] Added missing period for consistency and readability (flutter/flutter#162887) 2025-04-18 [email protected] Roll Skia from 6c4595124690 to 177a2929e32f (1 revision) (flutter/flutter#167417) 2025-04-18 [email protected] Fix codesigning for `Mac_arm64_ios imitation_game_flutter` (flutter/flutter#167307) 2025-04-18 [email protected] Mark `windows_host_engine_test` flaky (flutter/flutter#167419) 2025-04-18 [email protected] Roll Dart SDK from ab60afc99bcb to 0cfefe2a03fb (1 revision) (flutter/flutter#167414) 2025-04-18 [email protected] [web] close input connection when window/iframe loses focus (flutter/flutter#166804) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…r#9118) flutter/flutter@3ed38e2...cfb887c 2025-04-20 [email protected] Roll Fuchsia Linux SDK from 0U_vEALFF7qRJZ_cE... to RGmU4KeQhrxqE7hsr... (flutter/flutter#167447) 2025-04-19 [email protected] Roll Skia from 3dc3ffeb45f0 to bd9ef4955aad (1 revision) (flutter/flutter#167434) 2025-04-19 [email protected] Roll Fuchsia Linux SDK from MwYckh5OvwwmIYLx0... to 0U_vEALFF7qRJZ_cE... (flutter/flutter#167430) 2025-04-19 [email protected] Roll Skia from 177a2929e32f to 3dc3ffeb45f0 (1 revision) (flutter/flutter#167428) 2025-04-19 [email protected] Revert "Reduce app startup latency by initializing the engine on a separate thread (#166918)" (flutter/flutter#167427) 2025-04-18 [email protected] Fix keyboard cover SearchAnchor list results (flutter/flutter#165382) 2025-04-18 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Mark `windows_host_engine_test` flaky (#167419)" (flutter/flutter#167425) 2025-04-18 [email protected] Docs: Update date picker theme day color properties doc (flutter/flutter#166122) 2025-04-18 [email protected] Add ktlint test for generated files from templates (flutter/flutter#167378) 2025-04-18 [email protected] Revert "[Windows] Enable merged platform and UI thread by default" (flutter/flutter#167420) 2025-04-18 [email protected] Add a DrivenScrollActivity.simulation constructor (flutter/flutter#166730) 2025-04-18 [email protected] Added missing period for consistency and readability (flutter/flutter#162887) 2025-04-18 [email protected] Roll Skia from 6c4595124690 to 177a2929e32f (1 revision) (flutter/flutter#167417) 2025-04-18 [email protected] Fix codesigning for `Mac_arm64_ios imitation_game_flutter` (flutter/flutter#167307) 2025-04-18 [email protected] Mark `windows_host_engine_test` flaky (flutter/flutter#167419) 2025-04-18 [email protected] Roll Dart SDK from ab60afc99bcb to 0cfefe2a03fb (1 revision) (flutter/flutter#167414) 2025-04-18 [email protected] [web] close input connection when window/iframe loses focus (flutter/flutter#166804) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…utter/flutter#166122)

Docs: Update date picker theme day color properties doc fixes: flutter#161052 Part 2 of flutter#164972 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. --------- Co-authored-by: Qun Cheng <[email protected]>

…utter/flutter#166122)

rkishan516 requested a review from matanlurey as a code owner March 28, 2025 07:09

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Mar 28, 2025

matanlurey removed their request for review April 2, 2025 15:31

dkwingsmt requested a review from MitchellGoodwin April 2, 2025 18:41

rkishan516 force-pushed the selected-date-picker-theme branch 6 times, most recently from 5a01c9e to e75d24b Compare April 9, 2025 02:38

github-actions bot added d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Apr 9, 2025

flutter-dashboard bot added the will affect goldens Changes to golden files label Apr 9, 2025

MitchellGoodwin reviewed Apr 10, 2025

View reviewed changes

rkishan516 force-pushed the selected-date-picker-theme branch from e75d24b to 00b596c Compare April 11, 2025 01:30

github-actions bot removed d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Apr 11, 2025

rkishan516 changed the title ~~Feat: Add selected day and year theme data~~ Docs: Update date picker theme day color properties doc Apr 11, 2025

MitchellGoodwin reviewed Apr 15, 2025

View reviewed changes

rkishan516 force-pushed the selected-date-picker-theme branch 4 times, most recently from af96c03 to 68bceba Compare April 17, 2025 00:52

MitchellGoodwin approved these changes Apr 17, 2025

View reviewed changes

QuncCccccc approved these changes Apr 17, 2025

View reviewed changes

justinmc approved these changes Apr 17, 2025

View reviewed changes

docs: Update date picker theme day color properties docs

fe97dd6

rkishan516 force-pushed the selected-date-picker-theme branch from 68bceba to fe97dd6 Compare April 18, 2025 00:27

QuncCccccc reviewed Apr 18, 2025

View reviewed changes

packages/flutter/lib/src/material/date_picker_theme.dart Outdated Show resolved Hide resolved

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

f38e5b4

QuncCccccc added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 18, 2025

auto-submit bot added this pull request to the merge queue Apr 18, 2025

Merged via the queue into flutter:master with commit 4a6965c Apr 18, 2025
75 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 18, 2025

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 19, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

dc6de80

…utter/flutter#166122)

engine-flutter-autoroll mentioned this pull request Apr 19, 2025

Roll Flutter from 3ed38e24528a to 93e5d8120143 (15 revisions) flutter/packages#9115

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 19, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

5a64f20

…utter/flutter#166122)

engine-flutter-autoroll mentioned this pull request Apr 19, 2025

Roll Flutter from 3ed38e24528a to 432fea845953 (16 revisions) flutter/packages#9116

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 20, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

73e8d8b

…utter/flutter#166122)

engine-flutter-autoroll mentioned this pull request Apr 20, 2025

Roll Flutter from 3ed38e24528a to cfb887cd5f41 (17 revisions) flutter/packages#9118

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

263f716

…utter/flutter#166122)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

980bbbb

…utter/flutter#166122)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

6b08fe6

…utter/flutter#166122)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

fe95f3a

…utter/flutter#166122)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

4a6965c4e Docs: Update date picker theme day color properties doc (fl…

c0287bf

…utter/flutter#166122)

	/// return Colors.transparent;
	/// return null; // Use the default color.

Docs: Update date picker theme day color properties doc #166122

Docs: Update date picker theme day color properties doc #166122

Uh oh!

Conversation

rkishan516 commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Apr 9, 2025

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

rkishan516 commented Apr 11, 2025

Uh oh!

MitchellGoodwin left a comment

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!

Uh oh!

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

QuncCccccc left a comment

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!

justinmc left a comment

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!

justinmc Apr 18, 2025 • 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!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rkishan516 commented Mar 28, 2025 •

edited

Loading

justinmc Apr 18, 2025 •

edited

Loading