Skip to content

Commit 9f7f1cc

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 8567ccb commit 9f7f1cc

File tree

86 files changed

+487
-487
lines changed

Some content is hidden

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

86 files changed

+487
-487
lines changed

‎docs/api/accordion/CAccordion.api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
7-
| <code>activeItemKey</code> | The active item key. | number\|string | - | - |
8-
| <code>alwaysOpen</code> | Make accordion items stay open when another item is opened | boolean | - | |
9-
| <code>flush</code> | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | boolean | - | |
5+
| Prop name | Description | Type | Values | Default |
6+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
7+
| **activeItemKey** | The active item key. | number\|string | - | - |
8+
| **alwaysOpen** | Make accordion items stay open when another item is opened | boolean | - | |
9+
| **flush** | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | boolean | - | |
1010

1111
---

‎docs/api/accordion/CAccordionCollapse.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| -------------------- | ----------------------------------- | ------- | ------ | ------- |
7-
| <code>visible</code> | Toggle the visibility of component. | boolean | - | |
5+
| Prop name | Description | Type | Values | Default |
6+
| ----------- | ----------------------------------- | ------- | ------ | ------- |
7+
| **visible** | Toggle the visibility of component. | boolean | - | |
88

99
---

‎docs/api/accordion/CAccordionItem.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| -------------------- | ------------- | -------------- | ------ | ------- |
7-
| <code>itemKey</code> | The item key. | number\|string | - | - |
5+
| Prop name | Description | Type | Values | Default |
6+
| ----------- | ------------- | -------------- | ------ | ------- |
7+
| **itemKey** | The item key. | number\|string | - | - |
88

99
---

‎docs/api/alert/CAlert.api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| ------------------------ | ------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | ------- |
7-
| <code>color</code> | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8-
| <code>dismissible</code> | Optionally add a close button to alert and allow it to self dismisss. | boolean | - | false |
9-
| <code>variant</code> | Set the alert variant to a solid. | string | `'solid'` | - |
10-
| <code>visible</code> | Toggle the visibility of alert component. | boolean | - | true |
5+
| Prop name | Description | Type | Values | Default |
6+
| --------------- | ------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | ------- |
7+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8+
| **dismissible** | Optionally add a close button to alert and allow it to self dismisss. | boolean | - | false |
9+
| **variant** | Set the alert variant to a solid. | string | `'solid'` | - |
10+
| **visible** | Toggle the visibility of alert component. | boolean | - | true |
1111

1212
#### Events
1313

14-
| Event name | Properties | Description |
15-
| ------------------ | ---------- | -------------------------------------------------------- |
16-
| <code>close</code> | | Callback fired when the component requests to be closed. |
14+
| Event name | Description | Properties |
15+
| ---------- | -------------------------------------------------------- | ---------- |
16+
| **close** | Callback fired when the component requests to be closed. |
1717

1818
---

‎docs/api/alert/CAlertHeading.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| ---------------------- | --------------------------------------------------------------------------------------- | ------ | ------ | ------- |
7-
| <code>component</code> | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'h4' |
5+
| Prop name | Description | Type | Values | Default |
6+
| ------------- | --------------------------------------------------------------------------------------- | ------ | ------ | ------- |
7+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'h4' |
88

99
---

‎docs/api/avatar/CAvatar.api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| ---------------------- | -------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
7-
| <code>color</code> | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8-
| <code>shape</code> | Select the shape of the component. | string | `'rounded'`, `'rounded-top'`, `'rounded-end'`, `'rounded-bottom'`, `'rounded-start'`, `'rounded-circle'`, `'rounded-pill'`, `'rounded-0'`, `'rounded-1'`, `'rounded-2'`, `'rounded-3'` | |
9-
| <code>size</code> | Size the component small, large, or extra large. | string | `'sm'`, `'md'`, `'lg'`, `'xl'` | - |
10-
| <code>src</code> | The src attribute for the img element. | string | - | - |
11-
| <code>status</code> | Sets the color context of the status indicator to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
12-
| <code>textColor</code> | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |
5+
| Prop name | Description | Type | Values | Default |
6+
| ------------- | -------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
7+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8+
| **shape** | Select the shape of the component. | string | `'rounded'`, `'rounded-top'`, `'rounded-end'`, `'rounded-bottom'`, `'rounded-start'`, `'rounded-circle'`, `'rounded-pill'`, `'rounded-0'`, `'rounded-1'`, `'rounded-2'`, `'rounded-3'` | |
9+
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'md'`, `'lg'`, `'xl'` | - |
10+
| **src** | The src attribute for the img element. | string | - | - |
11+
| **status** | Sets the color context of the status indicator to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
12+
| **textColor** | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |
1313

1414
---

‎docs/api/backdrop/CBackdrop.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| -------------------- | ----------------------------------------- | ------- | ------ | ------- |
7-
| <code>visible</code> | Toggle the visibility of modal component. | boolean | - | false |
5+
| Prop name | Description | Type | Values | Default |
6+
| ----------- | ----------------------------------------- | ------- | ------ | ------- |
7+
| **visible** | Toggle the visibility of modal component. | boolean | - | false |
88

99
---

‎docs/api/badge/CBadge.api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
#### Props
44

5-
| Prop name | Description | Type | Values | Default |
6-
| ---------------------- | --------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
7-
| <code>color</code> | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8-
| <code>component</code> | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'span' |
9-
| <code>position</code> | Position badge in one of the corners of a link or button. | string | `'top-start'`, `'top-end'`, `'bottom-end'`, `'botttom-start'` | - |
10-
| <code>shape</code> | Select the shape of the component. | string | `'rounded'`, `'rounded-top'`, `'rounded-end'`, `'rounded-bottom'`, `'rounded-start'`, `'rounded-circle'`, `'rounded-pill'`, `'rounded-0'`, `'rounded-1'`, `'rounded-2'`, `'rounded-3'` | |
11-
| <code>size</code> | Size the component small. | string | `'sm'` | - |
12-
| <code>textColor</code> | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |
5+
| Prop name | Description | Type | Values | Default |
6+
| ------------- | --------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
7+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
8+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'span' |
9+
| **position** | Position badge in one of the corners of a link or button. | string | `'top-start'`, `'top-end'`, `'bottom-end'`, `'botttom-start'` | - |
10+
| **shape** | Select the shape of the component. | string | `'rounded'`, `'rounded-top'`, `'rounded-end'`, `'rounded-bottom'`, `'rounded-start'`, `'rounded-circle'`, `'rounded-pill'`, `'rounded-0'`, `'rounded-1'`, `'rounded-2'`, `'rounded-3'` | |
11+
| **size** | Size the component small. | string | `'sm'` | - |
12+
| **textColor** | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |
1313

1414
---

0 commit comments

Comments
 (0)