[docs] Take default prop into account

Apply mui#22382 (comment)
oliviertassinari · Oct 17, 2020 · 47ce7d0 · 47ce7d0
1 parent d178429
commit 47ce7d0
Show file tree

Hide file tree

Showing 39 changed files with 42 additions and 42 deletions.
diff --git a/docs/pages/api-docs/accordion-actions.md b/docs/pages/api-docs/accordion-actions.md
@@ -41,7 +41,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiAccordionActions-root</span> | Styles applied to the root element.
-| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiAccordionActions-spacing</span> | Styles applied to the root element if `disableSpacing={false}`.
+| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiAccordionActions-spacing</span> | Styles applied to the root element unless `disableSpacing={true}`.
 
 You can override the style of the component thanks to one of these customization points:
 

diff --git a/docs/pages/api-docs/accordion.md b/docs/pages/api-docs/accordion.md
@@ -47,7 +47,7 @@ Any other props supplied will be provided to the root element ([Paper](/api/pape
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiAccordion-root</span> | Styles applied to the root element.
-| <span class="prop-name">rounded</span> | <span class="prop-name">.MuiAccordion-rounded</span> | Styles applied to the root element if `square={false}`.
+| <span class="prop-name">rounded</span> | <span class="prop-name">.MuiAccordion-rounded</span> | Styles applied to the root element unless `square={true}`.
 | <span class="prop-name">expanded</span> | <span class="prop-name">.Mui-expanded</span> | Pseudo-class applied to the root element if `expanded={true}`.
 | <span class="prop-name">disabled</span> | <span class="prop-name">.Mui-disabled</span> | Pseudo-class applied to the root element if `disabled={true}`.
 | <span class="prop-name">region</span> | <span class="prop-name">.MuiAccordion-region</span> | Styles applied to the region element, the container of the children.

diff --git a/docs/pages/api-docs/card-actions.md b/docs/pages/api-docs/card-actions.md
@@ -41,7 +41,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiCardActions-root</span> | Styles applied to the root element.
-| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiCardActions-spacing</span> | Styles applied to the root element if `disableSpacing={false}`.
+| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiCardActions-spacing</span> | Styles applied to the root element unless `disableSpacing={true}`.
 
 You can override the style of the component thanks to one of these customization points:
 

diff --git a/docs/pages/api-docs/dialog-actions.md b/docs/pages/api-docs/dialog-actions.md
@@ -41,7 +41,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiDialogActions-root</span> | Styles applied to the root element.
-| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiDialogActions-spacing</span> | Styles applied to the root element if `disableSpacing={false}`.
+| <span class="prop-name">spacing</span> | <span class="prop-name">.MuiDialogActions-spacing</span> | Styles applied to the root element unless `disableSpacing={true}`.
 
 You can override the style of the component thanks to one of these customization points:
 

diff --git a/docs/pages/api-docs/filled-input.md b/docs/pages/api-docs/filled-input.md
@@ -66,7 +66,7 @@ Any other props supplied will be provided to the root element ([InputBase](/api/
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiFilledInput-root</span> | Styles applied to the root element.
 | <span class="prop-name">colorSecondary</span> | <span class="prop-name">.MuiFilledInput-colorSecondary</span> | Styles applied to the root element if color secondary.
-| <span class="prop-name">underline</span> | <span class="prop-name">.MuiFilledInput-underline</span> | Styles applied to the root element if `disableUnderline={false}`.
+| <span class="prop-name">underline</span> | <span class="prop-name">.MuiFilledInput-underline</span> | Styles applied to the root element unless `disableUnderline={true}`.
 | <span class="prop-name">focused</span> | <span class="prop-name">.Mui-focused</span> | Pseudo-class applied to the root element if the component is focused.
 | <span class="prop-name">disabled</span> | <span class="prop-name">.Mui-disabled</span> | Pseudo-class applied to the root element if `disabled={true}`.
 | <span class="prop-name">adornedStart</span> | <span class="prop-name">.MuiFilledInput-adornedStart</span> | Styles applied to the root element if `startAdornment` is provided.

diff --git a/docs/pages/api-docs/input-label.md b/docs/pages/api-docs/input-label.md
@@ -57,7 +57,7 @@ Any other props supplied will be provided to the root element ([FormLabel](/api/
 | <span class="prop-name">formControl</span> | <span class="prop-name">.MuiInputLabel-formControl</span> | Styles applied to the root element if the component is a descendant of `FormControl`.
 | <span class="prop-name">marginDense</span> | <span class="prop-name">.MuiInputLabel-marginDense</span> | Styles applied to the root element if `margin="dense"`.
 | <span class="prop-name">shrink</span> | <span class="prop-name">.MuiInputLabel-shrink</span> | Styles applied to the `input` element if `shrink={true}`.
-| <span class="prop-name">animated</span> | <span class="prop-name">.MuiInputLabel-animated</span> | Styles applied to the `input` element if `disableAnimation={false}`.
+| <span class="prop-name">animated</span> | <span class="prop-name">.MuiInputLabel-animated</span> | Styles applied to the `input` element unless `disableAnimation={true}`.
 | <span class="prop-name">filled</span> | <span class="prop-name">.MuiInputLabel-filled</span> | Styles applied to the root element if `variant="filled"`.
 | <span class="prop-name">outlined</span> | <span class="prop-name">.MuiInputLabel-outlined</span> | Styles applied to the root element if `variant="outlined"`.
 

diff --git a/docs/pages/api-docs/input.md b/docs/pages/api-docs/input.md
@@ -69,7 +69,7 @@ Any other props supplied will be provided to the root element ([InputBase](/api/
 | <span class="prop-name">focused</span> | <span class="prop-name">.Mui-focused</span> | Styles applied to the root element if the component is focused.
 | <span class="prop-name">disabled</span> | <span class="prop-name">.Mui-disabled</span> | Styles applied to the root element if `disabled={true}`.
 | <span class="prop-name">colorSecondary</span> | <span class="prop-name">.MuiInput-colorSecondary</span> | Styles applied to the root element if color secondary.
-| <span class="prop-name">underline</span> | <span class="prop-name">.MuiInput-underline</span> | Styles applied to the root element if `disableUnderline={false}`.
+| <span class="prop-name">underline</span> | <span class="prop-name">.MuiInput-underline</span> | Styles applied to the root element unless `disableUnderline={true}`.
 | <span class="prop-name">error</span> | <span class="prop-name">.Mui-error</span> | Pseudo-class applied to the root element if `error={true}`.
 | <span class="prop-name">marginDense</span> | <span class="prop-name">.MuiInput-marginDense</span> | Styles applied to the `input` element if `margin="dense"`.
 | <span class="prop-name">multiline</span> | <span class="prop-name">.MuiInput-multiline</span> | Styles applied to the root element if `multiline={true}`.

diff --git a/docs/pages/api-docs/list-item.md b/docs/pages/api-docs/list-item.md
@@ -57,7 +57,7 @@ Any other props supplied will be provided to the root element (native element).
 | <span class="prop-name">alignItemsFlexStart</span> | <span class="prop-name">.MuiListItem-alignItemsFlexStart</span> | Styles applied to the `component` element if `alignItems="flex-start"`.
 | <span class="prop-name">disabled</span> | <span class="prop-name">.Mui-disabled</span> | Pseudo-class applied to the inner `component` element if `disabled={true}`.
 | <span class="prop-name">divider</span> | <span class="prop-name">.MuiListItem-divider</span> | Styles applied to the inner `component` element if `divider={true}`.
-| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiListItem-gutters</span> | Styles applied to the inner `component` element if `disableGutters={false}`.
+| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiListItem-gutters</span> | Styles applied to the inner `component` element unless `disableGutters={true}`.
 | <span class="prop-name">button</span> | <span class="prop-name">.MuiListItem-button</span> | Styles applied to the inner `component` element if `button={true}`.
 | <span class="prop-name">secondaryAction</span> | <span class="prop-name">.MuiListItem-secondaryAction</span> | Styles applied to the `component` element if `children` includes `ListItemSecondaryAction`.
 | <span class="prop-name">selected</span> | <span class="prop-name">.Mui-selected</span> | Pseudo-class applied to the root element if `selected={true}`.

diff --git a/docs/pages/api-docs/list-subheader.md b/docs/pages/api-docs/list-subheader.md
@@ -47,9 +47,9 @@ Any other props supplied will be provided to the root element (native element).
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiListSubheader-root</span> | Styles applied to the root element.
 | <span class="prop-name">colorPrimary</span> | <span class="prop-name">.MuiListSubheader-colorPrimary</span> | Styles applied to the root element if `color="primary"`.
 | <span class="prop-name">colorInherit</span> | <span class="prop-name">.MuiListSubheader-colorInherit</span> | Styles applied to the root element if `color="inherit"`.
-| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiListSubheader-gutters</span> | Styles applied to the inner `component` element if `disableGutters={false}`.
+| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiListSubheader-gutters</span> | Styles applied to the inner `component` element unless `disableGutters={true}`.
 | <span class="prop-name">inset</span> | <span class="prop-name">.MuiListSubheader-inset</span> | Styles applied to the root element if `inset={true}`.
-| <span class="prop-name">sticky</span> | <span class="prop-name">.MuiListSubheader-sticky</span> | Styles applied to the root element if `disableSticky={false}`.
+| <span class="prop-name">sticky</span> | <span class="prop-name">.MuiListSubheader-sticky</span> | Styles applied to the root element unless `disableSticky={true}`.
 
 You can override the style of the component thanks to one of these customization points:
 

diff --git a/docs/pages/api-docs/list.md b/docs/pages/api-docs/list.md
@@ -44,7 +44,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiList-root</span> | Styles applied to the root element.
-| <span class="prop-name">padding</span> | <span class="prop-name">.MuiList-padding</span> | Styles applied to the root element if `disablePadding={false}`.
+| <span class="prop-name">padding</span> | <span class="prop-name">.MuiList-padding</span> | Styles applied to the root element unless `disablePadding={true}`.
 | <span class="prop-name">dense</span> | <span class="prop-name">.MuiList-dense</span> | Styles applied to the root element if dense.
 | <span class="prop-name">subheader</span> | <span class="prop-name">.MuiList-subheader</span> | Styles applied to the root element if a `subheader` is provided.
 

diff --git a/docs/pages/api-docs/menu-item.md b/docs/pages/api-docs/menu-item.md
@@ -44,7 +44,7 @@ Any other props supplied will be provided to the root element ([ListItem](/api/l
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiMenuItem-root</span> | Styles applied to the root element.
-| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiMenuItem-gutters</span> | Styles applied to the root element if `disableGutters={false}`.
+| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiMenuItem-gutters</span> | Styles applied to the root element unless `disableGutters={true}`.
 | <span class="prop-name">selected</span> | <span class="prop-name">.Mui-selected</span> | Styles applied to the root element if `selected={true}`.
 | <span class="prop-name">dense</span> | <span class="prop-name">.MuiMenuItem-dense</span> | Styles applied to the root element if dense.
 

diff --git a/docs/pages/api-docs/paper.md b/docs/pages/api-docs/paper.md
@@ -44,7 +44,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiPaper-root</span> | Styles applied to the root element.
-| <span class="prop-name">rounded</span> | <span class="prop-name">.MuiPaper-rounded</span> | Styles applied to the root element if `square={false}`.
+| <span class="prop-name">rounded</span> | <span class="prop-name">.MuiPaper-rounded</span> | Styles applied to the root element unless `square={true}`.
 | <span class="prop-name">outlined</span> | <span class="prop-name">.MuiPaper-outlined</span> | Styles applied to the root element if `variant="outlined"`.
 | <span class="prop-name">elevation</span> | <span class="prop-name">.MuiPaper-elevation</span> | Styles applied to the root element if `variant="elevation"`.
 | <span class="prop-name">elevation0</span> | <span class="prop-name">.MuiPaper-elevation0</span> | 

diff --git a/docs/pages/api-docs/toolbar.md b/docs/pages/api-docs/toolbar.md
@@ -43,7 +43,7 @@ Any other props supplied will be provided to the root element (native element).
 | Rule name | Global class | Description |
 |:-----|:-------------|:------------|
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiToolbar-root</span> | Styles applied to the root element.
-| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiToolbar-gutters</span> | Styles applied to the root element if `disableGutters={false}`.
+| <span class="prop-name">gutters</span> | <span class="prop-name">.MuiToolbar-gutters</span> | Styles applied to the root element unless `disableGutters={true}`.
 | <span class="prop-name">regular</span> | <span class="prop-name">.MuiToolbar-regular</span> | Styles applied to the root element if `variant="regular"`.
 | <span class="prop-name">dense</span> | <span class="prop-name">.MuiToolbar-dense</span> | Styles applied to the root element if `variant="dense"`.
 

diff --git a/packages/material-ui/src/Accordion/Accordion.d.ts b/packages/material-ui/src/Accordion/Accordion.d.ts
@@ -14,7 +14,7 @@ export interface AccordionProps extends StandardProps<PaperProps, 'onChange'> {
   classes?: {
     /** Styles applied to the root element. */
     root?: string;
-    /** Styles applied to the root element if `square={false}`. */
+    /** Styles applied to the root element unless `square={true}`. */
     rounded?: string;
     /** Pseudo-class applied to the root element if `expanded={true}`. */
     expanded?: string;

diff --git a/packages/material-ui/src/Accordion/Accordion.js b/packages/material-ui/src/Accordion/Accordion.js
@@ -57,7 +57,7 @@ export const styles = (theme) => {
         backgroundColor: theme.palette.action.disabledBackground,
       },
     },
-    /* Styles applied to the root element if `square={false}`. */
+    /* Styles applied to the root element unless `square={true}`. */
     rounded: {
       borderRadius: 0,
       '&:first-child': {

diff --git a/packages/material-ui/src/AccordionActions/AccordionActions.d.ts b/packages/material-ui/src/AccordionActions/AccordionActions.d.ts
@@ -12,7 +12,7 @@ export interface AccordionActionsProps extends StandardProps<React.HTMLAttribute
   classes?: {
     /** Styles applied to the root element. */
     root?: string;
-    /** Styles applied to the root element if `disableSpacing={false}`. */
+    /** Styles applied to the root element unless `disableSpacing={true}`. */
     spacing?: string;
   };
   /**

diff --git a/packages/material-ui/src/AccordionActions/AccordionActions.js b/packages/material-ui/src/AccordionActions/AccordionActions.js
@@ -11,7 +11,7 @@ export const styles = {
     padding: 8,
     justifyContent: 'flex-end',
   },
-  /* Styles applied to the root element if `disableSpacing={false}`. */
+  /* Styles applied to the root element unless `disableSpacing={true}`. */
   spacing: {
     '& > :not(:first-child)': {
       marginLeft: 8,

diff --git a/packages/material-ui/src/CardActions/CardActions.d.ts b/packages/material-ui/src/CardActions/CardActions.d.ts
@@ -12,7 +12,7 @@ export interface CardActionsProps extends StandardProps<React.HTMLAttributes<HTM
   classes?: {
     /** Styles applied to the root element. */
     root?: string;
-    /** Styles applied to the root element if `disableSpacing={false}`. */
+    /** Styles applied to the root element unless `disableSpacing={true}`. */
     spacing?: string;
   };
   /**

diff --git a/packages/material-ui/src/CardActions/CardActions.js b/packages/material-ui/src/CardActions/CardActions.js
@@ -10,7 +10,7 @@ export const styles = {
     alignItems: 'center',
     padding: 8,
   },
-  /* Styles applied to the root element if `disableSpacing={false}`. */
+  /* Styles applied to the root element unless `disableSpacing={true}`. */
   spacing: {
     '& > :not(:first-child)': {
       marginLeft: 8,

diff --git a/packages/material-ui/src/DialogActions/DialogActions.d.ts b/packages/material-ui/src/DialogActions/DialogActions.d.ts
@@ -12,7 +12,7 @@ export interface DialogActionsProps extends StandardProps<React.HTMLAttributes<H
   classes?: {
     /** Styles applied to the root element. */
     root?: string;
-    /** Styles applied to the root element if `disableSpacing={false}`. */
+    /** Styles applied to the root element unless `disableSpacing={true}`. */
     spacing?: string;
   };
   /**

diff --git a/packages/material-ui/src/DialogActions/DialogActions.js b/packages/material-ui/src/DialogActions/DialogActions.js
@@ -12,7 +12,7 @@ export const styles = {
     justifyContent: 'flex-end',
     flex: '0 0 auto',
   },
-  /* Styles applied to the root element if `disableSpacing={false}`. */
+  /* Styles applied to the root element unless `disableSpacing={true}`. */
   spacing: {
     '& > :not(:first-child)': {
       marginLeft: 8,

diff --git a/packages/material-ui/src/FilledInput/FilledInput.d.ts b/packages/material-ui/src/FilledInput/FilledInput.d.ts
@@ -10,7 +10,7 @@ export interface FilledInputProps extends StandardProps<InputBaseProps> {
     root?: string;
     /** Styles applied to the root element if color secondary. */
     colorSecondary?: string;
-    /** Styles applied to the root element if `disableUnderline={false}`. */
+    /** Styles applied to the root element unless `disableUnderline={true}`. */
     underline?: string;
     /** Pseudo-class applied to the root element if the component is focused. */
     focused?: string;

diff --git a/packages/material-ui/src/FilledInput/FilledInput.js b/packages/material-ui/src/FilledInput/FilledInput.js
@@ -41,7 +41,7 @@ export const styles = (theme) => {
         borderBottomColor: theme.palette.secondary.main,
       },
     },
-    /* Styles applied to the root element if `disableUnderline={false}`. */
+    /* Styles applied to the root element unless `disableUnderline={true}`. */
     underline: {
       '&:after': {
         borderBottom: `2px solid ${theme.palette.primary.main}`,

diff --git a/packages/material-ui/src/Input/Input.d.ts b/packages/material-ui/src/Input/Input.d.ts
@@ -16,7 +16,7 @@ export interface InputProps extends StandardProps<InputBaseProps> {
     disabled?: string;
     /** Styles applied to the root element if color secondary. */
     colorSecondary?: string;
-    /** Styles applied to the root element if `disableUnderline={false}`. */
+    /** Styles applied to the root element unless `disableUnderline={true}`. */
     underline?: string;
     /** Pseudo-class applied to the root element if `error={true}`. */
     error?: string;

diff --git a/packages/material-ui/src/Input/Input.js b/packages/material-ui/src/Input/Input.js
@@ -30,7 +30,7 @@ export const styles = (theme) => {
         borderBottomColor: theme.palette.secondary.main,
       },
     },
-    /* Styles applied to the root element if `disableUnderline={false}`. */
+    /* Styles applied to the root element unless `disableUnderline={true}`. */
     underline: {
       '&:after': {
         borderBottom: `2px solid ${theme.palette.primary.main}`,

diff --git a/packages/material-ui/src/InputLabel/InputLabel.d.ts b/packages/material-ui/src/InputLabel/InputLabel.d.ts
@@ -29,7 +29,7 @@ export interface InputLabelProps extends StandardProps<FormLabelProps> {
     marginDense?: string;
     /** Styles applied to the `input` element if `shrink={true}`. */
     shrink?: string;
-    /** Styles applied to the `input` element if `disableAnimation={false}`. */
+    /** Styles applied to the `input` element unless `disableAnimation={true}`. */
     animated?: string;
     /** Styles applied to the root element if `variant="filled"`. */
     filled?: string;

diff --git a/packages/material-ui/src/InputLabel/InputLabel.js b/packages/material-ui/src/InputLabel/InputLabel.js
@@ -40,7 +40,7 @@ export const styles = (theme) => ({
     transform: 'translate(0, 1.5px) scale(0.75)',
     transformOrigin: 'top left',
   },
-  /* Styles applied to the `input` element if `disableAnimation={false}`. */
+  /* Styles applied to the `input` element unless `disableAnimation={true}`. */
   animated: {
     transition: theme.transitions.create(['color', 'transform'], {
       duration: theme.transitions.duration.shorter,

diff --git a/packages/material-ui/src/List/List.d.ts b/packages/material-ui/src/List/List.d.ts
@@ -13,7 +13,7 @@ export interface ListTypeMap<P = {}, D extends React.ElementType = 'ul'> {
     classes?: {
       /** Styles applied to the root element. */
       root?: string;
-      /** Styles applied to the root element if `disablePadding={false}`. */
+      /** Styles applied to the root element unless `disablePadding={true}`. */
       padding?: string;
       /** Styles applied to the root element if dense. */
       dense?: string;

diff --git a/packages/material-ui/src/List/List.js b/packages/material-ui/src/List/List.js
@@ -12,7 +12,7 @@ export const styles = {
     padding: 0,
     position: 'relative',
   },
-  /* Styles applied to the root element if `disablePadding={false}`. */
+  /* Styles applied to the root element unless `disablePadding={true}`. */
   padding: {
     paddingTop: 8,
     paddingBottom: 8,