Full proptypes + docs:api run

mui · Feb 26, 2021 · 479c53a · 479c53a
1 parent d0503be
commit 479c53a
Show file tree

Hide file tree

Showing 25 changed files with 25 additions and 88 deletions.
diff --git a/docs/pages/api-docs/date-range-picker.json b/docs/pages/api-docs/date-range-picker.json
@@ -33,11 +33,9 @@
     "disableAutoMonthSwitching": { "type": { "name": "bool" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "endText": { "type": { "name": "node" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/date-time-picker.json b/docs/pages/api-docs/date-time-picker.json
@@ -25,12 +25,10 @@
     "DialogProps": { "type": { "name": "object" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "getClockLabelText": { "type": { "name": "func" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/desktop-date-range-picker.json b/docs/pages/api-docs/desktop-date-range-picker.json
@@ -28,11 +28,9 @@
     "disableAutoMonthSwitching": { "type": { "name": "bool" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "endText": { "type": { "name": "node" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/desktop-date-time-picker.json b/docs/pages/api-docs/desktop-date-time-picker.json
@@ -20,12 +20,10 @@
     "defaultCalendarMonth": { "type": { "name": "any" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "getClockLabelText": { "type": { "name": "func" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/mobile-date-range-picker.json b/docs/pages/api-docs/mobile-date-range-picker.json
@@ -32,11 +32,9 @@
     "disableAutoMonthSwitching": { "type": { "name": "bool" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "endText": { "type": { "name": "node" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/mobile-date-time-picker.json b/docs/pages/api-docs/mobile-date-time-picker.json
@@ -24,12 +24,10 @@
     "DialogProps": { "type": { "name": "object" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "getClockLabelText": { "type": { "name": "func" } },
     "getOpenDialogAriaText": { "type": { "name": "func" } },
     "getViewSwitchingButtonText": { "type": { "name": "func" } },

diff --git a/docs/pages/api-docs/static-date-range-picker.json b/docs/pages/api-docs/static-date-range-picker.json
@@ -28,11 +28,9 @@
     "disableAutoMonthSwitching": { "type": { "name": "bool" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "displayStaticWrapperAs": {
       "type": { "name": "enum", "description": "'desktop'<br>&#124;&nbsp;'mobile'" }
     },

diff --git a/docs/pages/api-docs/static-date-time-picker.json b/docs/pages/api-docs/static-date-time-picker.json
@@ -20,12 +20,10 @@
     "defaultCalendarMonth": { "type": { "name": "any" } },
     "disableCloseOnSelect": { "type": { "name": "bool" } },
     "disabled": { "type": { "name": "bool" } },
-    "disableFuture": { "type": { "name": "bool" } },
     "disableHighlightToday": { "type": { "name": "bool" } },
     "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
     "disableMaskedInput": { "type": { "name": "bool" } },
     "disableOpenPicker": { "type": { "name": "bool" } },
-    "disablePast": { "type": { "name": "bool" } },
     "displayStaticWrapperAs": {
       "type": { "name": "enum", "description": "'desktop'<br>&#124;&nbsp;'mobile'" }
     },

diff --git a/docs/translations/api-docs/date-range-picker/date-range-picker.json b/docs/translations/api-docs/date-range-picker/date-range-picker.json
@@ -2,7 +2,7 @@
   "componentDescription": "",
   "propDescriptions": {
     "acceptRegex": "Regular expression to detect &quot;accepted&quot; symbols.",
-    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar.",
+    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar. Defaults to <code>true</code> unless the <code>ClockPicker</code> is used inside a <code>Static*</code> picker component.",
     "allowSameDateSelection": "If <code>true</code>, <code>onChange</code> is fired on click even if the same date is selected.",
     "calendars": "The number of calendars that render on <strong>desktop</strong>.",
     "cancelText": "Cancel text message.",
@@ -18,11 +18,9 @@
     "disableAutoMonthSwitching": "If <code>true</code>, after selecting <code>start</code> date calendar will not automatically switch to the month of <code>end</code> date.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "endText": "Text for end input label and toolbar placeholder.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/date-time-picker/date-time-picker.json b/docs/translations/api-docs/date-time-picker/date-time-picker.json
@@ -19,12 +19,10 @@
     "DialogProps": "Props applied to the <a href=\"/api/dialog/\"><code>Dialog</code></a> element.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "getClockLabelText": "Accessible text that helps user to understand which time and view is selected.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/desktop-date-range-picker/desktop-date-range-picker.json b/docs/translations/api-docs/desktop-date-range-picker/desktop-date-range-picker.json
@@ -2,7 +2,7 @@
   "componentDescription": "",
   "propDescriptions": {
     "acceptRegex": "Regular expression to detect &quot;accepted&quot; symbols.",
-    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar.",
+    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar. Defaults to <code>true</code> unless the <code>ClockPicker</code> is used inside a <code>Static*</code> picker component.",
     "allowSameDateSelection": "If <code>true</code>, <code>onChange</code> is fired on click even if the same date is selected.",
     "calendars": "The number of calendars that render on <strong>desktop</strong>.",
     "className": "className applied to the root component.",
@@ -13,11 +13,9 @@
     "disableAutoMonthSwitching": "If <code>true</code>, after selecting <code>start</code> date calendar will not automatically switch to the month of <code>end</code> date.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "endText": "Text for end input label and toolbar placeholder.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/desktop-date-time-picker/desktop-date-time-picker.json b/docs/translations/api-docs/desktop-date-time-picker/desktop-date-time-picker.json
@@ -14,12 +14,10 @@
     "defaultCalendarMonth": "Default calendar month displayed when <code>value={null}</code>.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "getClockLabelText": "Accessible text that helps user to understand which time and view is selected.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/mobile-date-range-picker/mobile-date-range-picker.json b/docs/translations/api-docs/mobile-date-range-picker/mobile-date-range-picker.json
@@ -2,7 +2,7 @@
   "componentDescription": "",
   "propDescriptions": {
     "acceptRegex": "Regular expression to detect &quot;accepted&quot; symbols.",
-    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar.",
+    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar. Defaults to <code>true</code> unless the <code>ClockPicker</code> is used inside a <code>Static*</code> picker component.",
     "allowSameDateSelection": "If <code>true</code>, <code>onChange</code> is fired on click even if the same date is selected.",
     "calendars": "The number of calendars that render on <strong>desktop</strong>.",
     "cancelText": "Cancel text message.",
@@ -17,11 +17,9 @@
     "disableAutoMonthSwitching": "If <code>true</code>, after selecting <code>start</code> date calendar will not automatically switch to the month of <code>end</code> date.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "endText": "Text for end input label and toolbar placeholder.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/mobile-date-time-picker/mobile-date-time-picker.json b/docs/translations/api-docs/mobile-date-time-picker/mobile-date-time-picker.json
@@ -18,12 +18,10 @@
     "DialogProps": "Props applied to the <a href=\"/api/dialog/\"><code>Dialog</code></a> element.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "getClockLabelText": "Accessible text that helps user to understand which time and view is selected.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",
     "getViewSwitchingButtonText": "Get aria-label text for switching between views button.",

diff --git a/docs/translations/api-docs/static-date-range-picker/static-date-range-picker.json b/docs/translations/api-docs/static-date-range-picker/static-date-range-picker.json
@@ -2,7 +2,7 @@
   "componentDescription": "",
   "propDescriptions": {
     "acceptRegex": "Regular expression to detect &quot;accepted&quot; symbols.",
-    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar.",
+    "allowKeyboardControl": "Enables keyboard listener for moving between days in calendar. Defaults to <code>true</code> unless the <code>ClockPicker</code> is used inside a <code>Static*</code> picker component.",
     "allowSameDateSelection": "If <code>true</code>, <code>onChange</code> is fired on click even if the same date is selected.",
     "calendars": "The number of calendars that render on <strong>desktop</strong>.",
     "className": "className applied to the root component.",
@@ -13,11 +13,9 @@
     "disableAutoMonthSwitching": "If <code>true</code>, after selecting <code>start</code> date calendar will not automatically switch to the month of <code>end</code> date.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "displayStaticWrapperAs": "Force static wrapper inner components to be rendered in mobile or desktop mode.",
     "endText": "Text for end input label and toolbar placeholder.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",

diff --git a/docs/translations/api-docs/static-date-time-picker/static-date-time-picker.json b/docs/translations/api-docs/static-date-time-picker/static-date-time-picker.json
@@ -14,12 +14,10 @@
     "defaultCalendarMonth": "Default calendar month displayed when <code>value={null}</code>.",
     "disableCloseOnSelect": "If <code>true</code> the popup or dialog will immediately close after submitting full date.",
     "disabled": "If <code>true</code>, the picker and text field are disabled.",
-    "disableFuture": "Disable future dates.",
     "disableHighlightToday": "If <code>true</code>, todays date is rendering without highlighting with circle.",
     "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.",
     "disableMaskedInput": "Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.",
     "disableOpenPicker": "Do not render open picker button (renders only text field with validation).",
-    "disablePast": "Disable past dates.",
     "displayStaticWrapperAs": "Force static wrapper inner components to be rendered in mobile or desktop mode.",
     "getClockLabelText": "Accessible text that helps user to understand which time and view is selected.",
     "getOpenDialogAriaText": "Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType",

diff --git a/packages/material-ui-lab/src/DateRangePicker/DateRangePicker.tsx b/packages/material-ui-lab/src/DateRangePicker/DateRangePicker.tsx
@@ -31,7 +31,7 @@ DateRangePicker.propTypes = {
   acceptRegex: PropTypes.instanceOf(RegExp),
   /**
    * Enables keyboard listener for moving between days in calendar.
-   * @default currentWrapper !== 'static'
+   * Defaults to `true` unless the `ClockPicker` is used inside a `Static*` picker component.
    */
   allowKeyboardControl: PropTypes.bool,
   /**
@@ -94,7 +94,6 @@ DateRangePicker.propTypes = {
   dateAdapter: PropTypes.object,
   /**
    * Default calendar month displayed when `value={null}`.
-   * @default `new Date()`
    */
   defaultCalendarMonth: PropTypes.any,
   /**
@@ -122,7 +121,6 @@ DateRangePicker.propTypes = {
    */
   disabled: PropTypes.bool,
   /**
-   * Disable future dates.
    * @default false
    */
   disableFuture: PropTypes.bool,
@@ -142,7 +140,6 @@ DateRangePicker.propTypes = {
    */
   disableOpenPicker: PropTypes.bool,
   /**
-   * Disable past dates.
    * @default false
    */
   disablePast: PropTypes.bool,
@@ -200,12 +197,10 @@ DateRangePicker.propTypes = {
   mask: PropTypes.string,
   /**
    * Max selectable date. @DateIOType
-   * @default Date(2099-31-12)
    */
   maxDate: PropTypes.any,
   /**
    * Min selectable date. @DateIOType
-   * @default Date(1900-01-01)
    */
   minDate: PropTypes.any,
   /**
@@ -274,7 +269,7 @@ DateRangePicker.propTypes = {
   readOnly: PropTypes.bool,
   /**
    * Disable heavy animations.
-   * @default /(android)/i.test(window.navigator.userAgent).
+   * @default typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
    */
   reduceAnimations: PropTypes.bool,
   /**
@@ -303,7 +298,7 @@ DateRangePicker.propTypes = {
   renderInput: PropTypes.func.isRequired,
   /**
    * Component displaying when passed `loading` true.
-   * @default () => "..."
+   * @default () => <span data-mui-test="loading-progress">...</span>
    */
   renderLoading: PropTypes.func,
   /**