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/alert.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
@@ -30,7 +30,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
30
30
| <spanclass="prop-name">closeText</span> | <spanclass="prop-type">string</span> | <spanclass="prop-default">'Close'</span> | Override the default label for the *close popup* icon button.<br>For localization purposes, you can use the provided [translations](/guides/localization/). |
31
31
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'error'<br>| 'info'<br>| 'success'<br>| 'warning'</span> || The main color for the alert. Unless provided, the value is taken from the `severity` prop. |
32
32
| <spanclass="prop-name">icon</span> | <spanclass="prop-type">node</span> || Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the `severity` prop. |
33
-
| <spanclass="prop-name">iconMapping</span> | <spanclass="prop-type">{ error?: node, info?: node, success?: node, warning?: node }</span> |<spanclass="prop-default">{ success: <SuccessOutlinedIcon fontSize="inherit" />, warning: <ReportProblemOutlinedIcon fontSize="inherit" />, error: <ErrorOutlineIcon fontSize="inherit" />, info: <InfoOutlinedIcon fontSize="inherit" />,}</span>| The component maps the `severity` prop to a range of different icons, for instance success to `<SuccessOutlined>`. If you wish to change this mapping, you can provide your own. Alternatively, you can use the `icon` prop to override the icon displayed. |
33
+
| <spanclass="prop-name">iconMapping</span> | <spanclass="prop-type">{ error?: node, info?: node, success?: node, warning?: node }</span> || The component maps the `severity` prop to a range of different icons, for instance success to `<SuccessOutlined>`. If you wish to change this mapping, you can provide your own. Alternatively, you can use the `icon` prop to override the icon displayed. |
34
34
| <spanclass="prop-name">onClose</span> | <spanclass="prop-type">func</span> || Callback fired when the component requests to be closed. When provided and no `action` prop is set, a close icon button is displayed that triggers the callback when clicked.<br><br>**Signature:**<br>`function(event: object) => void`<br>*event:* The event source of the callback. |
35
35
| <spanclass="prop-name">role</span> | <spanclass="prop-type">string</span> | <spanclass="prop-default">'alert'</span> | The ARIA role attribute of the element. |
36
36
| <spanclass="prop-name">severity</span> | <spanclass="prop-type">'error'<br>| 'info'<br>| 'success'<br>| 'warning'</span> | <spanclass="prop-default">'success'</span> | The severity of the alert. This defines the color and icon used. |
Copy file name to clipboardExpand all lines: docs/pages/api/pagination-item.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,8 +31,8 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
31
31
| <spanclass="prop-name">selected</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true` the pagination item is selected. |
32
32
| <spanclass="prop-name">shape</span> | <spanclass="prop-type">'round'<br>| 'rounded'</span> | <spanclass="prop-default">'round'</span> | The shape of the pagination item. |
33
33
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'small'<br>| 'medium'<br>| 'large'</span> | <spanclass="prop-default">'medium'</span> | The size of the pagination item. |
Copy file name to clipboardExpand all lines: docs/pages/api/pagination.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,25 +24,25 @@ 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">boundaryCount</span> | <spanclass="prop-type">number</span> || Number of always visible pages at the beginning and end. |
27
+
| <spanclass="prop-name">boundaryCount</span> | <spanclass="prop-type">number</span> |<spanclass="prop-default">1</span>| Number of always visible pages at the beginning and end. |
| <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. |
30
-
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'default'<br>| 'primary'<br>| 'secondary'</span> || The active color. |
31
-
| <spanclass="prop-name">count</span> | <spanclass="prop-type">number</span> || The total number of pages. |
32
-
| <spanclass="prop-name">defaultPage</span> | <spanclass="prop-type">number</span> || The page selected by default when the component is uncontrolled. |
33
-
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> || If `true`, all the pagination component will be disabled. |
30
+
| <spanclass="prop-name">color</span> | <spanclass="prop-type">'default'<br>| 'primary'<br>| 'secondary'</span> |<spanclass="prop-default">'standard'</span>| The active color. |
31
+
| <spanclass="prop-name">count</span> | <spanclass="prop-type">number</span> |<spanclass="prop-default">1</span>| The total number of pages. |
32
+
| <spanclass="prop-name">defaultPage</span> | <spanclass="prop-type">number</span> |<spanclass="prop-default">1</span>| The page selected by default when the component is uncontrolled. |
33
+
| <spanclass="prop-name">disabled</span> | <spanclass="prop-type">bool</span> |<spanclass="prop-default">false</span>| If `true`, all the pagination component will be disabled. |
34
34
| <spanclass="prop-name">getItemAriaLabel</span> | <spanclass="prop-type">func</span> || Accepts a function which returns a string value that provides a user-friendly name for the current page.<br>For localization purposes, you can use the provided [translations](/guides/localization/).<br><br>**Signature:**<br>`function(type?: string, page: number, selected: bool) => string`<br>*type:* The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous').<br>*page:* The page number to format.<br>*selected:* If true, the current page is selected. |
35
-
| <spanclass="prop-name">hideNextButton</span> | <spanclass="prop-type">bool</span> || If `true`, hide the next-page button. |
36
-
| <spanclass="prop-name">hidePrevButton</span> | <spanclass="prop-type">bool</span> || If `true`, hide the previous-page button. |
35
+
| <spanclass="prop-name">hideNextButton</span> | <spanclass="prop-type">bool</span> |<spanclass="prop-default">false</span>| If `true`, hide the next-page button. |
36
+
| <spanclass="prop-name">hidePrevButton</span> | <spanclass="prop-type">bool</span> |<spanclass="prop-default">false</span>| If `true`, hide the previous-page button. |
37
37
| <spanclass="prop-name">onChange</span> | <spanclass="prop-type">func</span> || Callback fired when the page is changed.<br><br>**Signature:**<br>`function(event: object, page: number) => void`<br>*event:* The event source of the callback.<br>*page:* The page selected. |
38
38
| <spanclass="prop-name">page</span> | <spanclass="prop-type">number</span> || The current page. |
| <spanclass="prop-name">shape</span> | <spanclass="prop-type">'round'<br>| 'rounded'</span> || The shape of the pagination items. |
41
-
| <spanclass="prop-name">showFirstButton</span> | <spanclass="prop-type">bool</span> || If `true`, show the first-page button. |
42
-
| <spanclass="prop-name">showLastButton</span> | <spanclass="prop-type">bool</span> || If `true`, show the last-page button. |
43
-
| <spanclass="prop-name">siblingRange</span> | <spanclass="prop-type">number</span> || Number of always visible pages before and after the current page. |
44
-
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'small'<br>| 'medium'<br>| 'large'</span> || The size of the pagination component. |
45
-
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'text'<br>| 'outlined'</span> || The variant to use. |
39
+
| <spanclass="prop-name">renderItem</span> | <spanclass="prop-type">func</span> |<spanclass="prop-default">item => <PaginationItem {...item} /></span> | Render the item.<br><br>**Signature:**<br>`function(params: object) => ReactNode`<br>*params:*The props to spread on a PaginationItem.|
40
+
| <spanclass="prop-name">shape</span> | <spanclass="prop-type">'round'<br>| 'rounded'</span> |<spanclass="prop-default">'round'</span>| The shape of the pagination items. |
41
+
| <spanclass="prop-name">showFirstButton</span> | <spanclass="prop-type">bool</span> |<spanclass="prop-default">false</span>| If `true`, show the first-page button. |
42
+
| <spanclass="prop-name">showLastButton</span> | <spanclass="prop-type">bool</span> |<spanclass="prop-default">false</span>| If `true`, show the last-page button. |
43
+
| <spanclass="prop-name">siblingCount</span> | <spanclass="prop-type">number</span> |<spanclass="prop-default">1</span>| Number of always visible pages before and after the current page. |
44
+
| <spanclass="prop-name">size</span> | <spanclass="prop-type">'small'<br>| 'medium'<br>| 'large'</span> |<spanclass="prop-default">'medium'</span>| The size of the pagination component. |
45
+
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'text'<br>| 'outlined'</span> |<spanclass="prop-default">'text'</span>| The variant to use. |
0 commit comments