Skip to content

Commit 3a7e2b2

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 3606a69 commit 3a7e2b2

File tree

15 files changed

+72
-45
lines changed

15 files changed

+72
-45
lines changed

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

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

1212
#### Events
1313

14-
| Event name | Properties | Description |
15-
| -------------------- | ---------- | ------------------------------------------------------- |
16-
| <code>dismiss</code> | | Event called before the dissmiss animation has started. |
14+
| Event name | Properties | Description |
15+
| ------------------ | ---------- | -------------------------------------------------------- |
16+
| <code>close</code> | | Callback fired when the component requests to be closed. |
1717

1818
---

‎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'`, `'text-high-emphasis'`, `'text-high-medium'`, `'text-disabled'`, `'text-high-emphasis-inverse'`, `'text-high-medium-inverse'`, `'text-disabled-inverse'` | |
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'` | |
1313

1414
---

‎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'`, `'text-high-emphasis'`, `'text-high-medium'`, `'text-disabled'`, `'text-high-emphasis-inverse'`, `'text-high-medium-inverse'`, `'text-disabled-inverse'` | |
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'` | |
1313

1414
---

‎docs/api/card/CCard.api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
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>textColor</code> | Sets the text color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'text-high-emphasis'`, `'text-high-medium'`, `'text-disabled'`, `'text-high-emphasis-inverse'`, `'text-high-medium-inverse'`, `'text-disabled-inverse'` | |
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>textColor</code> | Sets the text color context 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'` | |
99

1010
---

‎docs/api/collapse/CCollapse.api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,11 @@
66
| -------------------- | ----------------------------------- | ------- | ------ | ------- |
77
| <code>visible</code> | Toggle the visibility of component. | boolean | - | |
88

9+
#### Events
10+
11+
| Event name | Properties | Description |
12+
| ----------------- | ---------- | -------------------------------------------------------- |
13+
| <code>hide</code> | | Callback fired when the component requests to be hidden. |
14+
| <code>show</code> | | Callback fired when the component requests to be shown. |
15+
916
---

‎docs/api/dropdown/CDropdown.api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,11 @@
1414
| <code>variant</code> | Set the dropdown variant to an btn-group, dropdown, input-group, and nav-item. | string | `'btn-group'`, `'dropdown'`, `'input-group'`, `'nav-item'` | 'btn-group' |
1515
| <code>visible</code> | Toggle the visibility of dropdown menu component. | boolean | - | |
1616

17+
#### Events
18+
19+
| Event name | Properties | Description |
20+
| ----------------- | ---------- | -------------------------------------------------------- |
21+
| <code>hide</code> | | Callback fired when the component requests to be hidden. |
22+
| <code>show</code> | | Callback fired when the component requests to be shown. |
23+
1724
---

‎docs/api/modal/CModal.api.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@
1717

1818
#### Events
1919

20-
| Event name | Properties | Description |
21-
| -------------------- | ---------- | ------------------------------------------------------- |
22-
| <code>dismiss</code> | | Event called before the dissmiss animation has started. |
20+
| Event name | Properties | Description |
21+
| ---------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22+
| <code>close</code> | | Callback fired when the component requests to be closed. |
23+
| <code>close-prevented</code> | | Callback fired when the component requests to be closed. |
24+
| <code>show</code> | | Callback fired when the modal is shown, its backdrop is static and a click outside the modal or an escape key press is performed with the keyboard option set to false. |
2325

2426
---

0 commit comments

Comments
 (0)