Skip to content

Commit 5016bc1

Browse files
committed
docs: update API documentation
1 parent 44f24f9 commit 5016bc1

File tree

4 files changed

+28
-26
lines changed

4 files changed

+28
-26
lines changed

packages/coreui-vue/src/components/offcanvas/COffcanvas.ts

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ const COffcanvas = defineComponent({
5050
* Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down.
5151
*
5252
* @values boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
53+
* @since 4.7.0
5354
*/
5455
responsive: {
5556
type: [Boolean, String],

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import CModal from '@coreui/vue/src/components/modal/CModal'
1111
| Prop name | Description | Type | Values | Default |
1212
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
1313
| **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 | `'static'` | true |
14+
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
1515
| **content-class-name** | A string of all className you want applied to the modal content component. | string | - | - |
1616
| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
1717
| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |

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

+8-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ import COffcanvas from '@coreui/vue/src/components/offcanvas/COffcanvas'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------- | --------------------------------------------------- | ------- | --------------------------------------- | ------- |
13-
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean | - | true |
14-
| **keyboard** | Closes the offcanvas when escape key is pressed. | boolean | - | true |
15-
| **placement** | Components placement, there’s no default placement. | string | `'start'`, `'end'`, `'top'`, `'bottom'` | - |
16-
| **scroll** | Allow body scrolling while offcanvas is open | boolean | - | false |
17-
| **visible** | Toggle the visibility of offcanvas component. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
13+
| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
14+
| **keyboard** | Closes the offcanvas when escape key is pressed. | boolean | - | true |
15+
| **placement** | Components placement, there’s no default placement. | string | `'start'`, `'end'`, `'top'`, `'bottom'` | - |
16+
| **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 |
17+
| **scroll** | Allow body scrolling while offcanvas is open | boolean | - | false |
18+
| **visible** | Toggle the visibility of offcanvas component. | boolean | - | |
1819

1920
#### Events
2021

0 commit comments

Comments
 (0)