[pickers] Clean the validation internals DX to prepare for publication

mui · Sep 4, 2024 · 96e2c3b · 96e2c3b
1 parent 48b1714
commit 96e2c3b
Show file tree

Hide file tree

Showing 123 changed files with 641 additions and 628 deletions.
diff --git a/docs/pages/x/api/date-pickers/date-field.json b/docs/pages/x/api/date-pickers/date-field.json
@@ -50,8 +50,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/date-picker.json b/docs/pages/x/api/date-pickers/date-picker.json
@@ -60,8 +60,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/date-range-picker.json b/docs/pages/x/api/date-pickers/date-range-picker.json
@@ -70,8 +70,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/date-time-field.json b/docs/pages/x/api/date-pickers/date-time-field.json
@@ -57,8 +57,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/date-time-picker.json b/docs/pages/x/api/date-pickers/date-time-picker.json
@@ -68,8 +68,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/date-time-range-picker.json b/docs/pages/x/api/date-pickers/date-time-range-picker.json
@@ -77,8 +77,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/desktop-date-picker.json b/docs/pages/x/api/date-pickers/desktop-date-picker.json
@@ -56,8 +56,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -66,8 +66,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -64,8 +64,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/desktop-date-time-range-picker.json b/docs/pages/x/api/date-pickers/desktop-date-time-range-picker.json
@@ -73,8 +73,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/desktop-time-picker.json b/docs/pages/x/api/date-pickers/desktop-time-picker.json
@@ -43,8 +43,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onOpen": { "type": { "name": "func" } },

diff --git a/docs/pages/x/api/date-pickers/mobile-date-picker.json b/docs/pages/x/api/date-pickers/mobile-date-picker.json
@@ -56,8 +56,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -62,8 +62,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -64,8 +64,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/mobile-date-time-range-picker.json b/docs/pages/x/api/date-pickers/mobile-date-time-range-picker.json
@@ -69,8 +69,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/mobile-time-picker.json b/docs/pages/x/api/date-pickers/mobile-time-picker.json
@@ -43,8 +43,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onOpen": { "type": { "name": "func" } },

diff --git a/docs/pages/x/api/date-pickers/multi-input-date-range-field.json b/docs/pages/x/api/date-pickers/multi-input-date-range-field.json
@@ -32,8 +32,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/multi-input-date-time-range-field.json b/docs/pages/x/api/date-pickers/multi-input-date-time-range-field.json
@@ -39,8 +39,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/multi-input-time-range-field.json b/docs/pages/x/api/date-pickers/multi-input-time-range-field.json
@@ -35,8 +35,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/single-input-date-range-field.json b/docs/pages/x/api/date-pickers/single-input-date-range-field.json
@@ -51,8 +51,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/single-input-date-time-range-field.json b/docs/pages/x/api/date-pickers/single-input-date-time-range-field.json
@@ -58,8 +58,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/single-input-time-range-field.json b/docs/pages/x/api/date-pickers/single-input-time-range-field.json
@@ -54,8 +54,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/static-date-picker.json b/docs/pages/x/api/date-pickers/static-date-picker.json
@@ -51,8 +51,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -61,8 +61,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

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
@@ -59,8 +59,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onMonthChange": {

diff --git a/docs/pages/x/api/date-pickers/static-time-picker.json b/docs/pages/x/api/date-pickers/static-time-picker.json
@@ -38,8 +38,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onViewChange": {

diff --git a/docs/pages/x/api/date-pickers/time-field.json b/docs/pages/x/api/date-pickers/time-field.json
@@ -53,8 +53,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/pages/x/api/date-pickers/time-picker.json b/docs/pages/x/api/date-pickers/time-picker.json
@@ -47,8 +47,8 @@
     "onError": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(error: TError, value: TValue) => void",
-        "describedArgs": ["error", "value"]
+        "type": "function(reason: TError, value: TValue) => void",
+        "describedArgs": ["reason", "value"]
       }
     },
     "onOpen": { "type": { "name": "func" } },

diff --git a/docs/translations/api-docs/date-pickers/date-field/date-field.json b/docs/translations/api-docs/date-pickers/date-field/date-field.json
@@ -66,10 +66,10 @@
     },
     "onClear": { "description": "Callback fired when the clear button is clicked." },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/translations/api-docs/date-pickers/date-picker/date-picker.json b/docs/translations/api-docs/date-pickers/date-picker/date-picker.json
@@ -77,10 +77,10 @@
       "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
     },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error describing why the current value is not valid.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onMonthChange": {

diff --git a/docs/translations/api-docs/date-pickers/date-range-picker/date-range-picker.json b/docs/translations/api-docs/date-pickers/date-range-picker/date-range-picker.json
@@ -91,10 +91,10 @@
       "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
     },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error describing why the current value is not valid.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onMonthChange": {

diff --git a/docs/translations/api-docs/date-pickers/date-time-field/date-time-field.json b/docs/translations/api-docs/date-pickers/date-time-field/date-time-field.json
@@ -83,10 +83,10 @@
     },
     "onClear": { "description": "Callback fired when the clear button is clicked." },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onSelectedSectionsChange": {

diff --git a/docs/translations/api-docs/date-pickers/date-time-picker/date-time-picker.json b/docs/translations/api-docs/date-pickers/date-time-picker/date-time-picker.json
@@ -97,10 +97,10 @@
       "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
     },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error describing why the current value is not valid.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onMonthChange": {

diff --git a/docs/translations/api-docs/date-pickers/date-time-range-picker/date-time-range-picker.json b/docs/translations/api-docs/date-pickers/date-time-range-picker/date-time-range-picker.json
@@ -108,10 +108,10 @@
       "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
     },
     "onError": {
-      "description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
+      "description": "Callback fired when the error associated to the current value changes. When a validation error is detected, the <code>reason</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
       "typeDescriptions": {
-        "error": "The new error describing why the current value is not valid.",
-        "value": "The value associated to the error."
+        "reason": "The reason why the current value is not valid.",
+        "value": "The invalid value."
       }
     },
     "onMonthChange": {