Skip to content

Commit 6a6f8e4

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 6ebed89 commit 6a6f8e4

File tree

7 files changed

+39
-24
lines changed

7 files changed

+39
-24
lines changed

‎packages/docs/api/close-button/CCloseButton.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import CCloseButton from '@coreui/vue/src/components/close-button/CCloseButton'
1010

1111
| Prop name | Description | Type | Values | Default |
1212
| ------------ | -------------------------------------------- | ------- | ------ | ------- |
13+
| **dark** | Invert the default color. | boolean | - | - |
1314
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
1415
| **white** | Change the default color to white. | boolean | - | - |
1516

‎packages/docs/api/form/CFormCheck.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import CFormCheck from '@coreui/vue/src/components/form/CFormCheck'
1111
| Prop name | Description | Type | Values | Default |
1212
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------- | ---------- |
1313
| **button** | Create button-like checkboxes and radio buttons.<br/>`@see` http://coreui.io/vue/docs/components/button.html | object | - | - |
14-
| **false-value** <br><div class="badge bg-primary">4.9.0+</div> | Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `false` state. | string | - | - |
14+
| **false-value** <br><div class="badge bg-primary">4.10.0+</div> | Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `false` state. | string | - | - |
1515
| **feedback** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | - |
1616
| **feedback-invalid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | - |
1717
| **feedback-valid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | - |
@@ -24,7 +24,7 @@ import CFormCheck from '@coreui/vue/src/components/form/CFormCheck'
2424
| **model-value** | The default name for a value passed using v-model. | array\|boolean\|string | - | - |
2525
| **reverse** <br><div class="badge bg-primary">4.8.0+</div> | Put checkboxes or radios on the opposite side. | boolean | - | - |
2626
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip. | boolean | - | - |
27-
| **true-value** <br><div class="badge bg-primary">4.9.0+</div> | Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `true` state. | string | - | - |
27+
| **true-value** <br><div class="badge bg-primary">4.10.0+</div> | Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `true` state. | string | - | - |
2828
| **type** | Specifies the type of component. | string | `'checkbox'`, `'radio'` | 'checkbox' |
2929
| **valid** | Set component validation state to valid. | boolean | - | - |
3030
| **value** | The value attribute of component. | string | - | - |

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +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 | - | - |
16-
| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
17-
| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |
18-
| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | - |
19-
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
20-
| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |
21-
| **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 |
22-
| **visible** | Toggle the visibility of alert component. | boolean | - | - |
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 | - | - |
16+
| **focus** <br><div class="badge bg-primary">v5.0.0-alpha.1+</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 | - | - |
2324

2425
#### Events
2526

‎packages/docs/api/nav/CNav.api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import CNav from '@coreui/vue/src/components/nav/CNav'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------- | --------------------------------------------------------------------------------------- | ------ | ----------------------- | ------- |
13-
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'ul' |
14-
| **layout** | Specify a layout type for component. | string | `'fill'`, `'justified'` | - |
15-
| **variant** | Set the nav variant to tabs or pills. | string | `'tabs'`, `'pills'` | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------- | --------------------------------------------------------------------------------------- | ------ | -------------------------------------------------------- | ------- |
13+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'ul' |
14+
| **layout** | Specify a layout type for component. | string | `'fill'`, `'justified'` | - |
15+
| **variant** | Set the nav variant to tabs or pills. | string | `'pills'`, `'tabs'`, `'underline'`, `'underline-border'` | - |

‎packages/docs/api/offcanvas/COffcanvas.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import COffcanvas from '@coreui/vue/src/components/offcanvas/COffcanvas'
1111
| Prop name | Description | Type | Values | Default |
1212
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
1313
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
14+
| **dark** | Sets a darker color scheme. | boolean | - | - |
1415
| **keyboard** | Closes the offcanvas when escape key is pressed. | boolean | - | true |
1516
| **placement** | Components placement, there’s no default placement. | string | `'start'`, `'end'`, `'top'`, `'bottom'` | - |
1617
| **responsive** <br><div class="badge bg-primary">4.7.0+</div> | Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down. | boolean\|string | `boolean \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'xxl'` | true |

‎packages/docs/api/progress/CProgress.api.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,13 @@ import CProgress from '@coreui/vue/src/components/progress/CProgress'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ---------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ------- |
13-
| **height** | Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly. | number | - | - |
14-
| **thin** | Makes progress bar thinner. | boolean | - | - |
15-
| **white** | Change the default color to white. | boolean | - | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | ------- |
13+
| **animated** | Use to animate the stripes right to left via CSS3 animations. | boolean | - | - |
14+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
15+
| **height** | Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly. | number | - | - |
16+
| **progress-bar-class-name** <br><div class="badge bg-primary">5.0.0-alpha.1+</div> | A string of all className you want applied to the <CProgressBar/> component. | string | - | - |
17+
| **thin** | Makes progress bar thinner. | boolean | - | - |
18+
| **value** | The percent to progress the ProgressBar. | number | - | 0 |
19+
| **variant** | Set the progress bar variant to optional striped. | string | `'striped'` | - |
20+
| **white** | Change the default color to white. | boolean | - | - |

‎packages/docs/api/progress/CProgressStacked.api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### CProgressStacked
2+
3+
```jsx
4+
import { CProgressStacked } from '@coreui/vue'
5+
// or
6+
import CProgressStacked from '@coreui/vue/src/components/progress/CProgressStacked'
7+
```

0 commit comments

Comments
 (0)