[core] Boolean props always have a default value of false in API do…

…cs (#35913)
mui · Jan 27, 2023 · a41260a · a41260a
1 parent 7409711
commit a41260a
Show file tree

Hide file tree

Showing 106 changed files with 291 additions and 273 deletions.
diff --git a/docs/pages/base/api/badge-unstyled.json b/docs/pages/base/api/badge-unstyled.json
@@ -3,9 +3,9 @@
     "badgeContent": { "type": { "name": "node" } },
     "children": { "type": { "name": "node" } },
     "component": { "type": { "name": "elementType" } },
-    "invisible": { "type": { "name": "bool" } },
+    "invisible": { "type": { "name": "bool" }, "default": "false" },
     "max": { "type": { "name": "number" }, "default": "99" },
-    "showZero": { "type": { "name": "bool" } },
+    "showZero": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": {
         "name": "shape",

diff --git a/docs/pages/base/api/button-unstyled.json b/docs/pages/base/api/button-unstyled.json
@@ -7,8 +7,8 @@
       }
     },
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
-    "focusableWhenDisabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
+    "focusableWhenDisabled": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
       "default": "{}"

diff --git a/docs/pages/base/api/click-away-listener.json b/docs/pages/base/api/click-away-listener.json
@@ -2,7 +2,7 @@
   "props": {
     "children": { "type": { "name": "custom", "description": "element" }, "required": true },
     "onClickAway": { "type": { "name": "func" }, "required": true },
-    "disableReactTree": { "type": { "name": "bool" } },
+    "disableReactTree": { "type": { "name": "bool" }, "default": "false" },
     "mouseEvent": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/base/api/focus-trap.json b/docs/pages/base/api/focus-trap.json
@@ -2,9 +2,9 @@
   "props": {
     "open": { "type": { "name": "bool" }, "required": true },
     "children": { "type": { "name": "custom", "description": "element" } },
-    "disableAutoFocus": { "type": { "name": "bool" } },
-    "disableEnforceFocus": { "type": { "name": "bool" } },
-    "disableRestoreFocus": { "type": { "name": "bool" } },
+    "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" },
+    "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" },
+    "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" },
     "getTabbable": { "type": { "name": "func" } },
     "isEnabled": {
       "type": { "name": "func" },

diff --git a/docs/pages/base/api/form-control-unstyled.json b/docs/pages/base/api/form-control-unstyled.json
@@ -2,9 +2,9 @@
   "props": {
     "children": { "type": { "name": "union", "description": "node<br>&#124;&nbsp;func" } },
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
-    "error": { "type": { "name": "bool" } },
-    "required": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
+    "error": { "type": { "name": "bool" }, "default": "false" },
+    "required": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
       "default": "{}"

diff --git a/docs/pages/base/api/input-unstyled.json b/docs/pages/base/api/input-unstyled.json
@@ -11,7 +11,7 @@
     "id": { "type": { "name": "string" } },
     "maxRows": { "type": { "name": "number" } },
     "minRows": { "type": { "name": "number" } },
-    "multiline": { "type": { "name": "bool" } },
+    "multiline": { "type": { "name": "bool" }, "default": "false" },
     "name": { "type": { "name": "string" } },
     "placeholder": { "type": { "name": "string" } },
     "readOnly": { "type": { "name": "bool" } },

diff --git a/docs/pages/base/api/menu-item-unstyled.json b/docs/pages/base/api/menu-item-unstyled.json
@@ -1,7 +1,7 @@
 {
   "props": {
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "label": { "type": { "name": "string" } },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },

diff --git a/docs/pages/base/api/menu-unstyled.json b/docs/pages/base/api/menu-unstyled.json
@@ -8,9 +8,9 @@
       }
     },
     "component": { "type": { "name": "elementType" } },
-    "keepMounted": { "type": { "name": "bool" } },
+    "keepMounted": { "type": { "name": "bool" }, "default": "false" },
     "onClose": { "type": { "name": "func" } },
-    "open": { "type": { "name": "bool" } },
+    "open": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": {
         "name": "shape",

diff --git a/docs/pages/base/api/modal-unstyled.json b/docs/pages/base/api/modal-unstyled.json
@@ -3,17 +3,17 @@
     "children": { "type": { "name": "custom", "description": "element" }, "required": true },
     "open": { "type": { "name": "bool" }, "required": true },
     "classes": { "type": { "name": "object" } },
-    "closeAfterTransition": { "type": { "name": "bool" } },
+    "closeAfterTransition": { "type": { "name": "bool" }, "default": "false" },
     "component": { "type": { "name": "elementType" } },
     "container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
-    "disableAutoFocus": { "type": { "name": "bool" } },
-    "disableEnforceFocus": { "type": { "name": "bool" } },
-    "disableEscapeKeyDown": { "type": { "name": "bool" } },
-    "disablePortal": { "type": { "name": "bool" } },
-    "disableRestoreFocus": { "type": { "name": "bool" } },
-    "disableScrollLock": { "type": { "name": "bool" } },
-    "hideBackdrop": { "type": { "name": "bool" } },
-    "keepMounted": { "type": { "name": "bool" } },
+    "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" },
+    "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" },
+    "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" },
+    "disablePortal": { "type": { "name": "bool" }, "default": "false" },
+    "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" },
+    "disableScrollLock": { "type": { "name": "bool" }, "default": "false" },
+    "hideBackdrop": { "type": { "name": "bool" }, "default": "false" },
+    "keepMounted": { "type": { "name": "bool" }, "default": "false" },
     "onBackdropClick": {
       "type": { "name": "func" },
       "deprecated": true,

diff --git a/docs/pages/base/api/multi-select-unstyled.json b/docs/pages/base/api/multi-select-unstyled.json
@@ -1,10 +1,10 @@
 {
   "props": {
-    "autoFocus": { "type": { "name": "bool" } },
+    "autoFocus": { "type": { "name": "bool" }, "default": "false" },
     "component": { "type": { "name": "elementType" } },
-    "defaultListboxOpen": { "type": { "name": "bool" } },
+    "defaultListboxOpen": { "type": { "name": "bool" }, "default": "false" },
     "defaultValue": { "type": { "name": "array" }, "default": "[]" },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "getSerializedValue": { "type": { "name": "func" } },
     "listboxId": { "type": { "name": "string" } },
     "listboxOpen": { "type": { "name": "bool" }, "default": "undefined" },

diff --git a/docs/pages/base/api/no-ssr.json b/docs/pages/base/api/no-ssr.json
@@ -1,7 +1,7 @@
 {
   "props": {
     "children": { "type": { "name": "node" } },
-    "defer": { "type": { "name": "bool" } },
+    "defer": { "type": { "name": "bool" }, "default": "false" },
     "fallback": { "type": { "name": "node" }, "default": "null" }
   },
   "name": "NoSsr",

diff --git a/docs/pages/base/api/option-group-unstyled.json b/docs/pages/base/api/option-group-unstyled.json
@@ -1,7 +1,7 @@
 {
   "props": {
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "label": { "type": { "name": "node" } },
     "slotProps": {
       "type": {

diff --git a/docs/pages/base/api/option-unstyled.json b/docs/pages/base/api/option-unstyled.json
@@ -2,7 +2,7 @@
   "props": {
     "value": { "type": { "name": "any" }, "required": true },
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "label": { "type": { "name": "string" } },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },

diff --git a/docs/pages/base/api/popper-unstyled.json b/docs/pages/base/api/popper-unstyled.json
@@ -13,8 +13,8 @@
       "type": { "name": "enum", "description": "'ltr'<br>&#124;&nbsp;'rtl'" },
       "default": "'ltr'"
     },
-    "disablePortal": { "type": { "name": "bool" } },
-    "keepMounted": { "type": { "name": "bool" } },
+    "disablePortal": { "type": { "name": "bool" }, "default": "false" },
+    "keepMounted": { "type": { "name": "bool" }, "default": "false" },
     "modifiers": {
       "type": {
         "name": "arrayOf",
@@ -44,7 +44,7 @@
       "type": { "name": "shape", "description": "{ root?: elementType }" },
       "default": "{}"
     },
-    "transition": { "type": { "name": "bool" } }
+    "transition": { "type": { "name": "bool" }, "default": "false" }
   },
   "name": "PopperUnstyled",
   "styles": { "classes": [], "globalClasses": {}, "name": null },

diff --git a/docs/pages/base/api/portal.json b/docs/pages/base/api/portal.json
@@ -2,7 +2,7 @@
   "props": {
     "children": { "type": { "name": "node" } },
     "container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
-    "disablePortal": { "type": { "name": "bool" } }
+    "disablePortal": { "type": { "name": "bool" }, "default": "false" }
   },
   "name": "Portal",
   "styles": { "classes": [], "globalClasses": {}, "name": null },

diff --git a/docs/pages/base/api/select-unstyled.json b/docs/pages/base/api/select-unstyled.json
@@ -1,10 +1,10 @@
 {
   "props": {
-    "autoFocus": { "type": { "name": "bool" } },
+    "autoFocus": { "type": { "name": "bool" }, "default": "false" },
     "component": { "type": { "name": "elementType" } },
-    "defaultListboxOpen": { "type": { "name": "bool" } },
+    "defaultListboxOpen": { "type": { "name": "bool" }, "default": "false" },
     "defaultValue": { "type": { "name": "any" } },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "getSerializedValue": { "type": { "name": "func" } },
     "listboxId": { "type": { "name": "string" } },
     "listboxOpen": { "type": { "name": "bool" }, "default": "undefined" },

diff --git a/docs/pages/base/api/slider-unstyled.json b/docs/pages/base/api/slider-unstyled.json
@@ -8,11 +8,11 @@
     "defaultValue": {
       "type": { "name": "union", "description": "Array&lt;number&gt;<br>&#124;&nbsp;number" }
     },
-    "disabled": { "type": { "name": "bool" } },
-    "disableSwap": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
+    "disableSwap": { "type": { "name": "bool" }, "default": "false" },
     "getAriaLabel": { "type": { "name": "func" } },
     "getAriaValueText": { "type": { "name": "func" } },
-    "isRtl": { "type": { "name": "bool" } },
+    "isRtl": { "type": { "name": "bool" }, "default": "false" },
     "marks": {
       "type": {
         "name": "union",

diff --git a/docs/pages/base/api/snackbar-unstyled.json b/docs/pages/base/api/snackbar-unstyled.json
@@ -2,7 +2,7 @@
   "props": {
     "autoHideDuration": { "type": { "name": "number" }, "default": "null" },
     "component": { "type": { "name": "elementType" } },
-    "disableWindowBlurListener": { "type": { "name": "bool" } },
+    "disableWindowBlurListener": { "type": { "name": "bool" }, "default": "false" },
     "exited": { "type": { "name": "bool" }, "default": "true" },
     "onClose": { "type": { "name": "func" } },
     "open": { "type": { "name": "bool" } },

diff --git a/docs/pages/base/api/tab-unstyled.json b/docs/pages/base/api/tab-unstyled.json
@@ -7,7 +7,7 @@
       }
     },
     "component": { "type": { "name": "elementType" } },
-    "disabled": { "type": { "name": "bool" } },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
     "onChange": { "type": { "name": "func" } },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },

diff --git a/docs/pages/material-ui/api/accordion-actions.json b/docs/pages/material-ui/api/accordion-actions.json
@@ -2,7 +2,7 @@
   "props": {
     "children": { "type": { "name": "node" } },
     "classes": { "type": { "name": "object" } },
-    "disableSpacing": { "type": { "name": "bool" } },
+    "disableSpacing": { "type": { "name": "bool" }, "default": "false" },
     "sx": {
       "type": {
         "name": "union",

diff --git a/docs/pages/material-ui/api/accordion.json b/docs/pages/material-ui/api/accordion.json
@@ -2,12 +2,12 @@
   "props": {
     "children": { "type": { "name": "custom", "description": "node" }, "required": true },
     "classes": { "type": { "name": "object" } },
-    "defaultExpanded": { "type": { "name": "bool" } },
-    "disabled": { "type": { "name": "bool" } },
-    "disableGutters": { "type": { "name": "bool" } },
+    "defaultExpanded": { "type": { "name": "bool" }, "default": "false" },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
+    "disableGutters": { "type": { "name": "bool" }, "default": "false" },
     "expanded": { "type": { "name": "bool" } },
     "onChange": { "type": { "name": "func" } },
-    "square": { "type": { "name": "bool" } },
+    "square": { "type": { "name": "bool" }, "default": "false" },
     "sx": {
       "type": {
         "name": "union",

diff --git a/docs/pages/material-ui/api/app-bar.json b/docs/pages/material-ui/api/app-bar.json
@@ -9,7 +9,7 @@
       },
       "default": "'primary'"
     },
-    "enableColorOnDark": { "type": { "name": "bool" } },
+    "enableColorOnDark": { "type": { "name": "bool" }, "default": "false" },
     "position": {
       "type": {
         "name": "enum",

diff --git a/docs/pages/material-ui/api/autocomplete.json b/docs/pages/material-ui/api/autocomplete.json
@@ -2,9 +2,9 @@
   "props": {
     "options": { "type": { "name": "array" }, "required": true },
     "renderInput": { "type": { "name": "func" }, "required": true },
-    "autoComplete": { "type": { "name": "bool" } },
-    "autoHighlight": { "type": { "name": "bool" } },
-    "autoSelect": { "type": { "name": "bool" } },
+    "autoComplete": { "type": { "name": "bool" }, "default": "false" },
+    "autoHighlight": { "type": { "name": "bool" }, "default": "false" },
+    "autoSelect": { "type": { "name": "bool" }, "default": "false" },
     "blurOnSelect": {
       "type": {
         "name": "union",
@@ -16,7 +16,7 @@
     "classes": { "type": { "name": "object" } },
     "clearIcon": { "type": { "name": "node" }, "default": "<ClearIcon fontSize=\"small\" />" },
     "clearOnBlur": { "type": { "name": "bool" }, "default": "!props.freeSolo" },
-    "clearOnEscape": { "type": { "name": "bool" } },
+    "clearOnEscape": { "type": { "name": "bool" }, "default": "false" },
     "clearText": { "type": { "name": "string" }, "default": "'Clear'" },
     "closeText": { "type": { "name": "string" }, "default": "'Close'" },
     "componentsProps": {
@@ -30,20 +30,20 @@
       "type": { "name": "custom", "description": "any" },
       "default": "props.multiple ? [] : null"
     },
-    "disableClearable": { "type": { "name": "bool" } },
-    "disableCloseOnSelect": { "type": { "name": "bool" } },
-    "disabled": { "type": { "name": "bool" } },
-    "disabledItemsFocusable": { "type": { "name": "bool" } },
-    "disableListWrap": { "type": { "name": "bool" } },
-    "disablePortal": { "type": { "name": "bool" } },
+    "disableClearable": { "type": { "name": "bool" }, "default": "false" },
+    "disableCloseOnSelect": { "type": { "name": "bool" }, "default": "false" },
+    "disabled": { "type": { "name": "bool" }, "default": "false" },
+    "disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" },
+    "disableListWrap": { "type": { "name": "bool" }, "default": "false" },
+    "disablePortal": { "type": { "name": "bool" }, "default": "false" },
     "filterOptions": { "type": { "name": "func" } },
-    "filterSelectedOptions": { "type": { "name": "bool" } },
+    "filterSelectedOptions": { "type": { "name": "bool" }, "default": "false" },
     "forcePopupIcon": {
       "type": { "name": "union", "description": "'auto'<br>&#124;&nbsp;bool" },
       "default": "'auto'"
     },
-    "freeSolo": { "type": { "name": "bool" } },
-    "fullWidth": { "type": { "name": "bool" } },
+    "freeSolo": { "type": { "name": "bool" }, "default": "false" },
+    "fullWidth": { "type": { "name": "bool" }, "default": "false" },
     "getLimitTagsText": { "type": { "name": "func" }, "default": "(more) => `+${more}`" },
     "getOptionDisabled": { "type": { "name": "func" } },
     "getOptionLabel": {
@@ -53,28 +53,28 @@
     "groupBy": { "type": { "name": "func" } },
     "handleHomeEndKeys": { "type": { "name": "bool" }, "default": "!props.freeSolo" },
     "id": { "type": { "name": "string" } },
-    "includeInputInList": { "type": { "name": "bool" } },
+    "includeInputInList": { "type": { "name": "bool" }, "default": "false" },
     "inputValue": { "type": { "name": "string" } },
     "isOptionEqualToValue": { "type": { "name": "func" } },
     "limitTags": { "type": { "name": "custom", "description": "integer" }, "default": "-1" },
     "ListboxComponent": { "type": { "name": "elementType" }, "default": "'ul'" },
     "ListboxProps": { "type": { "name": "object" } },
-    "loading": { "type": { "name": "bool" } },
+    "loading": { "type": { "name": "bool" }, "default": "false" },
     "loadingText": { "type": { "name": "node" }, "default": "'Loading…'" },
-    "multiple": { "type": { "name": "bool" } },
+    "multiple": { "type": { "name": "bool" }, "default": "false" },
     "noOptionsText": { "type": { "name": "node" }, "default": "'No options'" },
     "onChange": { "type": { "name": "func" } },
     "onClose": { "type": { "name": "func" } },
     "onHighlightChange": { "type": { "name": "func" } },
     "onInputChange": { "type": { "name": "func" } },
     "onOpen": { "type": { "name": "func" } },
     "open": { "type": { "name": "bool" } },
-    "openOnFocus": { "type": { "name": "bool" } },
+    "openOnFocus": { "type": { "name": "bool" }, "default": "false" },
     "openText": { "type": { "name": "string" }, "default": "'Open'" },
     "PaperComponent": { "type": { "name": "elementType" }, "default": "Paper" },
     "PopperComponent": { "type": { "name": "elementType" }, "default": "Popper" },
     "popupIcon": { "type": { "name": "node" }, "default": "<ArrowDropDownIcon />" },
-    "readOnly": { "type": { "name": "bool" } },
+    "readOnly": { "type": { "name": "bool" }, "default": "false" },
     "renderGroup": { "type": { "name": "func" } },
     "renderOption": { "type": { "name": "func" } },
     "renderTags": { "type": { "name": "func" } },

diff --git a/docs/pages/material-ui/api/backdrop.json b/docs/pages/material-ui/api/backdrop.json
@@ -12,7 +12,7 @@
       "type": { "name": "shape", "description": "{ root?: object }" },
       "default": "{}"
     },
-    "invisible": { "type": { "name": "bool" } },
+    "invisible": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": { "name": "shape", "description": "{ root?: object }" },
       "default": "{}"

diff --git a/docs/pages/material-ui/api/badge.json b/docs/pages/material-ui/api/badge.json
@@ -29,13 +29,13 @@
       },
       "default": "{}"
     },
-    "invisible": { "type": { "name": "bool" } },
+    "invisible": { "type": { "name": "bool" }, "default": "false" },
     "max": { "type": { "name": "number" }, "default": "99" },
     "overlap": {
       "type": { "name": "enum", "description": "'circular'<br>&#124;&nbsp;'rectangular'" },
       "default": "'rectangular'"
     },
-    "showZero": { "type": { "name": "bool" } },
+    "showZero": { "type": { "name": "bool" }, "default": "false" },
     "slotProps": {
       "type": {
         "name": "shape",

diff --git a/docs/pages/material-ui/api/bottom-navigation.json b/docs/pages/material-ui/api/bottom-navigation.json
@@ -4,7 +4,7 @@
     "classes": { "type": { "name": "object" } },
     "component": { "type": { "name": "elementType" } },
     "onChange": { "type": { "name": "func" } },
-    "showLabels": { "type": { "name": "bool" } },
+    "showLabels": { "type": { "name": "bool" }, "default": "false" },
     "sx": {
       "type": {
         "name": "union",