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

Co-authored-by: alexandre <[email protected]>
thomasmoon · Sep 6, 2024 · 1420fd9 · 1420fd9
1 parent c9e237c
commit 1420fd9
Show file tree

Hide file tree

Showing 235 changed files with 1,631 additions and 1,280 deletions.
diff --git a/docs/data/data-grid/custom-columns/EditingWithDatePickers.tsx b/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>) {
   const apiRef = useGridApiContext();
 
   const Component = colDef.type === 'dateTime' ? DateTimePicker : DatePicker;

diff --git a/docs/data/date-pickers/custom-field/WrappedSingleInputDateRangePicker.tsx b/docs/data/date-pickers/custom-field/WrappedSingleInputDateRangePicker.tsx
@@ -8,8 +8,9 @@ import {
   SingleInputDateRangeFieldProps,
 } from '@mui/x-date-pickers-pro/SingleInputDateRangeField';
 import { DemoContainer } from '@mui/x-date-pickers/internals/demo';
+import { PickerValidDate } from '@mui/x-date-pickers/models';
 
-type FieldComponent = (<TDate>(
+type FieldComponent = (<TDate extends PickerValidDate>(
   props: SingleInputDateRangeFieldProps<TDate> &
     React.RefAttributes<HTMLInputElement>,
 ) => React.JSX.Element) & { fieldType?: string };

diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.js b/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.js
@@ -12,7 +12,7 @@ export default function LifeCycleDateFieldEmpty() {
   return (
     <Stack spacing={2}>
       <LocalizationProvider dateAdapter={AdapterDayjs}>
-        <DateField value={value} onChange={(newValue) => setValue(newValue)} />
+        <DateField value={value} onChange={setValue} />
       </LocalizationProvider>
       <Typography>Value: {value == null ? 'null' : value.format('L')}</Typography>
     </Stack>

diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.tsx b/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.tsx
@@ -12,7 +12,7 @@ export default function LifeCycleDateFieldEmpty() {
   return (
     <Stack spacing={2}>
       <LocalizationProvider dateAdapter={AdapterDayjs}>
-        <DateField value={value} onChange={(newValue) => setValue(newValue)} />
+        <DateField value={value} onChange={setValue} />
       </LocalizationProvider>
       <Typography>Value: {value == null ? 'null' : value.format('L')}</Typography>
     </Stack>

diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.tsx.preview b/docs/data/date-pickers/lifecycle/LifeCycleDateFieldEmpty.tsx.preview
@@ -1,4 +1,4 @@
 <LocalizationProvider dateAdapter={AdapterDayjs}>
-  <DateField value={value} onChange={(newValue) => setValue(newValue)} />
+  <DateField value={value} onChange={setValue} />
 </LocalizationProvider>
 <Typography>Value: {value == null ? 'null' : value.format('L')}</Typography>
diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.js b/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.js
@@ -14,10 +14,7 @@ export default function LifeCycleDateRangeField() {
     <Stack spacing={2}>
       <LocalizationProvider dateAdapter={AdapterDayjs}>
         <DemoContainer components={['SingleInputDateRangeField']}>
-          <SingleInputDateRangeField
-            value={value}
-            onChange={(newValue) => setValue(newValue)}
-          />
+          <SingleInputDateRangeField value={value} onChange={setValue} />
         </DemoContainer>
       </LocalizationProvider>
       <Typography>

diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.tsx b/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.tsx
@@ -9,7 +9,7 @@ import { SingleInputDateRangeField } from '@mui/x-date-pickers-pro/SingleInputDa
 import { DateRange } from '@mui/x-date-pickers-pro/models';
 
 export default function LifeCycleDateRangeField() {
-  const [value, setValue] = React.useState<DateRange<Dayjs | null>>([
+  const [value, setValue] = React.useState<DateRange<Dayjs>>([
     dayjs('2022-04-17'),
     null,
   ]);
@@ -18,10 +18,7 @@ export default function LifeCycleDateRangeField() {
     <Stack spacing={2}>
       <LocalizationProvider dateAdapter={AdapterDayjs}>
         <DemoContainer components={['SingleInputDateRangeField']}>
-          <SingleInputDateRangeField
-            value={value}
-            onChange={(newValue) => setValue(newValue)}
-          />
+          <SingleInputDateRangeField value={value} onChange={setValue} />
         </DemoContainer>
       </LocalizationProvider>
       <Typography>

diff --git a/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.tsx.preview b/docs/data/date-pickers/lifecycle/LifeCycleDateRangeField.tsx.preview
@@ -1,9 +1,6 @@
 <LocalizationProvider dateAdapter={AdapterDayjs}>
   <DemoContainer components={['SingleInputDateRangeField']}>
-    <SingleInputDateRangeField
-      value={value}
-      onChange={(newValue) => setValue(newValue)}
-    />
+    <SingleInputDateRangeField value={value} onChange={setValue} />
   </DemoContainer>
 </LocalizationProvider>
 <Typography>

diff --git a/docs/pages/x/api/date-pickers/date-calendar.json b/docs/pages/x/api/date-pickers/date-calendar.json
@@ -10,7 +10,7 @@
         "returned": "string"
       }
     },
-    "defaultValue": { "type": { "name": "any" } },
+    "defaultValue": { "type": { "name": "object" } },
     "disabled": { "type": { "name": "bool" }, "default": "false" },
     "disableFuture": { "type": { "name": "bool" }, "default": "false" },
     "disableHighlightToday": { "type": { "name": "bool" }, "default": "false" },
@@ -24,8 +24,8 @@
       }
     },
     "loading": { "type": { "name": "bool" }, "default": "false" },
-    "maxDate": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
     "monthsPerRow": {
       "type": { "name": "enum", "description": "3<br>&#124;&nbsp;4" },
       "default": "3"
@@ -68,7 +68,7 @@
       "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
     },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date using the validation props, except callbacks such as `shouldDisableDate`."
     },
     "renderLoading": {
@@ -126,7 +126,7 @@
         "text": "timezones documentation"
       }
     },
-    "value": { "type": { "name": "any" } },
+    "value": { "type": { "name": "object" } },
     "view": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/x/api/date-pickers/date-field.json b/docs/pages/x/api/date-pickers/date-field.json
@@ -9,7 +9,7 @@
       },
       "default": "'primary'"
     },
-    "defaultValue": { "type": { "name": "any" } },
+    "defaultValue": { "type": { "name": "object" } },
     "disabled": { "type": { "name": "bool" }, "default": "false" },
     "disableFuture": { "type": { "name": "bool" }, "default": "false" },
     "disablePast": { "type": { "name": "bool" }, "default": "false" },
@@ -36,8 +36,8 @@
       },
       "default": "'none'"
     },
-    "maxDate": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
     "name": { "type": { "name": "string" } },
     "onChange": {
       "type": { "name": "func" },
@@ -63,7 +63,7 @@
     },
     "readOnly": { "type": { "name": "bool" }, "default": "false" },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date using the validation props, except callbacks such as `shouldDisableDate`. Value is rounded to the most granular section used."
     },
     "required": { "type": { "name": "bool" }, "default": "false" },
@@ -123,7 +123,7 @@
     "unstableFieldRef": {
       "type": { "name": "union", "description": "func<br>&#124;&nbsp;object" }
     },
-    "value": { "type": { "name": "any" } },
+    "value": { "type": { "name": "object" } },
     "variant": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/x/api/date-pickers/date-picker.json b/docs/pages/x/api/date-pickers/date-picker.json
@@ -14,7 +14,7 @@
         "returned": "string"
       }
     },
-    "defaultValue": { "type": { "name": "any" } },
+    "defaultValue": { "type": { "name": "object" } },
     "desktopModeMediaQuery": {
       "type": { "name": "string" },
       "default": "'@media (pointer: fine)'"
@@ -35,8 +35,8 @@
     "label": { "type": { "name": "node" } },
     "loading": { "type": { "name": "bool" }, "default": "false" },
     "localeText": { "type": { "name": "object" } },
-    "maxDate": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
     "monthsPerRow": {
       "type": { "name": "enum", "description": "3<br>&#124;&nbsp;4" },
       "default": "3"
@@ -96,7 +96,7 @@
       "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
     },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`."
     },
     "renderLoading": {
@@ -160,7 +160,7 @@
         "text": "timezones documentation"
       }
     },
-    "value": { "type": { "name": "any" } },
+    "value": { "type": { "name": "object" } },
     "view": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/x/api/date-pickers/date-range-calendar.json b/docs/pages/x/api/date-pickers/date-range-calendar.json
@@ -26,7 +26,7 @@
       "type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
       "default": "'start'"
     },
-    "defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
+    "defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;object&gt;" } },
     "disableAutoMonthSwitching": { "type": { "name": "bool" }, "default": "false" },
     "disabled": { "type": { "name": "bool" }, "default": "false" },
     "disableDragEditing": { "type": { "name": "bool" }, "default": "false" },
@@ -37,8 +37,8 @@
     "fixedWeekNumber": { "type": { "name": "number" }, "default": "undefined" },
     "focusedView": { "type": { "name": "enum", "description": "'day'" } },
     "loading": { "type": { "name": "bool" }, "default": "false" },
-    "maxDate": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
     "onChange": {
       "type": { "name": "func" },
       "signature": {
@@ -76,7 +76,7 @@
       "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
     },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date using the validation props, except callbacks such as `shouldDisableDate`."
     },
     "renderLoading": {
@@ -118,7 +118,7 @@
         "text": "timezones documentation"
       }
     },
-    "value": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
+    "value": { "type": { "name": "arrayOf", "description": "Array&lt;object&gt;" } },
     "view": { "type": { "name": "enum", "description": "'day'" } },
     "views": { "type": { "name": "arrayOf", "description": "Array&lt;'day'&gt;" } }
   },

diff --git a/docs/pages/x/api/date-pickers/date-range-picker-day.json b/docs/pages/x/api/date-pickers/date-range-picker-day.json
@@ -1,6 +1,6 @@
 {
   "props": {
-    "day": { "type": { "name": "any" }, "required": true },
+    "day": { "type": { "name": "object" }, "required": true },
     "isEndOfHighlighting": { "type": { "name": "bool" }, "required": true },
     "isEndOfPreviewing": { "type": { "name": "bool" }, "required": true },
     "isFirstVisibleCell": { "type": { "name": "bool" }, "required": true },

diff --git a/docs/pages/x/api/date-pickers/date-range-picker.json b/docs/pages/x/api/date-pickers/date-range-picker.json
@@ -26,7 +26,7 @@
       "type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
       "default": "'start'"
     },
-    "defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
+    "defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;object&gt;" } },
     "desktopModeMediaQuery": {
       "type": { "name": "string" },
       "default": "'@media (pointer: fine)'"
@@ -49,8 +49,8 @@
     "label": { "type": { "name": "node" } },
     "loading": { "type": { "name": "bool" }, "default": "false" },
     "localeText": { "type": { "name": "object" } },
-    "maxDate": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
     "name": { "type": { "name": "string" } },
     "onAccept": {
       "type": { "name": "func" },
@@ -97,7 +97,7 @@
       "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
     },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`."
     },
     "renderLoading": {
@@ -145,7 +145,7 @@
         "text": "timezones documentation"
       }
     },
-    "value": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
+    "value": { "type": { "name": "arrayOf", "description": "Array&lt;object&gt;" } },
     "viewRenderers": { "type": { "name": "shape", "description": "{ day?: func }" } }
   },
   "name": "DateRangePicker",

diff --git a/docs/pages/x/api/date-pickers/date-time-field.json b/docs/pages/x/api/date-pickers/date-time-field.json
@@ -10,7 +10,7 @@
       },
       "default": "'primary'"
     },
-    "defaultValue": { "type": { "name": "any" } },
+    "defaultValue": { "type": { "name": "object" } },
     "disabled": { "type": { "name": "bool" }, "default": "false" },
     "disableFuture": { "type": { "name": "bool" }, "default": "false" },
     "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" }, "default": "false" },
@@ -38,12 +38,12 @@
       },
       "default": "'none'"
     },
-    "maxDate": { "type": { "name": "any" } },
-    "maxDateTime": { "type": { "name": "any" } },
-    "maxTime": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
-    "minDateTime": { "type": { "name": "any" } },
-    "minTime": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "maxDateTime": { "type": { "name": "object" } },
+    "maxTime": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
+    "minDateTime": { "type": { "name": "object" } },
+    "minTime": { "type": { "name": "object" } },
     "minutesStep": { "type": { "name": "number" }, "default": "1" },
     "name": { "type": { "name": "string" } },
     "onChange": {
@@ -70,7 +70,7 @@
     },
     "readOnly": { "type": { "name": "bool" }, "default": "false" },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date using the validation props, except callbacks such as `shouldDisableDate`. Value is rounded to the most granular section used."
     },
     "required": { "type": { "name": "bool" }, "default": "false" },
@@ -138,7 +138,7 @@
     "unstableFieldRef": {
       "type": { "name": "union", "description": "func<br>&#124;&nbsp;object" }
     },
-    "value": { "type": { "name": "any" } },
+    "value": { "type": { "name": "object" } },
     "variant": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/x/api/date-pickers/date-time-picker.json b/docs/pages/x/api/date-pickers/date-time-picker.json
@@ -16,7 +16,7 @@
         "returned": "string"
       }
     },
-    "defaultValue": { "type": { "name": "any" } },
+    "defaultValue": { "type": { "name": "object" } },
     "desktopModeMediaQuery": {
       "type": { "name": "string" },
       "default": "'@media (pointer: fine)'"
@@ -38,12 +38,12 @@
     "label": { "type": { "name": "node" } },
     "loading": { "type": { "name": "bool" }, "default": "false" },
     "localeText": { "type": { "name": "object" } },
-    "maxDate": { "type": { "name": "any" } },
-    "maxDateTime": { "type": { "name": "any" } },
-    "maxTime": { "type": { "name": "any" } },
-    "minDate": { "type": { "name": "any" } },
-    "minDateTime": { "type": { "name": "any" } },
-    "minTime": { "type": { "name": "any" } },
+    "maxDate": { "type": { "name": "object" } },
+    "maxDateTime": { "type": { "name": "object" } },
+    "maxTime": { "type": { "name": "object" } },
+    "minDate": { "type": { "name": "object" } },
+    "minDateTime": { "type": { "name": "object" } },
+    "minTime": { "type": { "name": "object" } },
     "minutesStep": { "type": { "name": "number" }, "default": "1" },
     "monthsPerRow": {
       "type": { "name": "enum", "description": "3<br>&#124;&nbsp;4" },
@@ -104,7 +104,7 @@
       "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
     },
     "referenceDate": {
-      "type": { "name": "any" },
+      "type": { "name": "object" },
       "default": "The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`."
     },
     "renderLoading": {
@@ -185,7 +185,7 @@
         "text": "timezones documentation"
       }
     },
-    "value": { "type": { "name": "any" } },
+    "value": { "type": { "name": "object" } },
     "view": {
       "type": {
         "name": "enum",