Skip to content

Commit 312b159

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 90133b4 commit 312b159

File tree

3 files changed

+32
-32
lines changed

3 files changed

+32
-32
lines changed

‎packages/docs/api/dropdown/CDropdownToggle.api.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ import CDropdownToggle from '@coreui/vue/src/components/dropdown/CDropdownToggle
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | -------- |
13-
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
14-
| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
15-
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
16-
| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
17-
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | -------- |
13+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
14+
| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
15+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
16+
| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
17+
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
1818
| **nav-link** <br><div class="badge bg-primary">v5.0.0-beta.0+</div> | If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | boolean | - | true |
19-
| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
20-
| **split** | Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of `.dropdown-toggle-split` className for proper spacing around the dropdown caret. | boolean | - | - |
21-
| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.<br/>`@type` 'hover' \| 'focus' \| 'click' | Triggers | - | 'click' |
22-
| **variant** | Set the button variant to an outlined button or a ghost button. | string | `'ghost'`, `'outline'` | - |
19+
| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
20+
| **split** | Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of `.dropdown-toggle-split` className for proper spacing around the dropdown caret. | boolean | - | - |
21+
| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.<br/>`@type` 'hover' \| 'focus' \| 'click' | Triggers | - | 'click' |
22+
| **variant** | Set the button variant to an outlined button or a ghost button. | string | `'ghost'`, `'outline'` | - |

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ import CModal from '@coreui/vue/src/components/modal/CModal'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
13-
| **alignment** | Align the modal in the center or top of the screen. | string | `'top'`, `'center'` | 'top' |
14-
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
15-
| **content-class-name** | A string of all className you want applied to the modal content component. | string | - | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
13+
| **alignment** | Align the modal in the center or top of the screen. | string | `'top'`, `'center'` | 'top' |
14+
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
15+
| **content-class-name** | A string of all className you want applied to the modal content component. | string | - | - |
1616
| **focus** <br><div class="badge bg-primary">v5.0.0-beta.0+</div> | Puts the focus on the modal when shown. | boolean | - | true |
17-
| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
18-
| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |
19-
| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | - |
20-
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
21-
| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |
22-
| **unmount-on-close** | By default the component is unmounted after close animation, if you want to keep the component mounted set this property to false. | boolean | - | true |
23-
| **visible** | Toggle the visibility of alert component. | boolean | - | - |
17+
| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
18+
| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |
19+
| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | - |
20+
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
21+
| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |
22+
| **unmount-on-close** | By default the component is unmounted after close animation, if you want to keep the component mounted set this property to false. | boolean | - | true |
23+
| **visible** | Toggle the visibility of alert component. | boolean | - | - |
2424

2525
#### Events
2626

0 commit comments

Comments
 (0)