[pickers] Add referenceDate on picker components

mui · Aug 14, 2023 · 257d094 · 257d094
1 parent b4d7611
commit 257d094
Show file tree

Hide file tree

Showing 66 changed files with 304 additions and 24 deletions.
diff --git a/docs/pages/x/api/date-pickers/date-picker.json b/docs/pages/x/api/date-pickers/date-picker.json
@@ -110,6 +110,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/date-range-calendar.json b/docs/pages/x/api/date-pickers/date-range-calendar.json
@@ -71,6 +71,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => \"...\"",

diff --git a/docs/pages/x/api/date-pickers/date-range-picker.json b/docs/pages/x/api/date-pickers/date-range-picker.json
@@ -111,6 +111,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => \"...\"",

diff --git a/docs/pages/x/api/date-pickers/date-time-picker.json b/docs/pages/x/api/date-pickers/date-time-picker.json
@@ -118,6 +118,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/desktop-date-picker.json b/docs/pages/x/api/date-pickers/desktop-date-picker.json
@@ -106,6 +106,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/desktop-date-range-picker.json b/docs/pages/x/api/date-pickers/desktop-date-range-picker.json
@@ -107,6 +107,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => \"...\"",

diff --git a/docs/pages/x/api/date-pickers/desktop-date-time-picker.json b/docs/pages/x/api/date-pickers/desktop-date-time-picker.json
@@ -114,6 +114,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/desktop-time-picker.json b/docs/pages/x/api/date-pickers/desktop-time-picker.json
@@ -80,6 +80,10 @@
     "orientation": {
       "type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "selectedSections": {
       "type": {
         "name": "union",

diff --git a/docs/pages/x/api/date-pickers/mobile-date-picker.json b/docs/pages/x/api/date-pickers/mobile-date-picker.json
@@ -106,6 +106,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/mobile-date-range-picker.json b/docs/pages/x/api/date-pickers/mobile-date-range-picker.json
@@ -107,6 +107,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => \"...\"",

diff --git a/docs/pages/x/api/date-pickers/mobile-date-time-picker.json b/docs/pages/x/api/date-pickers/mobile-date-time-picker.json
@@ -114,6 +114,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/mobile-time-picker.json b/docs/pages/x/api/date-pickers/mobile-time-picker.json
@@ -80,6 +80,10 @@
     "orientation": {
       "type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "selectedSections": {
       "type": {
         "name": "union",

diff --git a/docs/pages/x/api/date-pickers/static-date-picker.json b/docs/pages/x/api/date-pickers/static-date-picker.json
@@ -91,6 +91,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/static-date-range-picker.json b/docs/pages/x/api/date-pickers/static-date-range-picker.json
@@ -92,6 +92,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => \"...\"",

diff --git a/docs/pages/x/api/date-pickers/static-date-time-picker.json b/docs/pages/x/api/date-pickers/static-date-time-picker.json
@@ -99,6 +99,10 @@
       "type": { "name": "bool" },
       "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)"
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "renderLoading": {
       "type": { "name": "func" },
       "default": "() => <span data-mui-test=\"loading-progress\">...</span>",

diff --git a/docs/pages/x/api/date-pickers/static-time-picker.json b/docs/pages/x/api/date-pickers/static-time-picker.json
@@ -65,6 +65,10 @@
     "orientation": {
       "type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "shouldDisableClock": {
       "type": { "name": "func" },
       "deprecated": true,

diff --git a/docs/pages/x/api/date-pickers/time-picker.json b/docs/pages/x/api/date-pickers/time-picker.json
@@ -84,6 +84,10 @@
     "orientation": {
       "type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
     },
+    "referenceDate": {
+      "type": { "name": "any" },
+      "default": "The closest valid date-time using the validation props, except callbacks such as `shouldDisableDate`."
+    },
     "selectedSections": {
       "type": {
         "name": "union",

diff --git a/docs/translations/api-docs/date-pickers/date-picker.json b/docs/translations/api-docs/date-pickers/date-picker.json
@@ -196,6 +196,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/date-range-calendar.json b/docs/translations/api-docs/date-pickers/date-range-calendar.json
@@ -137,6 +137,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/date-range-picker.json b/docs/translations/api-docs/date-pickers/date-range-picker.json
@@ -210,6 +210,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/date-time-picker.json b/docs/translations/api-docs/date-pickers/date-time-picker.json
@@ -236,6 +236,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/desktop-date-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-picker.json
@@ -191,6 +191,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json
@@ -205,6 +205,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json
@@ -231,6 +231,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/desktop-time-picker.json b/docs/translations/api-docs/date-pickers/desktop-time-picker.json
@@ -158,6 +158,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "selectedSections": {
       "description": "The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a <code>startIndex</code> and <code>endIndex</code> properties are provided, the sections between those two indexes will be selected. 3. If a string of type <code>FieldSectionType</code> is provided, the first section with that name will be selected. 4. If <code>null</code> is provided, no section will be selected If not provided, the selected sections will be handled internally.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/mobile-date-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-picker.json
@@ -191,6 +191,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json
@@ -205,6 +205,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json
@@ -231,6 +231,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/mobile-time-picker.json b/docs/translations/api-docs/date-pickers/mobile-time-picker.json
@@ -158,6 +158,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "selectedSections": {
       "description": "The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a <code>startIndex</code> and <code>endIndex</code> properties are provided, the sections between those two indexes will be selected. 3. If a string of type <code>FieldSectionType</code> is provided, the first section with that name will be selected. 4. If <code>null</code> is provided, no section will be selected If not provided, the selected sections will be handled internally.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/static-date-picker.json b/docs/translations/api-docs/date-pickers/static-date-picker.json
@@ -155,6 +155,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker.json b/docs/translations/api-docs/date-pickers/static-date-range-picker.json
@@ -165,6 +165,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/static-date-time-picker.json b/docs/translations/api-docs/date-pickers/static-date-time-picker.json
@@ -195,6 +195,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "renderLoading": {
       "description": "Component displaying when passed <code>loading</code> true.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/static-time-picker.json b/docs/translations/api-docs/date-pickers/static-time-picker.json
@@ -122,6 +122,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "shouldDisableClock": {
       "description": "Disable specific clock time.",
       "deprecated": "",

diff --git a/docs/translations/api-docs/date-pickers/time-picker.json b/docs/translations/api-docs/date-pickers/time-picker.json
@@ -163,6 +163,11 @@
       "deprecated": "",
       "typeDescriptions": {}
     },
+    "referenceDate": {
+      "description": "The date used to generate the new value when both <code>value</code> and <code>defaultValue</code> are empty.",
+      "deprecated": "",
+      "typeDescriptions": {}
+    },
     "selectedSections": {
       "description": "The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a <code>startIndex</code> and <code>endIndex</code> properties are provided, the sections between those two indexes will be selected. 3. If a string of type <code>FieldSectionType</code> is provided, the first section with that name will be selected. 4. If <code>null</code> is provided, no section will be selected If not provided, the selected sections will be handled internally.",
       "deprecated": "",