[pickers] Limit the valid values of `TDate` #11791

flaviendelangle · 2024-01-23T12:22:31Z

The approach seems to work.
It will be breaking for people that don't import the adapter in the same typescript project.
For me it's an edge-case and they would just have to add the following import somewhere like they do for the theme augmentation:

import type {} from '@mui/x-date-pickers/AdapterDayjs';

mui-bot · 2024-01-23T12:26:59Z

Localization writing tips ✍️

Seems you are updating localization 🌍 files.

Thank you for contributing to the localization! 🎉 To make your PR perfect, here is a list of elements to check: ✔️

Verify if the PR title respects the release format. Here are two examples (depending if you update or add a locale file)

[l10n] Improve Swedish (sv-SE) locale
[l10n] Add Danish (da-DK) locale
Update the documentation of supported locales by running yarn l10n
Clean files with yarn prettier.

Deploy preview: https://deploy-preview-11791--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against d9c1ba1

github-actions · 2024-01-24T09:44:36Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

flaviendelangle · 2024-01-24T09:46:26Z

packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx

@@ -278,7 +279,7 @@ DateTimePicker.propTypes = {
   * The date used to generate the new value when both `value` and `defaultValue` are empty.
   * @default The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.
   */
-  referenceDate: PropTypes.any,
+  referenceDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.object]),


OK this is the major drawback of the new approach..
The proptype generation script is smart with Date object does not just mark them as "object", so we end up with a proptype that is wrong for people not using date-fns...

I could add a param in getPropTypesFromFile ignoreDateType or something similar, it's not great but I think it's worth it here

Yes, this case would need some extra attention in order to avoid this particular change. 🙈

Fixed by mui/material-ui#40774

github-actions · 2024-01-24T10:14:51Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

flaviendelangle · 2024-01-24T10:56:03Z

packages/x-date-pickers/src/themeAugmentation/props.d.ts

@@ -55,56 +55,56 @@ import {
 import { PickersSectionListProps } from '../PickersSectionList';

 export interface PickersComponentsPropsList {
-  MuiClock: ClockProps<unknown>;
+  MuiClock: ClockProps<PickerValidDate>;


This is a big benefit
Now those theme entries are correctly typed 🤩

github-actions · 2024-01-24T14:35:47Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

flaviendelangle · 2024-01-24T14:51:03Z

packages/x-date-pickers/src/MobileDateTimePicker/tests/MobileDateTimePicker.test.tsx

-      <MobileDateTimePicker
-        open
-        value={adapterToUse.date('2021-11-20T10:01:22')}
-        defaultValue={(params) => <TextField {...params} />}


alexfauquette · 2024-01-25T11:24:59Z

docs/data/data-grid/custom-columns/EditingWithDatePickers.tsx

@@ -70,7 +70,7 @@ function GridEditDateCell({
  field,
  value,
  colDef,
-}: GridRenderEditCellParams<any, Date | string | null>) {
+}: GridRenderEditCellParams<any, Date | null, string>) {


Is it a fix of something?

Yes, the date in the pickers can no longer be a string since v6 and the formatted value on the other hand is always a string

Letting @mui/xgrid know.
Maybe you need to add a mention of this fact somewhere as well as it could impact the users. 🤔
Clarifying that this is technically not BC, because it is already the case for v6. 🙈 😆

Yes, this looks good to me 👍🏻

github-actions · 2024-01-25T15:43:59Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

github-actions · 2024-01-26T08:19:40Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

LukasTy

Really nice to see such an improvement regarding typing, great work! 🚀 👏
Hopefully it will avoid numerous cases of people being lost with types at first. 🙈

It will be breaking for people that don't import the adapter in the same typescript project.
For me it's an edge-case and they would just have to add the following import somewhere like they do for the theme augmentation:

Maybe we could add this mention in the migration guide? 🤔

LukasTy · 2024-01-26T11:27:42Z

docs/data/data-grid/custom-columns/EditingWithDatePickers.tsx

@@ -70,7 +70,7 @@ function GridEditDateCell({
  field,
  value,
  colDef,
-}: GridRenderEditCellParams<any, Date | string | null>) {
+}: GridRenderEditCellParams<any, Date | null, string>) {


Letting @mui/xgrid know.
Maybe you need to add a mention of this fact somewhere as well as it could impact the users. 🤔
Clarifying that this is technically not BC, because it is already the case for v6. 🙈 😆

docs/pages/x/api/date-pickers/date-range-picker-day.json

packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx

packages/x-date-pickers-pro/src/internals/hooks/models/useRangePicker.ts

...-date-pickers-pro/src/internals/hooks/useMultiInputRangeField/useMultiInputDateRangeField.ts

packages/x-date-pickers/src/DigitalClock/DigitalClock.types.ts

LukasTy · 2024-01-26T12:23:55Z

packages/x-date-pickers/src/MobileDateTimePicker/tests/MobileDateTimePicker.test.tsx

-      <MobileDateTimePicker
-        open
-        value={adapterToUse.date('2021-11-20T10:01:22')}
-        defaultValue={(params) => <TextField {...params} />}


packages/x-date-pickers/src/MultiSectionDigitalClock/MultiSectionDigitalClock.types.ts

packages/x-date-pickers/src/PickersCalendarHeader/PickersCalendarHeader.tsx

packages/x-date-pickers/src/PickersCalendarHeader/PickersCalendarHeader.types.ts

github-actions · 2024-02-01T12:30:56Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Co-authored-by: alexandre <[email protected]>

[pickers] POC: Limit the valid values of TDate

c6082d2

flaviendelangle added typescript component: pickers This is the name of the generic UI component, not the React module! labels Jan 23, 2024

flaviendelangle self-assigned this Jan 23, 2024

Add Luxon

3a4c361

flaviendelangle changed the title ~~[pickers] POC: Limit the valid values of TDate~~ [pickers] POC: Limit the valid values of TDate Jan 23, 2024

flaviendelangle added 2 commits January 24, 2024 10:10

Migrate community package

fb8e3b2

Migrate pro package

f11de73

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 24, 2024

flaviendelangle commented Jan 24, 2024

View reviewed changes

Merge

d95fa87

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 24, 2024

flaviendelangle added 2 commits January 24, 2024 10:57

Fix

afebe44

Fix

6981290

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 24, 2024

Merge

e18a29d

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 24, 2024

flaviendelangle commented Jan 24, 2024

View reviewed changes

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 24, 2024

flaviendelangle mentioned this pull request Jan 24, 2024

[typescript-to-proptypes] Allow to represent dates as PropTypes.object mui/material-ui#40774

Merged

Use object for dates

eda97ab

flaviendelangle force-pushed the poc-ts-tdate branch from 75546c6 to eda97ab Compare January 24, 2024 14:38

Fix

0baf372

flaviendelangle changed the title ~~[pickers] POC: Limit the valid values of TDate~~ [pickers] Limit the valid values of TDate Jan 24, 2024

flaviendelangle requested a review from LukasTy January 24, 2024 14:50

flaviendelangle commented Jan 24, 2024

View reviewed changes

Fix

863d289

alexfauquette reviewed Jan 25, 2024

View reviewed changes

Fix

3812542

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 25, 2024

Merge

5f6f4c2

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 26, 2024

flaviendelangle mentioned this pull request Jan 26, 2024

[core] Update monorepo #11820

Closed

flaviendelangle added 2 commits January 26, 2024 08:42

Fix

4aa1d73

Empty

9c341c5

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 26, 2024

Fix

478c815

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 26, 2024

LukasTy approved these changes Jan 26, 2024

View reviewed changes

flaviendelangle force-pushed the poc-ts-tdate branch 2 times, most recently from 1cbc888 to ca1f66d Compare January 26, 2024 15:16

Code review: Lukas

68e9d73

flaviendelangle force-pushed the poc-ts-tdate branch from ca1f66d to 68e9d73 Compare January 26, 2024 15:18

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 1, 2024

Merge remote-tracking branch 'upstream/next' into poc-ts-tdate

5799ec2

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 2, 2024

Merge branch 'next' into poc-ts-tdate

d9c1ba1

flaviendelangle merged commit 00b6b27 into mui:next Feb 5, 2024
15 checks passed

flaviendelangle deleted the poc-ts-tdate branch February 5, 2024 08:06

LukasTy added breaking change v7.x labels Apr 5, 2024

LukasTy mentioned this pull request Apr 5, 2024

DesktopDatePickerProps<Date> error Type 'Date' does not satisfy the constraint 'never' in version 7.1.0 #12640

Closed

thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024

[pickers] Limit the valid values of TDate (mui#11791)

1420fd9

Co-authored-by: alexandre <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pickers] Limit the valid values of `TDate` #11791

[pickers] Limit the valid values of `TDate` #11791

flaviendelangle commented Jan 23, 2024 •

edited

Loading

mui-bot commented Jan 23, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024

flaviendelangle Jan 24, 2024

flaviendelangle Jan 24, 2024

LukasTy Jan 24, 2024

flaviendelangle Jan 24, 2024

github-actions bot commented Jan 24, 2024

flaviendelangle Jan 24, 2024

github-actions bot commented Jan 24, 2024

flaviendelangle Jan 24, 2024

LukasTy Jan 26, 2024

alexfauquette Jan 25, 2024

flaviendelangle Jan 25, 2024

LukasTy Jan 26, 2024

cherniavskii Jan 29, 2024

github-actions bot commented Jan 25, 2024

github-actions bot commented Jan 26, 2024

LukasTy left a comment

LukasTy Jan 26, 2024

LukasTy Jan 26, 2024

github-actions bot commented Feb 1, 2024

[pickers] Limit the valid values of TDate #11791

[pickers] Limit the valid values of TDate #11791

Conversation

flaviendelangle commented Jan 23, 2024 • edited Loading

mui-bot commented Jan 23, 2024 • edited Loading

Localization writing tips ✍️

github-actions bot commented Jan 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2024

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 25, 2024

github-actions bot commented Jan 26, 2024

LukasTy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 1, 2024

[pickers] Limit the valid values of `TDate` #11791

[pickers] Limit the valid values of `TDate` #11791

flaviendelangle commented Jan 23, 2024 •

edited

Loading

mui-bot commented Jan 23, 2024 •

edited

Loading