[pickers] Document and deprecate onClose callback on static pickers (…

…#8021)

docs/pages/x/api/date-pickers/static-date-picker.json

@@ -40,6 +40,11 @@
     },
     "onAccept": { "type": { "name": "func" } },
     "onChange": { "type": { "name": "func" } },
+    "onClose": {
+      "type": { "name": "func" },
+      "deprecated": true,
+      "deprecationInfo": "Please avoid using as it will be removed in next major version."
+    },
     "onError": { "type": { "name": "func" } },
     "onMonthChange": { "type": { "name": "func" } },
     "onViewChange": { "type": { "name": "func" } },

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

@@ -46,6 +46,11 @@
     "minDate": { "type": { "name": "any" } },
     "onAccept": { "type": { "name": "func" } },
     "onChange": { "type": { "name": "func" } },
+    "onClose": {
+      "type": { "name": "func" },
+      "deprecated": true,
+      "deprecationInfo": "Please avoid using as it will be removed in next major version."
+    },
     "onError": { "type": { "name": "func" } },
     "onMonthChange": { "type": { "name": "func" } },
     "onRangePositionChange": { "type": { "name": "func" } },

docs/pages/x/api/date-pickers/static-date-time-picker.json

@@ -48,6 +48,11 @@
     },
     "onAccept": { "type": { "name": "func" } },
     "onChange": { "type": { "name": "func" } },
+    "onClose": {
+      "type": { "name": "func" },
+      "deprecated": true,
+      "deprecationInfo": "Please avoid using as it will be removed in next major version."
+    },
     "onError": { "type": { "name": "func" } },
     "onMonthChange": { "type": { "name": "func" } },
     "onViewChange": { "type": { "name": "func" } },

docs/pages/x/api/date-pickers/static-time-picker.json

@@ -31,6 +31,11 @@
     "minutesStep": { "type": { "name": "number" }, "default": "1" },
     "onAccept": { "type": { "name": "func" } },
     "onChange": { "type": { "name": "func" } },
+    "onClose": {
+      "type": { "name": "func" },
+      "deprecated": true,
+      "deprecationInfo": "Please avoid using as it will be removed in next major version."
+    },
     "onError": { "type": { "name": "func" } },
     "onViewChange": { "type": { "name": "func" } },
     "openTo": {

docs/translations/api-docs/date-pickers/static-date-picker.json

@@ -22,6 +22,7 @@
     "monthsPerRow": "Months rendered per row.",
     "onAccept": "Callback fired when the value is accepted.<br><br><strong>Signature:</strong><br><code>function(value: TValue) =&gt; void</code><br><em>value:</em> The value that was just accepted.",
     "onChange": "Callback fired when the value changes.<br><br><strong>Signature:</strong><br><code>function(value: TValue, context: FieldChangeHandlerContext&lt;TError&gt;) =&gt; void</code><br><em>value:</em> The new value.<br><em>context:</em> The context containing the validation result of the current value.",
+    "onClose": "Callback fired when component requests to be closed. Can be fired when selecting (by default on <code>desktop</code> mode) or clearing a value.",
     "onError": "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.<br><br><strong>Signature:</strong><br><code>function(error: TError, value: TValue) =&gt; void</code><br><em>error:</em> The new error describing why the current value is not valid.<br><em>value:</em> The value associated to the error.",
     "onMonthChange": "Callback fired on month change.<br><br><strong>Signature:</strong><br><code>function(month: TDate) =&gt; void</code><br><em>month:</em> The new month.",
     "onViewChange": "Callback fired on view change.<br><br><strong>Signature:</strong><br><code>function(view: TView) =&gt; void</code><br><em>view:</em> The new view.",

docs/translations/api-docs/date-pickers/static-date-range-picker.json

@@ -25,6 +25,7 @@
     "minDate": "Minimal selectable date.",
     "onAccept": "Callback fired when the value is accepted.<br><br><strong>Signature:</strong><br><code>function(value: TValue) =&gt; void</code><br><em>value:</em> The value that was just accepted.",
     "onChange": "Callback fired when the value changes.<br><br><strong>Signature:</strong><br><code>function(value: TValue, context: FieldChangeHandlerContext&lt;TError&gt;) =&gt; void</code><br><em>value:</em> The new value.<br><em>context:</em> The context containing the validation result of the current value.",
+    "onClose": "Callback fired when component requests to be closed. Can be fired when selecting (by default on <code>desktop</code> mode) or clearing a value.",
     "onError": "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.<br><br><strong>Signature:</strong><br><code>function(error: TError, value: TValue) =&gt; void</code><br><em>error:</em> The new error describing why the current value is not valid.<br><em>value:</em> The value associated to the error.",
     "onMonthChange": "Callback fired on month change.<br><br><strong>Signature:</strong><br><code>function(month: TDate) =&gt; void</code><br><em>month:</em> The new month.",
     "onRangePositionChange": "Callback fired when the range position changes.<br><br><strong>Signature:</strong><br><code>function(rangePosition: RangePosition) =&gt; void</code><br><em>rangePosition:</em> The new range position.",

docs/translations/api-docs/date-pickers/static-date-time-picker.json

@@ -30,6 +30,7 @@
     "monthsPerRow": "Months rendered per row.",
     "onAccept": "Callback fired when the value is accepted.<br><br><strong>Signature:</strong><br><code>function(value: TValue) =&gt; void</code><br><em>value:</em> The value that was just accepted.",
     "onChange": "Callback fired when the value changes.<br><br><strong>Signature:</strong><br><code>function(value: TValue, context: FieldChangeHandlerContext&lt;TError&gt;) =&gt; void</code><br><em>value:</em> The new value.<br><em>context:</em> The context containing the validation result of the current value.",
+    "onClose": "Callback fired when component requests to be closed. Can be fired when selecting (by default on <code>desktop</code> mode) or clearing a value.",
     "onError": "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.<br><br><strong>Signature:</strong><br><code>function(error: TError, value: TValue) =&gt; void</code><br><em>error:</em> The new error describing why the current value is not valid.<br><em>value:</em> The value associated to the error.",
     "onMonthChange": "Callback fired on month change.<br><br><strong>Signature:</strong><br><code>function(month: TDate) =&gt; void</code><br><em>month:</em> The new month.",
     "onViewChange": "Callback fired on view change.<br><br><strong>Signature:</strong><br><code>function(view: TView) =&gt; void</code><br><em>view:</em> The new view.",

docs/translations/api-docs/date-pickers/static-time-picker.json

@@ -19,6 +19,7 @@
     "minutesStep": "Step over minutes.",
     "onAccept": "Callback fired when the value is accepted.<br><br><strong>Signature:</strong><br><code>function(value: TValue) =&gt; void</code><br><em>value:</em> The value that was just accepted.",
     "onChange": "Callback fired when the value changes.<br><br><strong>Signature:</strong><br><code>function(value: TValue, context: FieldChangeHandlerContext&lt;TError&gt;) =&gt; void</code><br><em>value:</em> The new value.<br><em>context:</em> The context containing the validation result of the current value.",
+    "onClose": "Callback fired when component requests to be closed. Can be fired when selecting (by default on <code>desktop</code> mode) or clearing a value.",
     "onError": "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.<br><br><strong>Signature:</strong><br><code>function(error: TError, value: TValue) =&gt; void</code><br><em>error:</em> The new error describing why the current value is not valid.<br><em>value:</em> The value associated to the error.",
     "onViewChange": "Callback fired on view change.<br><br><strong>Signature:</strong><br><code>function(view: TView) =&gt; void</code><br><em>view:</em> The new view.",
     "openTo": "The default visible view. Used when the component view is not controlled. Must be a valid option from <code>views</code> list.",

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

@@ -189,6 +189,12 @@ StaticDateRangePicker.propTypes = {
    * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
    */
   onChange: PropTypes.func,
+  /**
+   * Callback fired when component requests to be closed.
+   * Can be fired when selecting (by default on `desktop` mode) or clearing a value.
+   * @deprecated Please avoid using as it will be removed in next major version.
+   */
+  onClose: PropTypes.func,
   /**
    * Callback fired when the error associated to the current value changes.
    * If the error has a non-null value, then the `TextField` will be rendered in `error` state.

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

@@ -172,6 +172,12 @@ StaticDatePicker.propTypes = {
    * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
    */
   onChange: PropTypes.func,
+  /**
+   * Callback fired when component requests to be closed.
+   * Can be fired when selecting (by default on `desktop` mode) or clearing a value.
+   * @deprecated Please avoid using as it will be removed in next major version.
+   */
+  onClose: PropTypes.func,
   /**
    * Callback fired when the error associated to the current value changes.
    * If the error has a non-null value, then the `TextField` will be rendered in `error` state.

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

@@ -219,6 +219,12 @@ StaticDateTimePicker.propTypes = {
    * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
    */
   onChange: PropTypes.func,
+  /**
+   * Callback fired when component requests to be closed.
+   * Can be fired when selecting (by default on `desktop` mode) or clearing a value.
+   * @deprecated Please avoid using as it will be removed in next major version.
+   */
+  onClose: PropTypes.func,
   /**
    * Callback fired when the error associated to the current value changes.
    * If the error has a non-null value, then the `TextField` will be rendered in `error` state.

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

@@ -157,6 +157,12 @@ StaticTimePicker.propTypes = {
    * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
    */
   onChange: PropTypes.func,
+  /**
+   * Callback fired when component requests to be closed.
+   * Can be fired when selecting (by default on `desktop` mode) or clearing a value.
+   * @deprecated Please avoid using as it will be removed in next major version.
+   */
+  onClose: PropTypes.func,
   /**
    * Callback fired when the error associated to the current value changes.
    * If the error has a non-null value, then the `TextField` will be rendered in `error` state.

packages/x-date-pickers/src/internals/hooks/useStaticPicker/useStaticPicker.types.ts

@@ -25,6 +25,12 @@ export interface StaticOnlyPickerProps {
    * If `true`, the view is focused during the first mount.
    */
   autoFocus?: boolean;
+  /**
+   * Callback fired when component requests to be closed.
+   * Can be fired when selecting (by default on `desktop` mode) or clearing a value.
+   * @deprecated Please avoid using as it will be removed in next major version.
+   */
+  onClose?: () => void;
 }
 
 export interface UseStaticPickerProps<