Skip to content

Commit 5ea05a1

Browse files
mrholekmrholek
committed
docs: update layout and content
1 parent 702da37 commit 5ea05a1

File tree

139 files changed

+1553
-262
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

139 files changed

+1553
-262
lines changed

‎docs/4.0/api/CAccordion.api.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
2+
```jsx
3+
import { CAccordion } from '@coreui/react'
4+
// or
5+
import CAccordion from '@coreui/react/src/components/accordion/CAccordion'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
3-
| **activeItemKey** | The active item key. | `string | number` | undefined |
10+
| **activeItemKey** | The active item key. | `string` \| `number` | - |
411
| **alwaysOpen** | Make accordion items stay open when another item is opened | `boolean` | false |
512
| **className** | A string of all className you want applied to the base component. | `string` | - |
613
| **flush** | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | `boolean` | - |

‎docs/4.0/api/CAccordionBody.api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2+
```jsx
3+
import { CAccordionBody } from '@coreui/react'
4+
// or
5+
import CAccordionBody from '@coreui/react/src/components/accordion/CAccordionBody'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |

‎docs/4.0/api/CAccordionButton.api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2+
```jsx
3+
import { CAccordionButton } from '@coreui/react'
4+
// or
5+
import CAccordionButton from '@coreui/react/src/components/accordion/CAccordionButton'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |

‎docs/4.0/api/CAccordionCollapse.api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2+
```jsx
3+
import { CAccordionCollapse } from '@coreui/react'
4+
// or
5+
import CAccordionCollapse from '@coreui/react/src/components/accordion/CAccordionCollapse'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |

‎docs/4.0/api/CAccordionHeader.api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2+
```jsx
3+
import { CAccordionHeader } from '@coreui/react'
4+
// or
5+
import CAccordionHeader from '@coreui/react/src/components/accordion/CAccordionHeader'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |

‎docs/4.0/api/CAccordionItem.api.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1+
2+
```jsx
3+
import { CAccordionItem } from '@coreui/react'
4+
// or
5+
import CAccordionItem from '@coreui/react/src/components/accordion/CAccordionItem'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |
4-
| **itemKey** | Item key. | `string | number` | - |
11+
| **itemKey** | Item key. | `string` \| `number` | - |

‎docs/4.0/api/CAlert.api.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1+
2+
```jsx
3+
import { CAlert } from '@coreui/react'
4+
// or
5+
import CAlert from '@coreui/react/src/components/alert/CAlert'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the component. | `string` | - |
4-
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `{'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string }` | primary |
11+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | primary |
512
| **dismissible** | Optionally add a close button to alert and allow it to self dismiss. | `boolean` | - |
613
| **onDismiss** | Method called before the dissmiss animation has started. | `() => void` | - |
714
| **onDismissed** | Method called after the dissmiss animation has completed and the component is removed from the dom. | `() => void` | - |

‎docs/4.0/api/CAlertHeading.api.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1+
2+
```jsx
3+
import { CAlertHeading } from '@coreui/react'
4+
// or
5+
import CAlertHeading from '@coreui/react/src/components/alert/CAlertHeading'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |
4-
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | `string | ComponentClass<any, any> | FunctionComponent<any>` | 'h4' |
11+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | `string` \| `ComponentClass<any, any>` \| `FunctionComponent<any>` | - |

‎docs/4.0/api/CAlertLink.api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2+
```jsx
3+
import { CAlertLink } from '@coreui/react'
4+
// or
5+
import CAlertLink from '@coreui/react/src/components/alert/CAlertLink'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the base component. | `string` | - |

‎docs/4.0/api/CAvatar.api.mdx‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1+
2+
```jsx
3+
import { CAvatar } from '@coreui/react'
4+
// or
5+
import CAvatar from '@coreui/react/src/components/avatar/CAvatar'
6+
```
7+
18
| Property | Description | Type | Default |
29
| --- | --- | --- | --- |
310
| **className** | A string of all className you want applied to the component. | `string` | - |
4-
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `{'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}` | - |
5-
| **shape** | Select the shape of the component. | `{'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string}` | - |
11+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
12+
| **shape** | Select the shape of the component. | `'rounded'` \| `'rounded-top'` \| `'rounded-end'` \| `'rounded-bottom'` \| `'rounded-start'` \| `'rounded-circle'` \| `'rounded-pill'` \| `'rounded-0'` \| `'rounded-1'` \| `'rounded-2'` \| `'rounded-3'` \| `string` | - |
613
| **size** | Size the component small, large, or extra large. | `string` | - |
714
| **src** | The src attribute for the img element. | `string` | - |
8-
| **status** | Sets the color context of the status indicator to one of CoreUI’s themed colors. | `{'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}` | - |
9-
| **textColor** | Sets the text color of the component to one of CoreUI’s themed colors. | `'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'white' | 'muted' | string` | - |
15+
| **status** | Sets the color context of the status indicator to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
16+
| **textColor** | Sets the text color of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `'white'` \| `'muted'` \| `'high-emphasis'` \| `'medium-emphasis'` \| `'disabled'` \| `'high-emphasis-inverse'` \| `'medium-emphasis-inverse'` \| `'disabled-inverse'` \| `string` | - |

0 commit comments

Comments
 (0)