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/dialog.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,13 +26,13 @@ Dialogs are overlaid modal paper based components with a backdrop.
26
26
|:-----|:-----|:--------|:------------|
27
27
| <spanclass="prop-name">aria-describedby</span> | <spanclass="prop-type">string</span> || The id(s) of the element(s) that describe the dialog. |
28
28
| <spanclass="prop-name">aria-labelledby</span> | <spanclass="prop-type">string</span> || The id(s) of the element(s) that label the dialog. |
29
-
| <spanclass="prop-name required">children *</span> | <spanclass="prop-type">node</span> || Dialog children, usually the included sub-components. |
29
+
| <spanclass="prop-name">children</span> | <spanclass="prop-type">node</span> || Dialog children, usually the included sub-components. |
30
30
| <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. |
31
31
| <spanclass="prop-name">disableBackdropClick</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, clicking the backdrop will not fire the `onClose` callback. |
32
32
| <spanclass="prop-name">disableEscapeKeyDown</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, hitting escape will not fire the `onClose` callback. |
33
33
| <spanclass="prop-name">fullScreen</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the dialog will be full-screen |
34
34
| <spanclass="prop-name">fullWidth</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the dialog stretches to `maxWidth`.<br>Notice that the dialog width grow is limited by the default margin. |
35
-
| <spanclass="prop-name">maxWidth</span> | <spanclass="prop-type">'xs'<br>| 'sm'<br>| 'md'<br>| 'lg'<br>| 'xl'<br>| false</span> | <spanclass="prop-default">'sm'</span> | Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to `false` to disable `maxWidth`. |
35
+
| <spanclass="prop-name">maxWidth</span> | <spanclass="prop-type">'lg'<br>| 'md'<br>| 'sm'<br>| 'xl'<br>| 'xs'<br>| false</span> | <spanclass="prop-default">'sm'</span> | Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to `false` to disable `maxWidth`. |
36
36
| <spanclass="prop-name">onBackdropClick</span> | <spanclass="prop-type">func</span> || Callback fired when the backdrop is clicked. |
37
37
| <spanclass="prop-name">onClose</span> | <spanclass="prop-type">func</span> || Callback fired when the component requests to be closed.<br><br>**Signature:**<br>`function(event: object, reason: string) => void`<br>*event:* The event source of the callback.<br>*reason:* Can be: `"escapeKeyDown"`, `"backdropClick"`. |
38
38
| <spanclass="prop-name">onEnter</span> | <spanclass="prop-type">func</span> || Callback fired before the dialog enters. |
@@ -47,7 +47,7 @@ Dialogs are overlaid modal paper based components with a backdrop.
47
47
| <spanclass="prop-name">PaperProps</span> | <spanclass="prop-type">object</span> | <spanclass="prop-default">{}</span> | Props applied to the [`Paper`](/api/paper/) element. |
48
48
| <spanclass="prop-name">scroll</span> | <spanclass="prop-type">'body'<br>| 'paper'</span> | <spanclass="prop-default">'paper'</span> | Determine the container for scrolling the dialog. |
49
49
| <spanclass="prop-name">TransitionComponent</span> | <spanclass="prop-type">elementType</span> | <spanclass="prop-default">Fade</span> | The component used for the transition. [Follow this guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
50
-
| <spanclass="prop-name">transitionDuration</span> | <spanclass="prop-type">number<br>| { enter?: number, exit?: number }</span> | <spanclass="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen }</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
50
+
| <spanclass="prop-name">transitionDuration</span> | <spanclass="prop-type">number<br>| { appear?: number, enter?: number, exit?: number }</span> | <spanclass="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen }</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
51
51
| <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/native-select.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
@@ -31,7 +31,7 @@ An alternative to `<Select native />` with a much smaller bundle size footprint.
31
31
| <spanclass="prop-name">inputProps</span> | <spanclass="prop-type">object</span> || Attributes applied to the `select` element. |
32
32
| <spanclass="prop-name">onChange</span> | <spanclass="prop-type">func</span> || Callback function fired when a menu item is selected.<br><br>**Signature:**<br>`function(event: object) => void`<br>*event:* The event source of the callback. You can pull out the new value by accessing `event.target.value` (string). |
33
33
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The input value. The DOM API casts this to a string. |
34
-
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'standard'<br>| 'outlined'<br>| 'filled'</span> || The variant to use. |
34
+
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'filled'<br>| 'outlined'<br>| 'standard'</span> || The variant to use. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/select.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
@@ -45,7 +45,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
45
45
| <spanclass="prop-name">renderValue</span> | <spanclass="prop-type">func</span> || Render the selected value. You can only use it when the `native` prop is `false` (default).<br><br>**Signature:**<br>`function(value: any) => ReactNode`<br>*value:* The `value` provided to the component. |
46
46
| <spanclass="prop-name">SelectDisplayProps</span> | <spanclass="prop-type">object</span> || Props applied to the clickable div element. |
47
47
| <spanclass="prop-name">value</span> | <spanclass="prop-type">any</span> || The input value. Providing an empty string will select no options. This prop is required when the `native` prop is `false` (default). Set to an empty string `''` if you don't want any of the available options to be selected.<br>If the value is an object it must have reference equality with the option in order to be selected. If the value is not an object, the string representation must match with the string representation of the option in order to be selected. |
48
-
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'standard'<br>| 'outlined'<br>| 'filled'</span> | <spanclass="prop-default">'standard'</span> | The variant to use. |
48
+
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'filled'<br>| 'outlined'<br>| 'standard'</span> | <spanclass="prop-default">'standard'</span> | The variant to use. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/table-cell.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,15 @@ or otherwise a `<td>` element.
25
25
26
26
| Name | Type | Default | Description |
27
27
|:-----|:-----|:--------|:------------|
28
-
| <spanclass="prop-name">align</span> | <spanclass="prop-type">'inherit'<br>| 'left'<br>| 'center'<br>| 'right'<br>| 'justify'</span> | <spanclass="prop-default">'inherit'</span> | Set the text-align on the table cell content.<br>Monetary or generally number fields **should be right aligned** as that allows you to add them up quickly in your head without having to worry about decimals. |
28
+
| <spanclass="prop-name">align</span> | <spanclass="prop-type">'center'<br>| 'inherit'<br>| 'justify'<br>| 'left'<br>| 'right'</span> | <spanclass="prop-default">'inherit'</span> | Set the text-align on the table cell content.<br>Monetary or generally number fields **should be right aligned** as that allows you to add them up quickly in your head without having to worry about decimals. |
29
29
| <spanclass="prop-name">children</span> | <spanclass="prop-type">node</span> || The table cell contents. |
30
30
| <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. |
31
31
| <spanclass="prop-name">component</span> | <spanclass="prop-type">elementType</span> || The component used for the root node. Either a string to use a DOM element or a component. |
32
-
| <spanclass="prop-name">padding</span> | <spanclass="prop-type">'default'<br>| 'checkbox'<br>| 'none'</span> || Sets the padding applied to the cell. By default, the Table parent component set the value (`default`). |
32
+
| <spanclass="prop-name">padding</span> | <spanclass="prop-type">'checkbox'<br>| 'default'<br>| 'none'</span> || Sets the padding applied to the cell. By default, the Table parent component set the value (`default`). |
33
33
| <spanclass="prop-name">scope</span> | <spanclass="prop-type">string</span> || Set scope attribute. |
34
-
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'small'<br>| 'medium'</span> || Specify the size of the cell. By default, the Table parent component set the value (`medium`). |
34
+
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'medium'<br>| 'small'</span> || Specify the size of the cell. By default, the Table parent component set the value (`medium`). |
35
35
| <spanclass="prop-name">sortDirection</span> | <spanclass="prop-type">'asc'<br>| 'desc'<br>| false</span> || Set aria-sort direction. |
36
-
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'head'<br>| 'body'<br>| 'footer'</span> || Specify the cell type. By default, the TableHead, TableBody or TableFooter parent component set the value. |
36
+
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'body'<br>| 'footer'<br>| 'head'</span> || Specify the cell type. By default, the TableHead, TableBody or TableFooter parent component set the value. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/textarea-autosize.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
24
24
25
25
| Name | Type | Default | Description |
26
26
|:-----|:-----|:--------|:------------|
27
-
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">string<br>| number</span> || Use `rowsMin` instead. The prop will be removed in v5. |
28
-
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">string<br>| number</span> || Maximum number of rows to display. |
29
-
| <spanclass="prop-name">rowsMin</span> | <spanclass="prop-type">string<br>| number</span> | <spanclass="prop-default">1</span> | Minimum number of rows to display. |
27
+
| <spanclass="prop-name">rows</span> | <spanclass="prop-type">number<br>| string</span> || Use `rowsMin` instead. The prop will be removed in v5. |
28
+
| <spanclass="prop-name">rowsMax</span> | <spanclass="prop-type">number<br>| string</span> || Maximum number of rows to display. |
29
+
| <spanclass="prop-name">rowsMin</span> | <spanclass="prop-type">number<br>| string</span> | <spanclass="prop-default">1</span> | Minimum number of rows to display. |
Copy file name to clipboardExpand all lines: docs/pages/api-docs/zoom.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
@@ -28,7 +28,7 @@ It uses [react-transition-group](https://github.com/reactjs/react-transition-gro
28
28
|:-----|:-----|:--------|:------------|
29
29
| <spanclass="prop-name">children</span> | <spanclass="prop-type">element</span> || A single child content element. |
30
30
| <spanclass="prop-name">in</span> | <spanclass="prop-type">bool</span> || If `true`, the component will transition in. |
31
-
| <spanclass="prop-name">timeout</span> | <spanclass="prop-type">number<br>| { enter?: number, exit?: number }</span> | <spanclass="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen,}</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
31
+
| <spanclass="prop-name">timeout</span> | <spanclass="prop-type">number<br>| { appear?: number, enter?: number, exit?: number }</span> | <spanclass="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen,}</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
0 commit comments