You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/api-docs/checkbox.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ The `MuiCheckbox` name can be used for providing [default props](/customization/
31
31
| <spanclass="prop-name">checked</span> | <spanclass="prop-type">bool</span> || If `true`, the component is checked. |
32
32
| <spanclass="prop-name">checkedIcon</span> | <spanclass="prop-type">node</span> | <spanclass="prop-default"><CheckBoxIcon /></span> | The icon to display when the component is checked. |
33
33
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
34
-
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'primary'<br>| 'secondary'<br>| 'default'</span> | <spanclass="prop-default">'secondary'</span> | The color of the component. It supports those theme colors that make sense for this component. |
34
+
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'default'<br>| 'primary'<br>| 'secondary'</span> | <spanclass="prop-default">'secondary'</span> | The color of the component. It supports those theme colors that make sense for this component. |
35
35
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> || If `true`, the checkbox will be disabled. |
36
36
| <spanclass="prop-name">disableRipple</span> | <spanclass="prop-type">bool</span> || If `true`, the ripple effect will be disabled. |
37
37
| <spanclass="prop-name">icon</span> | <spanclass="prop-type">node</span> | <spanclass="prop-default"><CheckBoxOutlineBlankIcon /></span> | The icon to display when the component is unchecked. |
@@ -42,7 +42,7 @@ The `MuiCheckbox` name can be used for providing [default props](/customization/
42
42
| <spanclass="prop-name">inputRef</span> | <spanclass="prop-type">ref</span> || Pass a ref to the `input` element. |
43
43
| <spanclass="prop-name">onChange</span> | <spanclass="prop-type">func</span> || Callback fired when the state is changed.<br><br>**Signature:**<br>`function(event: object) => void`<br>*event:* The event source of the callback. You can pull out the new checked state by accessing `event.target.checked` (boolean). |
44
44
| <spanclass="prop-name">required</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be required. |
45
-
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'small'<br>| 'medium'</span> | <spanclass="prop-default">'medium'</span> | The size of the checkbox. `small` is equivalent to the dense checkbox styling. |
45
+
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'medium'<br>| 'small'</span> | <spanclass="prop-default">'medium'</span> | The size of the checkbox. `small` is equivalent to the dense checkbox styling. |
46
46
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/circular-progress.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ The `MuiCircularProgress` name can be used for providing [default props](/custom
33
33
| Name | Type | Default | Description |
34
34
|:-----|:-----|:--------|:------------|
35
35
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
36
-
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'primary'<br>| 'secondary'<br>| 'inherit'</span> | <spanclass="prop-default">'primary'</span> | The color of the component. It supports those theme colors that make sense for this component. |
36
+
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'inherit'<br>| 'primary'<br>| 'secondary'</span> | <spanclass="prop-default">'primary'</span> | The color of the component. It supports those theme colors that make sense for this component. |
37
37
| <spanclass="prop-name">disableShrink</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the shrink animation is disabled. This only works if variant is `indeterminate`. |
38
38
| <spanclass="prop-name">size</span> | <spanclass="prop-type">number<br>| string</span> | <spanclass="prop-default">40</span> | The size of the circle. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'. |
39
39
| <spanclass="prop-name">thickness</span> | <spanclass="prop-type">number</span> | <spanclass="prop-default">3.6</span> | The thickness of the circle. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/click-away-listener.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,10 +28,10 @@ For instance, if you need to hide a menu when people click anywhere else on your
28
28
| Name | Type | Default | Description |
29
29
|:-----|:-----|:--------|:------------|
30
30
| <spanclass="prop-name required">children *</span> | <spanclass="prop-type">element</span> || The wrapped element.<br>⚠️ [Needs to be able to hold a ref](/guides/composition/#caveat-with-refs). |
31
-
| <spanclass="prop-name">disableReactTree</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> |If `true`, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled. |
31
+
| <spanclass="prop-name">disableReactTree</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> |The mouse event to listen to. You can disable the listener by providing `false`. |
32
32
| <spanclass="prop-name">mouseEvent</span> | <spanclass="prop-type">'onClick'<br>| 'onMouseDown'<br>| 'onMouseUp'<br>| false</span> | <spanclass="prop-default">'onClick'</span> | The mouse event to listen to. You can disable the listener by providing `false`. |
33
33
| <spanclass="prop-name required">onClickAway *</span> | <spanclass="prop-type">func</span> || Callback fired when a "click away" event is detected. |
34
-
| <spanclass="prop-name">touchEvent</span> | <spanclass="prop-type">'onTouchStart'<br>| 'onTouchEnd'<br>| false</span> | <spanclass="prop-default">'onTouchEnd'</span> | The touch event to listen to. You can disable the listener by providing `false`. |
34
+
| <spanclass="prop-name">touchEvent</span> | <spanclass="prop-type">'onTouchEnd'<br>| 'onTouchStart'<br>| false</span> | <spanclass="prop-default">'onTouchEnd'</span> | The touch event to listen to. You can disable the listener by providing `false`. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/expansion-panel.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ The `MuiExpansionPanel` name can be used for providing [default props](/customiz
34
34
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the panel will be displayed in a disabled state. |
35
35
| <spanclass="prop-name">expanded</span> | <spanclass="prop-type">bool</span> || If `true`, expands the panel, otherwise collapse it. Setting this prop enables control over the panel. |
36
36
| <spanclass="prop-name">onChange</span> | <spanclass="prop-type">func</span> || Callback fired when the expand/collapse state is changed.<br><br>**Signature:**<br>`function(event: object, expanded: boolean) => void`<br>*event:* The event source of the callback.<br>*expanded:* The `expanded` state of the panel. |
37
+
| <spanclass="prop-name">square</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, rounded corners are disabled. |
37
38
| <spanclass="prop-name">TransitionComponent</span> | <spanclass="prop-type">elementType</span> | <spanclass="prop-default">Collapse</span> | The component used for the collapse effect. [Follow this guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
38
39
| <spanclass="prop-name">TransitionProps</span> | <spanclass="prop-type">object</span> || Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/filled-input.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,6 @@ The `MuiFilledInput` name can be used for providing [default props](/customizati
31
31
| <spanclass="prop-name">autoComplete</span> | <spanclass="prop-type">string</span> || This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill). |
32
32
| <spanclass="prop-name">autoFocus</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be focused during the first mount. |
33
33
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
34
-
| <spanclass="prop-name">className</span> | <spanclass="prop-type">string</span> || The CSS class name of the wrapper element. |
35
34
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'primary'<br>| 'secondary'</span> || The color of the component. It supports those theme colors that make sense for this component. |
36
35
| <spanclass="prop-name">defaultValue</span> | <spanclass="prop-type">any</span> || The default `input` element value. Use when the component is not controlled. |
37
36
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be disabled. |
@@ -40,7 +39,7 @@ The `MuiFilledInput` name can be used for providing [default props](/customizati
40
39
| <spanclass="prop-name">error</span> | <spanclass="prop-type">bool</span> || If `true`, the input will indicate an error. This is normally obtained via context from FormControl. |
41
40
| <spanclass="prop-name">fullWidth</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the input will take up the full width of its container. |
42
41
| <spanclass="prop-name">id</span> | <spanclass="prop-type">string</span> || The id of the `input` element. |
43
-
| <spanclass="prop-name">inputComponent</span> | <spanclass="prop-type">elementType</span> | <spanclass="prop-default">'input'</span> | The component used for the native input. Either a string to use a DOM element or a component. |
42
+
| <spanclass="prop-name">inputComponent</span> | <spanclass="prop-type">elementType</span> | <spanclass="prop-default">'input'</span> | The component used for the `input` element. Either a string to use a DOM element or a component. |
44
43
| <spanclass="prop-name">inputProps</span> | <spanclass="prop-type">object</span> ||[Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. |
45
44
| <spanclass="prop-name">inputRef</span> | <spanclass="prop-type">ref</span> || Pass a ref to the `input` element. |
46
45
| <spanclass="prop-name">margin</span> | <spanclass="prop-type">'dense'<br>| 'none'</span> || If `dense`, will adjust vertical spacing. This is normally obtained via context from FormControl. |
@@ -50,8 +49,8 @@ The `MuiFilledInput` name can be used for providing [default props](/customizati
50
49
| <spanclass="prop-name">placeholder</span> | <spanclass="prop-type">string</span> || The short hint displayed in the input before the user enters a value. |
51
50
| <spanclass="prop-name">readOnly</span> | <spanclass="prop-type">bool</span> || It prevents the user from changing the value of the field (not from interacting with the field). |
52
51
| <spanclass="prop-name">required</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be required. |
53
-
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">string<br>| number</span> || Number of rows to display when multiline option is set to true. |
54
-
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">string<br>| number</span> || Maximum number of rows to display when multiline option is set to true. |
52
+
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">number<br>| string</span> || Number of rows to display when multiline option is set to true. |
53
+
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">number<br>| string</span> || Maximum number of rows to display when multiline option is set to true. |
55
54
| <spanclass="prop-name">startAdornment</span> | <spanclass="prop-type">node</span> || Start `InputAdornment` for this component. |
56
55
| <spanclass="prop-name">type</span> | <spanclass="prop-type">string</span> | <spanclass="prop-default">'text'</span> | Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types). |
57
56
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The value of the `input` element, required for a controlled component. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/form-control-label.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,11 @@ The `MuiFormControlLabel` name can be used for providing [default props](/custom
31
31
|:-----|:-----|:--------|:------------|
32
32
| <spanclass="prop-name">checked</span> | <spanclass="prop-type">bool</span> || If `true`, the component appears selected. |
33
33
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
34
-
| <spanclass="prop-name">control</span> | <spanclass="prop-type">element</span> || A control element. For instance, it can be be a `Radio`, a `Switch` or a `Checkbox`. |
34
+
| <spanclass="prop-name required">control *</span> | <spanclass="prop-type">element</span> || A control element. For instance, it can be be a `Radio`, a `Switch` or a `Checkbox`. |
35
35
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> || If `true`, the control will be disabled. |
36
36
| <spanclass="prop-name">inputRef</span> | <spanclass="prop-type">ref</span> || Pass a ref to the `input` element. |
37
37
| <spanclass="prop-name">label</span> | <spanclass="prop-type">node</span> || The text to be used in an enclosing label element. |
38
-
| <spanclass="prop-name">labelPlacement</span> | <spanclass="prop-type">'end'<br>| 'start'<br>| 'top'<br>| 'bottom'</span> | <spanclass="prop-default">'end'</span> | The position of the label. |
| <spanclass="prop-name">labelPlacement</span> | <spanclass="prop-type">'bottom'<br>| 'end'<br>| 'start'<br>| 'top'</span> | <spanclass="prop-default">'end'</span> | The position of the label. |
40
39
| <spanclass="prop-name">onChange</span> | <spanclass="prop-type">func</span> || Callback fired when the state is changed.<br><br>**Signature:**<br>`function(event: object) => void`<br>*event:* The event source of the callback. You can pull out the new checked state by accessing `event.target.checked` (boolean). |
41
40
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The value of the component. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/input-base.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,6 @@ The `MuiInputBase` name can be used for providing [default props](/customization
33
33
| <spanclass="prop-name">autoComplete</span> | <spanclass="prop-type">string</span> || This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill). |
34
34
| <spanclass="prop-name">autoFocus</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be focused during the first mount. |
35
35
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
36
-
| <spanclass="prop-name">className</span> | <spanclass="prop-type">string</span> || The CSS class name of the wrapper element. |
37
36
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'primary'<br>| 'secondary'</span> || The color of the component. It supports those theme colors that make sense for this component. |
38
37
| <spanclass="prop-name">defaultValue</span> | <spanclass="prop-type">any</span> || The default `input` element value. Use when the component is not controlled. |
39
38
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be disabled. |
@@ -52,9 +51,9 @@ The `MuiInputBase` name can be used for providing [default props](/customization
52
51
| <spanclass="prop-name">placeholder</span> | <spanclass="prop-type">string</span> || The short hint displayed in the input before the user enters a value. |
53
52
| <spanclass="prop-name">readOnly</span> | <spanclass="prop-type">bool</span> || It prevents the user from changing the value of the field (not from interacting with the field). |
54
53
| <spanclass="prop-name">required</span> | <spanclass="prop-type">bool</span> || If `true`, the `input` element will be required. |
55
-
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">string<br>| number</span> || Number of rows to display when multiline option is set to true. |
56
-
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">string<br>| number</span> || Maximum number of rows to display when multiline option is set to true. |
57
-
| <spanclass="prop-name">rowsMin</span> | <spanclass="prop-type">string<br>| number</span> || Minimum number of rows to display when multiline option is set to true. |
54
+
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">number<br>| string</span> || Number of rows to display when multiline option is set to true. |
55
+
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">number<br>| string</span> || Maximum number of rows to display when multiline option is set to true. |
56
+
| <spanclass="prop-name">rowsMin</span> | <spanclass="prop-type">number<br>| string</span> || Minimum number of rows to display when multiline option is set to true. |
58
57
| <spanclass="prop-name">startAdornment</span> | <spanclass="prop-type">node</span> || Start `InputAdornment` for this component. |
59
58
| <spanclass="prop-name">type</span> | <spanclass="prop-type">string</span> | <spanclass="prop-default">'text'</span> | Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types). |
60
59
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The value of the `input` element, required for a controlled component. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/input-label.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ The `MuiInputLabel` name can be used for providing [default props](/customizatio
38
38
| <spanclass="prop-name">margin</span> | <spanclass="prop-type">'dense'</span> || If `dense`, will adjust vertical spacing. This is normally obtained via context from FormControl. |
39
39
| <spanclass="prop-name">required</span> | <spanclass="prop-type">bool</span> || if `true`, the label will indicate that the input is required. |
40
40
| <spanclass="prop-name">shrink</span> | <spanclass="prop-type">bool</span> || If `true`, the label is shrunk. |
41
-
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'standard'<br>| 'outlined'<br>| 'filled'</span> || The variant to use. |
41
+
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'filled'<br>| 'outlined'<br>| 'standard'</span> || The variant to use. |
0 commit comments