feat(cupertino): Add weekType parameter to CupertinoDatePicker for selectable day control #171332 #171334

koukibadr · 2025-06-28T11:19:47Z

Description

This PR enhances the CupertinoDatePicker by introducing a weekType parameter, giving developers more control over which days users can select.

Solution

To address this, I've added a new weekType parameter to the CupertinoDatePicker widget. This parameter offers a declarative way to control the set of selectable days displayed in the picker, with options defined in a new WeekType enum:

WeekType.workDays (Monday-Friday)

WeekType.weekends (Saturday-Sunday)

WeekType.fullWeek (all days, current default behavior)

WeekType.custom (allows developers to provide a List representing the DateTime.weekday values that should be visible and selectable).

Example

// Example: Display only work days (Monday-Friday)
CupertinoDatePicker(
  mode: CupertinoDatePickerMode.date,
  initialDateTime: DateTime.now(),
  minimumDate: DateTime(2023, 1, 1),
  maximumDate: DateTime(2024, 12, 31),
  weekType: WeekType.workDays,
  onDateTimeChanged: (DateTime newDateTime) {
    // Handle date change
  },
);

Screenshots

workdays_display.mov

weekend_display.mov

custom_weekdays.mov

Here's the linked issue to this PR #171332

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.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

alex-medinsh · 2025-06-28T12:41:36Z

Hi @koukibadr! I think the API can be simplified by removing the weekType parameter and enum altogether and allowing the developer to just specify customWeekDays? It will then default to all 7 days and we can then have static presets, something like:

  static const List<int> weekends = [
    DateTime.saturday, 
    DateTime.sunday
  ];

  static const List<int> workDays = [
    DateTime.monday,
    DateTime.tuesday,
    DateTime.wednesday,
    DateTime.thursday,
    DateTime.friday,
  ];

It seems to me that it will help simplify the implementation as well. What do you think?

koukibadr · 2025-06-28T14:35:14Z

Hi @koukibadr! I think the API can be simplified by removing the weekType parameter and enum altogether and allowing the developer to just specify customWeekDays? It will then default to all 7 days and we can then have static presets, something like:
  static const List<int> weekends = [
    DateTime.saturday, 
    DateTime.sunday
  ];

  static const List<int> workDays = [
    DateTime.monday,
    DateTime.tuesday,
    DateTime.wednesday,
    DateTime.thursday,
    DateTime.friday,
  ];
It seems to me that it will help simplify the implementation as well. What do you think?

@alex-medinsh yes it would be more cleaner I agree, but how developers will use presets ? it should be part of the CupertinoDatePIcker class right ?

victorsanni · 2025-06-30T18:13:04Z

Hi @koukibadr! I think the API can be simplified by removing the weekType parameter and enum altogether and allowing the developer to just specify customWeekDays? It will then default to all 7 days and we can then have static presets, something like:

Talking with @MitchellGoodwin offline we think an even more general API can solve this problem and provide more control to developers. For example, a bool callback with a DateTime date arg that returns true if the date should be enabled or not. @alex-medinsh @koukibadr what do you think?

alex-medinsh · 2025-06-30T18:26:39Z

it should be part of the CupertinoDatePIcker class right ?

@koukibadr Initially I was thinking yes, but I am not sure how clean that is.

For example, a bool callback with a DateTime date arg that returns true if the date should be enabled or not.

@victorsanni Does the callback get the currently selected value as the argument? I think this can a bit strange in terms of the UX, since user can select any date and only then will it evaluate if it is selectable. Or did I misunderstand what you were suggesting?

~~What I think this PR is trying to accomplish is something akin to minimumDate and maximumDate, but with weekdays, where the user doesn't even see the disabled options.~~

Nevermind. The callback seems like a nice solution. :)

MitchellGoodwin · 2025-06-30T18:27:01Z

The Material date picker has a similar way of validating dates through selectableDayPredicate. A callback is a bit more flexible compared to a list when the list has to be made dynamic anyway through things like valid dates depend on outside logic or localization.

how developers will use presets ? it should be part of the CupertinoDatePIcker class right ?
Theoretically an enum of default callbacks could be provided, but I worry that it would be difficult to iterate on this enum. There's also localizations concerns. For instance "workDays" isn't valid for a lot of people, if the targets of the app work weekends, or it's in a culture that has a different work week, it loses relevance quickly.

koukibadr · 2025-06-30T21:27:01Z

The Material date picker has a similar way of validating dates through selectableDayPredicate. A callback is a bit more flexible compared to a list when the list has to be made dynamic anyway through things like valid dates depend on outside logic or localization.

how developers will use presets ? it should be part of the CupertinoDatePIcker class right ?
Theoretically an enum of default callbacks could be provided, but I worry that it would be difficult to iterate on this enum. There's also localizations concerns. For instance "workDays" isn't valid for a lot of people, if the targets of the app work weekends, or it's in a culture that has a different work week, it loses relevance quickly.

@victorsanni @alex-medinsh @MitchellGoodwin Okay it make sense especially following the same logic as material design date picker, I'll update the implementation then
thanks for these clarifications

victorsanni · 2025-07-07T20:31:28Z

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

@@ -53,6 +53,9 @@ const double _kTimerPickerLabelFontSize = 17.0;
 // The width of each column of the countdown time picker.
 const double _kTimerPickerColumnIntrinsicWidth = 106;

+/// Signature for predicating dates for enabled date selections.
+typedef SelectableDayPredicate = bool Function(DateTime date);


This typedef is already defined in material/date.dart. Can we move some logic in that file to widgets/ and share it here?

I thought that date.dart is related to specific Material DatePickers but yes we can refactor to have only one SelectableDayPredicate makes more sense

@koukibadr Do you plan to make this refactor? Just want to make sure we're on the same page. (from triage)

Hello @dkwingsmt yes I'm back working on this just need to verify other Material DateTime features to not break anything with this refactor

Awesome. Take your time!

victorsanni

Hi @koukibadr. Can you resolve the merge conflicts, rebase, and change the title of the PR to match the latest changes?

koukibadr · 2025-08-02T16:56:18Z

@victorsanni
Okay I'll update my branch then

fluttergithubbot · 2025-08-09T08:24:36Z

An existing Git SHA, 1590543f6794addbb7dff8c6d655a7546eb955aa, was detected, and no actions were taken.

To re-trigger presubmits after closing or re-opeing a PR, or pushing a HEAD commit (i.e. with --force) that already was pushed before, push a blank commit (git commit --allow-empty -m "Trigger Build") or rebase to continue.

…y control

fluttergithubbot · 2025-08-09T08:45:54Z

An existing Git SHA, 301e896dbd6dd4ddeb68f7da99cde5ccb830906f, was detected, and no actions were taken.

To re-trigger presubmits after closing or re-opeing a PR, or pushing a HEAD commit (i.e. with --force) that already was pushed before, push a blank commit (git commit --allow-empty -m "Trigger Build") or rebase to continue.

koukibadr · 2025-08-09T08:46:18Z

@victorsanni I've resolved the conflict and rebased latest master branch

victorsanni · 2025-08-11T19:34:17Z

Hi @koukibadr, can you run dart format packages/flutter/lib/src/cupertino/date_picker.dart to fix the failing Linux analyze test? The other failing test is a bot timeout which should be corrected once you push the formatting changes.

…y control

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

packages/flutter/lib/src/widgets/actions.dart

… in Cupertino DatePicker

packages/flutter/lib/src/widgets/date.dart

victorsanni · 2025-08-18T21:31:50Z

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

+       ),
+       assert(
+         selectableDayPredicate == null ||
+             selectableDayPredicate(initialDateTime ?? DateTime.now()),


Not sure DateTime.now() should be used here. What about

selectableDayPredicate == null || initialDate == null || selectableDayPredicate!(this.initialDate!)

like in DatePicker?

victorsanni · 2025-08-18T21:34:38Z

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

+          final bool isValidDate;
+          if (widget.selectableDayPredicate == null) {
+            isValidDate = true;
+          } else {
+            isValidDate = widget.selectableDayPredicate!.call(rangeStart);
+          }


Replace with a method:

bool _isSelectable(DateTime date) { return widget.selectableDayPredicate?.call(date) ?? true; }

and call it with rangeStart:

victorsanni · 2025-08-18T21:35:28Z

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

-          return itemPositioningBuilder(context, Text(dateText, style: _themeTextStyle(context)));
+          return itemPositioningBuilder(
+            context,
+            Text(dateText, style: _themeTextStyle(context, isValid: isValidDate)),


Suggested change

Text(dateText, style: _themeTextStyle(context, isValid: isValidDate)),

Text(dateText, style: _themeTextStyle(context, isValid: _isSelectable(rangeStart)),

victorsanni · 2025-08-18T21:36:38Z

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

+    final DateTime selectedDate = selectedDateTime;
+    final bool minCheck = widget.minimumDate?.isAfter(selectedDate) ?? false;
+
+    if (widget.selectableDayPredicate?.call(selectedDate) == false) {


_isSelectable can be used here as well. If needed, the function can be defined outside of any classes and pass in widget.selectableDayPredicate.

…DatePicker

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: cupertino flutter/packages/flutter/cupertino repository labels Jun 28, 2025

koukibadr mentioned this pull request Jun 29, 2025

Adding week type to the CupertinoDatePicker #171332

Open

dkwingsmt requested a review from MitchellGoodwin July 2, 2025 18:11

koukibadr force-pushed the master branch from a939b95 to 43abfda Compare July 7, 2025 20:21

victorsanni reviewed Jul 7, 2025

View reviewed changes

koukibadr force-pushed the master branch from 43abfda to b2cafbc Compare July 25, 2025 11:31

github-actions bot added the f: material design flutter/packages/flutter/material repository. label Jul 25, 2025

koukibadr requested review from dkwingsmt and victorsanni July 25, 2025 11:31

victorsanni reviewed Aug 2, 2025

View reviewed changes

koukibadr closed this Aug 9, 2025

koukibadr force-pushed the master branch from b2cafbc to 1590543 Compare August 9, 2025 08:24

feat: Add weekType parameter to CupertinoDatePicker for selectable da…

301e896

…y control

koukibadr reopened this Aug 9, 2025

koukibadr requested a review from victorsanni August 9, 2025 08:46

feat: Add weekType parameter to CupertinoDatePicker for selectable da…

a9e45b0

…y control

victorsanni reviewed Aug 14, 2025

View reviewed changes

packages/flutter/lib/src/cupertino/date_picker.dart Outdated Show resolved Hide resolved

packages/flutter/lib/src/widgets/actions.dart Outdated Show resolved Hide resolved

feat flutter#171332: implement selectableDatePredicate date selection…

f7895cc

… in Cupertino DatePicker

koukibadr requested a review from victorsanni August 17, 2025 14:48

victorsanni reviewed Aug 18, 2025

View reviewed changes

packages/flutter/lib/src/widgets/date.dart Show resolved Hide resolved

koukibadr requested a review from victorsanni August 18, 2025 21:25

victorsanni reviewed Aug 18, 2025

View reviewed changes

koukibadr force-pushed the master branch from b34183a to d1e1506 Compare August 23, 2025 08:43

chore: implement selectableDatePredicate date selection in Cupertino …

eb7388d

…DatePicker

koukibadr force-pushed the master branch from d1e1506 to eb7388d Compare August 23, 2025 08:44

koukibadr requested a review from victorsanni August 23, 2025 08:44

	Text(dateText, style: _themeTextStyle(context, isValid: isValidDate)),
	Text(dateText, style: _themeTextStyle(context, isValid: _isSelectable(rangeStart)),

feat(cupertino): Add weekType parameter to CupertinoDatePicker for selectable day control #171332 #171334

Are you sure you want to change the base?

feat(cupertino): Add weekType parameter to CupertinoDatePicker for selectable day control #171332 #171334

Conversation

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

Uh oh!

Description

Solution

Example

Screenshots

Pre-launch Checklist

Uh oh!

alex-medinsh commented Jun 28, 2025

Uh oh!

koukibadr commented Jun 28, 2025

Uh oh!

victorsanni commented Jun 30, 2025

Uh oh!

alex-medinsh commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchellGoodwin commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koukibadr commented Jun 30, 2025

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!

victorsanni left a comment

Choose a reason for hiding this comment

Uh oh!

koukibadr commented Aug 2, 2025

Uh oh!

fluttergithubbot commented Aug 9, 2025

Uh oh!

fluttergithubbot commented Aug 9, 2025

Uh oh!

koukibadr commented Aug 9, 2025

Uh oh!

victorsanni commented Aug 11, 2025

Uh oh!

Uh oh!

Uh oh!

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!

koukibadr commented Jun 28, 2025 •

edited

Loading

alex-medinsh commented Jun 30, 2025 •

edited

Loading

MitchellGoodwin commented Jun 30, 2025 •

edited

Loading