Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit ccd2cc5

Browse filesBrowse files
committed
docs: update API documentation
1 parent b532859 commit ccd2cc5
Copy full SHA for ccd2cc5

File tree

Expand file treeCollapse file tree

4 files changed

+12
-7
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+12
-7
lines changed

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

Copy file name to clipboardExpand all lines: docs/api/modal/CModal.api.md
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import CModal from '@coreui/vue/src/components/modal/CModal'
1515
| **className** | A string of all className you want applied to the modal content component.<br>TODO: Consider if we should change this prop name to describe better its role. | 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 |
18-
| **dismiss** | Does the modal dialog itself scroll, or does the whole dialog scroll within the window. | boolean | - | false |
1918
| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | |
2019
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
2120
| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |

‎docs/api/tabs/CTabContent.api.md

Copy file name to clipboard
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
### CNavGroupItems
1+
### CTabContent
22

33
```jsx
4-
import { CNavGroupItems } from '@coreui/vue'
4+
import { CTabContent } from '@coreui/vue'
55
// or
6-
import CNavGroupItems from '@coreui/vue/src/components/tabs/CTabContent'
6+
import CTabContent from '@coreui/vue/src/components/tabs/CTabContent'
77
```

‎docs/api/toast/CToastClose.api.md

Copy file name to clipboardExpand all lines: docs/api/toast/CToastClose.api.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ import CToastClose from '@coreui/vue/src/components/toast/CToastClose'
1414

1515
#### Events
1616

17-
| Event name | Description | Properties |
18-
| ----------- | ------------------------------------------------------- | ---------- |
19-
| **dismiss** | Event called before the dissmiss animation has started. |
17+
| Event name | Description | Properties |
18+
| ---------- | ------------------------------------------------------- | ---------- |
19+
| **close** | Event called before the dissmiss animation has started. |

‎docs/api/toast/CToastHeader.api.md

Copy file name to clipboardExpand all lines: docs/api/toast/CToastHeader.api.md
+6Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,9 @@ import CToastHeader from '@coreui/vue/src/components/toast/CToastHeader'
1111
| Prop name | Description | Type | Values | Default |
1212
| --------------- | ----------------------------------------------- | ------- | ------ | ------- |
1313
| **closeButton** | Automatically add a close button to the header. | boolean | - | |
14+
15+
#### Events
16+
17+
| Event name | Description | Properties |
18+
| ---------- | --------------------------------------------- | ---------- |
19+
| **close** | Event called after clicking the close button. |

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.