+ To use this component you must have a CoreUI PRO license. Buy the
+ CoreUI PRO
+ and get access to all PRO components, features, templates, and dedicated support.
+
+
+
+
Support CoreUI Development
+
+ CoreUI is an MIT-licensed open source project and is completely free to use. However, the
+ amount of effort needed to maintain and develop new features for the project is not
+ sustainable without proper financial backing.
+
+
You can support our Open Source software development in the following ways:
+
+
+ Buy the
+ CoreUI PRO,
+ and get access to PRO components, and dedicated support.
+
+
+ Became a sponsor, and get
+ your logo on BACKERS.md/README.md files or each site of this documentation
+
- To use this component you must have a CoreUI PRO license. Buy the
- CoreUI PRO
- and get access to all PRO components, features, templates, and dedicated support.
-
-
-
-
Support CoreUI Development
-
- CoreUI is an MIT-licensed open source project and is completely free to use. However, the
- amount of effort needed to maintain and develop new features for the project is not
- sustainable without proper financial backing.
-
-
You can support our Open Source software development in the following ways:
-
-
- Buy the
- CoreUI PRO,
- and get access to PRO components, and dedicated support.
-
-
- Became a sponsor, and get
- your logo on BACKERS.md/README.md files or each site of this documentation
-
-
-
-
diff --git a/packages/docs/.vuepress/theme-coreui/src/client/styles/_layout.scss b/packages/docs/.vuepress/theme-coreui/src/client/styles/_layout.scss
deleted file mode 100644
index 284eae98..00000000
--- a/packages/docs/.vuepress/theme-coreui/src/client/styles/_layout.scss
+++ /dev/null
@@ -1,6 +0,0 @@
-.wrapper {
- width: 100%;
- @include ltr-rtl("padding-left", var(--cui-sidebar-occupy-start, 0));
- will-change: auto;
- @include transition(padding .15s);
-}
\ No newline at end of file
diff --git a/packages/docs/.vuepress/theme-coreui/src/client/styles/_toc.scss b/packages/docs/.vuepress/theme-coreui/src/client/styles/_toc.scss
deleted file mode 100644
index fc1f0fee..00000000
--- a/packages/docs/.vuepress/theme-coreui/src/client/styles/_toc.scss
+++ /dev/null
@@ -1,40 +0,0 @@
-.docs-toc {
- @include media-breakpoint-up(lg) {
- position: sticky;
- top: 5rem;
- right: 0;
- z-index: 2;
- height: subtract(100vh, 7rem);
- overflow-y: auto;
- }
-
- nav {
- @include font-size(.875rem);
-
- ul {
- padding-left: 0;
- list-style: none;
-
- ul {
- padding-left: 1rem;
- margin-top: .25rem;
- }
- }
-
- li {
- margin-bottom: .25rem;
- }
-
- a {
- color: inherit;
-
- &:not(:hover) {
- text-decoration: none;
- }
-
- code {
- font: inherit;
- }
- }
- }
-}
\ No newline at end of file
diff --git a/packages/docs/.vuepress/theme-coreui/src/node/defaultTheme.ts b/packages/docs/.vuepress/theme-coreui/src/node/defaultTheme.ts
deleted file mode 100755
index 0886fd22..00000000
--- a/packages/docs/.vuepress/theme-coreui/src/node/defaultTheme.ts
+++ /dev/null
@@ -1,89 +0,0 @@
-import type { Page, Theme } from '@vuepress/core'
-import { activeHeaderLinksPlugin } from '@vuepress/plugin-active-header-links'
-import { backToTopPlugin } from '@vuepress/plugin-back-to-top'
-import { prismjsPlugin } from '@vuepress/plugin-prismjs'
-import { themeDataPlugin } from '@vuepress/plugin-theme-data'
-import { fs, getDirname, path } from '@vuepress/utils'
-import type { DefaultThemeLocaleOptions, DefaultThemePluginsOptions } from '../shared'
-import { assignDefaultLocaleOptions } from './utils'
-
-const __dirname = getDirname(import.meta.url)
-
-export interface DefaultThemeOptions extends DefaultThemeLocaleOptions {
- /**
- * To avoid confusion with the root `plugins` option,
- * we use `themePlugins`
- */
- themePlugins?: DefaultThemePluginsOptions
-}
-export const defaultTheme = ({
- themePlugins = {},
- ...localeOptions
-}: DefaultThemeOptions = {}): Theme => {
- assignDefaultLocaleOptions(localeOptions)
-
- return {
- name: '@vuepress/coreui-docs-theme',
-
- templateBuild: path.resolve(__dirname, '../../templates/build.html'),
-
- alias: {
- // use alias to make all components replaceable
- ...Object.fromEntries(
- fs
- .readdirSync(path.resolve(__dirname, '../client/components'))
- .filter((file) => file.endsWith('.vue'))
- .map((file) => [`@theme/${file}`, path.resolve(__dirname, '../client/components', file)]),
- ),
- },
-
- clientConfigFile: path.resolve(__dirname, '../client/config.ts'),
-
- extendsPage: (page: Page>) => {
- // save relative file path into page data to generate edit link
- page.data.filePathRelative = page.filePathRelative
- // save title into route meta to generate navbar and sidebar
- page.routeMeta.title = page.title
- },
-
- // layouts: path.resolve(__dirname, '../client/layouts'),
-
- // clientAppEnhanceFiles: path.resolve(__dirname, '../client/clientAppEnhance.ts'),
-
- // clientAppSetupFiles: path.resolve(__dirname, '../client/clientAppSetup.ts'),
-
- // // use the relative file path to generate edit link
- // extendsPageData: ({ filePathRelative }) => ({ filePathRelative }),
-
- plugins: [
- // @vuepress/plugin-active-header-link
- themePlugins.activeHeaderLinks !== false
- ? activeHeaderLinksPlugin({
- headerLinkSelector: 'a.sidebar-item',
- headerAnchorSelector: '.header-anchor',
- // should greater than page transition duration
- delay: 300,
- })
- : [],
-
- // @vuepress/plugin-back-to-top
- themePlugins.backToTop !== false ? backToTopPlugin() : [],
-
- // @vuepress/plugin-prismjs
- themePlugins.prismjs !== false ? prismjsPlugin() : [],
-
- // @vuepress/plugin-theme-data
- themeDataPlugin({ themeData: localeOptions }),
- // [
- // '@vuepress/active-header-links',
- // {
- // headerLinkSelector: 'a.sidebar-item',
- // headerAnchorSelector: '.anchor-link',
- // },
- // ],
- // ['@vuepress/back-to-top', themePlugins.backToTop !== false],
- // ['@vuepress/prismjs', themePlugins.prismjs !== false],
- // ['@vuepress/theme-data', { themeData: localeOptions }],
- ],
- }
-}
diff --git a/packages/docs/README.md b/packages/docs/README.md
deleted file mode 100644
index 54e0c48e..00000000
--- a/packages/docs/README.md
+++ /dev/null
@@ -1,80 +0,0 @@
----
-layout: Redirect
-lang: en-US
-title: Title of this page
-description: Description of this page
----
-### Components:
-
-[ CAccordion ](./4.0/components/accordion.md)
-
-[ CAlert ](./4.0/components/alert.md)
-
-[ CAvatar ](./4.0/components/avatar.md)
-
-[ CBackdrop ](./4.0/components/backdrop.md)
-
-[ CBadge ](./4.0/components/badge.md)
-
-[ CBreadcrumb ](./4.0/components/breadcrumb.md)
-
-[ CButton ](./4.0/components/button.md)
-
-[ CButtonGroup ](./4.0/components/button-group.md)
-
-[ CCallout ](./4.0/components/callout.md)
-
-[ CCard ](./4.0/components/card.md)
-
-[ CCollapse ](./4.0/components/collapse.md)
-
-[ CDropdown ](./4.0/components/dropdown.md)
-
-[ CDropdown ](./4.0/components/dropdown.md)
-
-[ CFooter ](./4.0/components/footer.md)
-
-[ CForm ](./4.0/components/form.md)
-
-[ CGrid ](./4.0/components/grid.md)
-
-[ CHeader ](./4.0/components/header.md)
-
-[ CLink ](./4.0/components/link.md)
-
-[ CListGroup ](./4.0/components/list-group.md)
-
-[ CLoadingButton ](./4.0/components/loading-button.md)
-
-[ CModal ](./4.0/components/modal.md)
-
-[ CMultiSelect ](./4.0/components/multi-select.md)
-
-[ CNav ](./4.0/components/nav.md)
-
-[ CNavBar ](./4.0/components/navbar.md)
-
-[ COffcanvas ](./4.0/components/offcanvas.md)
-
-[ CPagination ](./4.0/components/pagination.md)
-
-[ CPopover ](./4.0/components/popover.md)
-
-[ CProgress ](./4.0/components/progress.md)
-
-[ CSidebar ](./4.0/components/sidebar.md)
-
-[ CSpinner ](./4.0/components/spinner.md)
-
-[ CTable ](./4.0/components/table.md)
-
-[ CTabs ](./4.0/components/tabs.md)
-
-[ CToast ](./4.0/components/toast.md)
-
-### Directives:
-
-
-[ CTooltip ](./4.0/directives/tooltip.md)
-
-[ CPopover ](./4.0/directives/popover.md)
\ No newline at end of file
diff --git a/packages/docs/api/accordion/CAccordionItem.api.md b/packages/docs/api/accordion/CAccordionItem.api.md
index 753acd83..3e07d5aa 100644
--- a/packages/docs/api/accordion/CAccordionItem.api.md
+++ b/packages/docs/api/accordion/CAccordionItem.api.md
@@ -8,6 +8,7 @@ import CAccordionItem from '@coreui/vue/src/components/accordion/CAccordionItem'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------ | ------------- | -------------- | ------ | ------- |
-| **item-key** | The item key. | number\|string | - | - |
+| Prop name | Description | Type | Values | Default |
+| ------------ | --------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
+| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document. | string | - | - |
+| **item-key** | The item key. | number\|string | - | - |
diff --git a/packages/docs/api/badge/CBadge.api.md b/packages/docs/api/badge/CBadge.api.md
index 4ee02b81..4d763c88 100644
--- a/packages/docs/api/badge/CBadge.api.md
+++ b/packages/docs/api/badge/CBadge.api.md
@@ -8,12 +8,12 @@ import CBadge from '@coreui/vue/src/components/badge/CBadge'
#### Props
-| Prop name | Description | Type | Values | Default |
-| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'span' |
-| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **position** | Position badge in one of the corners of a link or button. | string | `'top-start'`, `'top-end'`, `'bottom-end'`, `'bottom-start'` | - |
-| **shape** | 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'` | - |
-| **size** | Size the component small. | string | `'sm'` | - |
-| **text-bg-color**
5.0.0-rc.3+
| Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **text-color** | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'primary-emphasis'`, `'secondary-emphasis'`, `'success-emphasis'`, `'danger-emphasis'`, `'warning-emphasis'`, `'info-emphasis'`, `'light-emphasis'`, `'body'`, `'body-emphasis'`, `'body-secondary'`, `'body-tertiary'`, `'black'`, `'black-50'`, `'white'`, `'white-50'` | - |
+| Prop name | Description | Type | Values | Default |
+| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'span' |
+| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **position** | Position badge in one of the corners of a link or button. | string | `'top-start'`, `'top-end'`, `'bottom-end'`, `'bottom-start'` | - |
+| **shape** | 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'` | - |
+| **size** | Size the component small. | string | `'sm'` | - |
+| **text-bg-color**
5.0.0+
| Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **text-color** | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'primary-emphasis'`, `'secondary-emphasis'`, `'success-emphasis'`, `'danger-emphasis'`, `'warning-emphasis'`, `'info-emphasis'`, `'light-emphasis'`, `'body'`, `'body-emphasis'`, `'body-secondary'`, `'body-tertiary'`, `'black'`, `'black-50'`, `'white'`, `'white-50'` | - |
diff --git a/packages/docs/api/card/CCard.api.md b/packages/docs/api/card/CCard.api.md
index 6f6734f7..49c792f9 100644
--- a/packages/docs/api/card/CCard.api.md
+++ b/packages/docs/api/card/CCard.api.md
@@ -8,8 +8,8 @@ import CCard from '@coreui/vue/src/components/card/CCard'
#### Props
-| Prop name | Description | Type | Values | Default |
-| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **text-bg-color**
5.0.0-rc.3+
| Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **text-color** | Sets the text color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'primary-emphasis'`, `'secondary-emphasis'`, `'success-emphasis'`, `'danger-emphasis'`, `'warning-emphasis'`, `'info-emphasis'`, `'light-emphasis'`, `'body'`, `'body-emphasis'`, `'body-secondary'`, `'body-tertiary'`, `'black'`, `'black-50'`, `'white'`, `'white-50'` | - |
+| Prop name | Description | Type | Values | Default |
+| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **text-bg-color**
5.0.0+
| Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **text-color** | Sets the text color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'primary-emphasis'`, `'secondary-emphasis'`, `'success-emphasis'`, `'danger-emphasis'`, `'warning-emphasis'`, `'info-emphasis'`, `'light-emphasis'`, `'body'`, `'body-emphasis'`, `'body-secondary'`, `'body-tertiary'`, `'black'`, `'black-50'`, `'white'`, `'white-50'` | - |
diff --git a/packages/docs/api/conditional-teleport/CConditionalTeleport.api.md b/packages/docs/api/conditional-teleport/CConditionalTeleport.api.md
index 743b1d0a..79b60043 100644
--- a/packages/docs/api/conditional-teleport/CConditionalTeleport.api.md
+++ b/packages/docs/api/conditional-teleport/CConditionalTeleport.api.md
@@ -8,7 +8,7 @@ import CConditionalTeleport from '@coreui/vue/src/components/conditional-telepor
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -------------------------------------------- | ------ | ------- |
-| **container**
v5.0.0-rc.3+
| An HTML element or function that returns a single element, with `document.body` as the default. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
-| **teleport** | Render some children into a different part of the DOM | boolean | - | true |
+| Prop name | Description | Type | Values | Default |
+| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -------------------------------------------- | ------ | ------- |
+| **container**
5.0.0+
| An HTML element or function that returns a single element, with `document.body` as the default. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
+| **teleport** | Render some children into a different part of the DOM | boolean | - | true |
diff --git a/packages/docs/api/coreui-icons-vue/src/CIconSvg.api.md b/packages/docs/api/coreui-icons-vue/src/CIconSvg.api.md
new file mode 100644
index 00000000..1984a5a7
--- /dev/null
+++ b/packages/docs/api/coreui-icons-vue/src/CIconSvg.api.md
@@ -0,0 +1,17 @@
+### CIconSvg
+
+```jsx
+import { CIconSvg } from '@coreui/icons-vue'
+// or
+import CIconSvg from '@coreui/icons-vue/src/CIconSvg'
+```
+
+#### Props
+
+| Prop name | Description | Type | Values | Default |
+| --------------------- | ------------------------------------------------------------------------------------------------- | --------------------- | ------ | ------- |
+| **custom-class-name** | Use for replacing default CIconSvg component classes. Prop is overriding the 'size' prop. | string\|array\|object | - | - |
+| **height** | The height attribute defines the vertical length of an icon. | number | - | - |
+| **size** | Size of the icon. Available sizes: 'sm', 'lg', 'xl', 'xxl', '3xl...9xl', 'custom', 'custom-size'. | string | - | - |
+| **title** | Title tag content. | string | - | - |
+| **width** | The width attribute defines the horizontal length of an icon. | number | - | - |
diff --git a/packages/docs/api/dropdown/CDropdown.api.md b/packages/docs/api/dropdown/CDropdown.api.md
index 8a5b1759..6d3bade5 100644
--- a/packages/docs/api/dropdown/CDropdown.api.md
+++ b/packages/docs/api/dropdown/CDropdown.api.md
@@ -8,21 +8,21 @@ import CDropdown from '@coreui/vue/src/components/dropdown/CDropdown'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
-| **alignment** | Set aligment of dropdown menu. | string \| Alignments | `{ 'start' \| 'end' \| { xs: 'start' \| 'end' } \| { sm: 'start' \| 'end' } \| { md: 'start' \| 'end' } \| { lg: 'start' \| 'end' } \| { xl: 'start' \| 'end'} \| { xxl: 'start' \| 'end'} }` | - |
-| **auto-close** | Configure the auto close behavior of the dropdown: - `true` - the dropdown will be closed by clicking outside or inside the dropdown menu. - `false` - the dropdown will be closed by clicking the toggle button and manually calling hide or toggle method. (Also will not be closed by pressing esc key) - `'inside'` - the dropdown will be closed (only) by clicking inside the dropdown menu. - `'outside'` - the dropdown will be closed (only) by clicking outside the dropdown menu. | boolean\|string | - | true |
-| **container**
v5.0.0-rc.3+
| Appends the vue dropdown menu to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
-| **dark** | Sets a darker color scheme to match a dark navbar. | boolean | - | - |
-| **direction** | Sets a specified direction and location of the dropdown menu. | string | `'center'`, `'dropup'`, `'dropup-center'`, `'dropend'`, `'dropstart'` | - |
-| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
-| **offset**
4.9.0+
| Offset of the dropdown menu relative to its target. | array | - | [0, 2] |
-| **placement** | Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property. | Placement | `'auto'`, `'top-end'`, `'top'`, `'top-start'`, `'bottom-end'`, `'bottom'`, `'bottom-start'`, `'right-start'`, `'right'`, `'right-end'`, `'left-start'`, `'left'`, `'left-end'` | 'bottom-start' |
-| **popper** | If you want to disable dynamic positioning set this property to `true`. | boolean | - | true |
-| **teleport**
v5.0.0-rc.3+
| Generates dropdown menu using Teleport. | boolean | - | false |
-| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. | Triggers | - | 'click' |
-| **variant** | Set the dropdown variant to an btn-group, dropdown, input-group, and nav-item. | string | `'btn-group'`, `'dropdown'`, `'input-group'`, `'nav-item'` | 'btn-group' |
-| **visible** | Toggle the visibility of dropdown menu component. | boolean | - | - |
+| Prop name | Description | Type | Values | Default |
+| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
+| **alignment** | Set aligment of dropdown menu. | string \| Alignments | `{ 'start' \| 'end' \| { xs: 'start' \| 'end' } \| { sm: 'start' \| 'end' } \| { md: 'start' \| 'end' } \| { lg: 'start' \| 'end' } \| { xl: 'start' \| 'end'} \| { xxl: 'start' \| 'end'} }` | - |
+| **auto-close** | Configure the auto close behavior of the dropdown: - `true` - the dropdown will be closed by clicking outside or inside the dropdown menu. - `false` - the dropdown will be closed by clicking the toggle button and manually calling hide or toggle method. (Also will not be closed by pressing esc key) - `'inside'` - the dropdown will be closed (only) by clicking inside the dropdown menu. - `'outside'` - the dropdown will be closed (only) by clicking outside the dropdown menu. | boolean\|string | - | true |
+| **container**
5.0.0+
| Appends the vue dropdown menu to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
+| **dark** | Sets a darker color scheme to match a dark navbar. | boolean | - | - |
+| **direction** | Sets a specified direction and location of the dropdown menu. | string | `'center'`, `'dropup'`, `'dropup-center'`, `'dropend'`, `'dropstart'` | - |
+| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
+| **offset**
4.9.0+
| Offset of the dropdown menu relative to its target. | array | - | [0, 2] |
+| **placement** | Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property. | Placement | `'auto'`, `'top-end'`, `'top'`, `'top-start'`, `'bottom-end'`, `'bottom'`, `'bottom-start'`, `'right-start'`, `'right'`, `'right-end'`, `'left-start'`, `'left'`, `'left-end'` | 'bottom-start' |
+| **popper** | If you want to disable dynamic positioning set this property to `true`. | boolean | - | true |
+| **teleport**
5.0.0+
| Generates dropdown menu using Teleport. | boolean | - | false |
+| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. | Triggers | - | 'click' |
+| **variant** | Set the dropdown variant to an btn-group, dropdown, input-group, and nav-item. | string | `'btn-group'`, `'dropdown'`, `'input-group'`, `'nav-item'` | 'btn-group' |
+| **visible** | Toggle the visibility of dropdown menu component. | boolean | - | - |
#### Events
diff --git a/packages/docs/api/dropdown/CDropdownToggle.api.md b/packages/docs/api/dropdown/CDropdownToggle.api.md
index 5c10b591..ddf79509 100644
--- a/packages/docs/api/dropdown/CDropdownToggle.api.md
+++ b/packages/docs/api/dropdown/CDropdownToggle.api.md
@@ -8,15 +8,15 @@ import CDropdownToggle from '@coreui/vue/src/components/dropdown/CDropdownToggle
#### Props
-| Prop name | Description | Type | Values | Default |
-| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | -------- |
-| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
-| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
-| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
-| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
-| **nav-link**
v5.0.0-rc.3+
| If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | boolean | - | true |
-| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
-| **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 | - | - |
-| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. `@type` 'hover' \| 'focus' \| 'click' | Triggers | - | 'click' |
-| **variant** | Set the button variant to an outlined button or a ghost button. | string | `'ghost'`, `'outline'` | - |
+| Prop name | Description | Type | Values | Default |
+| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | -------- |
+| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
+| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
+| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
+| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
+| **nav-link**
5.0.0+
| If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | boolean | - | true |
+| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
+| **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 | - | - |
+| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. `@type` 'hover' \| 'focus' \| 'click' | Triggers | - | 'click' |
+| **variant** | Set the button variant to an outlined button or a ghost button. | string | `'ghost'`, `'outline'` | - |
diff --git a/packages/docs/api/footer/CFooter.api.md b/packages/docs/api/footer/CFooter.api.md
index b1eedef2..bc9337fe 100644
--- a/packages/docs/api/footer/CFooter.api.md
+++ b/packages/docs/api/footer/CFooter.api.md
@@ -8,6 +8,7 @@ import CFooter from '@coreui/vue/src/components/footer/CFooter'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------ | ------------------------------------- | ------ | --------------------- | ------- |
-| **position** | Place footer in non-static positions. | string | `'fixed'`, `'sticky'` | - |
+| Prop name | Description | Type | Values | Default |
+| ------------ | --------------------------------------------------------------------------------------- | ------ | --------------------- | ------- |
+| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'div' |
+| **position** | Place footer in non-static positions. | string | `'fixed'`, `'sticky'` | - |
diff --git a/packages/docs/api/form/CFormControlWrapper.api.md b/packages/docs/api/form/CFormControlWrapper.api.md
index c4d97891..ebce3a46 100644
--- a/packages/docs/api/form/CFormControlWrapper.api.md
+++ b/packages/docs/api/form/CFormControlWrapper.api.md
@@ -8,8 +8,9 @@ import CFormControlWrapper from '@coreui/vue/src/components/form/CFormControlWra
#### Props
-| Prop name | Description | Type | Values | Default |
-| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ------- |
-| **floating-label**
4.3.0+
| Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | - |
-| **label**
4.3.0+
| Add a caption for a component. | string | - | - |
-| **text**
4.3.0+
| Add helper text to the component. | string | - | - |
+| Prop name | Description | Type | Values | Default |
+| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ------- |
+| **floating-class-name**
5.5.0+
| A string of all className you want applied to the floating label wrapper. | string | - | - |
+| **floating-label**
4.3.0+
| Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | - |
+| **label**
4.3.0+
| Add a caption for a component. | string | - | - |
+| **text**
4.3.0+
| Add helper text to the component. | string | - | - |
diff --git a/packages/docs/api/header/CHeader.api.md b/packages/docs/api/header/CHeader.api.md
index 0416d9ee..f47ab627 100644
--- a/packages/docs/api/header/CHeader.api.md
+++ b/packages/docs/api/header/CHeader.api.md
@@ -8,7 +8,8 @@ import CHeader from '@coreui/vue/src/components/header/CHeader'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------- | ------------------------------------------------------ | --------------- | ------------------------------------------------------------- | ------- |
-| **container** | Defines optional container wrapping children elements. | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'`, `'fluid'` | - |
-| **position** | Place header in non-static positions. | string | `'fixed'`, `'sticky'` | - |
+| Prop name | Description | Type | Values | Default |
+| ------------- | --------------------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------- | ------- |
+| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'div' |
+| **container** | Defines optional container wrapping children elements. | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'`, `'fluid'` | - |
+| **position** | Place header in non-static positions. | string | `'fixed'`, `'sticky'` | - |
diff --git a/packages/docs/api/modal/CModal.api.md b/packages/docs/api/modal/CModal.api.md
index 66efacda..6f201012 100644
--- a/packages/docs/api/modal/CModal.api.md
+++ b/packages/docs/api/modal/CModal.api.md
@@ -8,19 +8,21 @@ import CModal from '@coreui/vue/src/components/modal/CModal'
#### Props
-| Prop name | Description | Type | Values | Default |
-| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
-| **alignment** | Align the modal in the center or top of the screen. | string | `'top'`, `'center'` | 'top' |
-| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
-| **content-class-name** | A string of all className you want applied to the modal content component. | string | - | - |
-| **focus**
v5.0.0-rc.3+
| Puts the focus on the modal when shown. | boolean | - | true |
-| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
-| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |
-| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | - |
-| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
-| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |
-| **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 |
-| **visible** | Toggle the visibility of alert component. | boolean | - | - |
+| Prop name | Description | Type | Values | Default |
+| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -------------------------------------------------- | ------- |
+| **alignment** | Align the modal in the center or top of the screen. | string | `'top'`, `'center'` | 'top' |
+| **backdrop** | Apply a backdrop on body while offcanvas is open. | boolean\|string | `boolean \| 'static'` | true |
+| **container**
5.3.0+
| Appends the vue popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
+| **content-class-name** | A string of all className you want applied to the modal content component. | string | - | - |
+| **focus**
5.0.0+
| Puts the focus on the modal when shown. | boolean | - | true |
+| **fullscreen** | Set modal to covers the entire user viewport | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | - |
+| **keyboard** | Closes the modal when escape key is pressed. | boolean | - | true |
+| **scrollable** | Create a scrollable modal that allows scrolling the modal body. | boolean | - | - |
+| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'lg'`, `'xl'` | - |
+| **teleport**
5.3.0+
| Generates modal using Teleport. | boolean | - | false |
+| **transition** | Remove animation to create modal that simply appear rather than fade in to view. | boolean | - | true |
+| **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 |
+| **visible** | Toggle the visibility of alert component. | boolean | - | - |
#### Events
diff --git a/packages/docs/api/nav/CNavItem.api.md b/packages/docs/api/nav/CNavItem.api.md
index 2a2d63d1..788b3792 100644
--- a/packages/docs/api/nav/CNavItem.api.md
+++ b/packages/docs/api/nav/CNavItem.api.md
@@ -8,6 +8,9 @@ import CNavItem from '@coreui/vue/src/components/nav/CNavItem'
#### Props
-| Prop name | Description | Type | Values | Default |
-| --------- | --------------------------------------------------------------------------------------- | ------ | ------ | ------- |
-| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'li' |
+| Prop name | Description | Type | Values | Default |
+| ------------ | --------------------------------------------------------------------------------------- | ------- | ------ | ------- |
+| **active** | Toggle the active state for the component. | boolean | - | - |
+| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'li' |
+| **class** | A string of all className you want applied to the component. | string | - | - |
+| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
diff --git a/packages/docs/api/popover/CPopover.api.md b/packages/docs/api/popover/CPopover.api.md
index 11cd30e9..725e4846 100644
--- a/packages/docs/api/popover/CPopover.api.md
+++ b/packages/docs/api/popover/CPopover.api.md
@@ -11,7 +11,7 @@ import CPopover from '@coreui/vue/src/components/popover/CPopover'
| Prop name | Description | Type | Values | Default |
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------- | ---------------------------------------- |
| **animation**
4.9.0+
| Apply a CSS fade transition to the popover. | boolean | - | true |
-| **container**
v5.0.0-rc.3+
| Appends the vue popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
+| **container**
5.0.0+
| Appends the vue popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
| **content** | Content for your component. If you want to pass non-string value please use dedicated slot `...` | string | - | - |
| **delay**
4.9.0+
| The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | number \| { show: number; hide: number } | - | 0 |
| **fallback-placements**
4.9.0+
| Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | Placements \| Placements[] | - | () => ['top', 'right', 'bottom', 'left'] |
diff --git a/packages/docs/api/progress/CProgress.api.md b/packages/docs/api/progress/CProgress.api.md
index 821d6eef..1236b6ba 100644
--- a/packages/docs/api/progress/CProgress.api.md
+++ b/packages/docs/api/progress/CProgress.api.md
@@ -8,13 +8,13 @@ import CProgress from '@coreui/vue/src/components/progress/CProgress'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | ------- |
-| **animated** | Use to animate the stripes right to left via CSS3 animations. | boolean | - | - |
-| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
-| **height** | Sets the height of the component. If you set that value the inner `` will automatically resize accordingly. | number | - | - |
-| **progress-bar-class-name**
5.0.0-rc.3+
| A string of all className you want applied to the component. | string | - | - |
-| **thin** | Makes progress bar thinner. | boolean | - | - |
-| **value** | The percent to progress the ProgressBar. | number | - | 0 |
-| **variant** | Set the progress bar variant to optional striped. | string | `'striped'` | - |
-| **white** | Change the default color to white. | boolean | - | - |
+| Prop name | Description | Type | Values | Default |
+| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | ------- |
+| **animated** | Use to animate the stripes right to left via CSS3 animations. | boolean | - | - |
+| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
+| **height** | Sets the height of the component. If you set that value the inner `` will automatically resize accordingly. | number | - | - |
+| **progress-bar-class-name**
5.0.0+
| A string of all className you want applied to the component. | string | - | - |
+| **thin** | Makes progress bar thinner. | boolean | - | - |
+| **value** | The percent to progress the ProgressBar. | number | - | 0 |
+| **variant** | Set the progress bar variant to optional striped. | string | `'striped'` | - |
+| **white** | Change the default color to white. | boolean | - | - |
diff --git a/packages/docs/api/tabs/CTab.api.md b/packages/docs/api/tabs/CTab.api.md
new file mode 100644
index 00000000..7cdff394
--- /dev/null
+++ b/packages/docs/api/tabs/CTab.api.md
@@ -0,0 +1,14 @@
+### CTab
+
+```jsx
+import { CTab } from '@coreui/vue'
+// or
+import CTab from '@coreui/vue/src/components/tabs/CTab'
+```
+
+#### Props
+
+| Prop name | Description | Type | Values | Default |
+| ----------------------------------------------------------- | -------------------------------------------- | -------------- | ------ | ------- |
+| **disabled**
5.4.0+
| Toggle the disabled state for the component. | boolean | - | - |
+| **item-key** | Item key. | number\|string | - | - |
diff --git a/packages/docs/api/tabs/CTabList.api.md b/packages/docs/api/tabs/CTabList.api.md
new file mode 100644
index 00000000..68b9ca46
--- /dev/null
+++ b/packages/docs/api/tabs/CTabList.api.md
@@ -0,0 +1,14 @@
+### CTabList
+
+```jsx
+import { CTabList } from '@coreui/vue'
+// or
+import CTabList from '@coreui/vue/src/components/tabs/CTabList'
+```
+
+#### Props
+
+| Prop name | Description | Type | Values | Default |
+| ----------- | ------------------------------------- | ------ | -------------------------------------------------------- | ------- |
+| **layout** | Specify a layout type for component. | string | `'fill'`, `'justified'` | - |
+| **variant** | Set the nav variant to tabs or pills. | string | `'pills'`, `'tabs'`, `'underline'`, `'underline-border'` | - |
diff --git a/packages/docs/api/tabs/CTabPane.api.md b/packages/docs/api/tabs/CTabPane.api.md
index 61e1db99..17eb0a59 100644
--- a/packages/docs/api/tabs/CTabPane.api.md
+++ b/packages/docs/api/tabs/CTabPane.api.md
@@ -8,9 +8,10 @@ import CTabPane from '@coreui/vue/src/components/tabs/CTabPane'
#### Props
-| Prop name | Description | Type | Values | Default |
-| ----------- | ----------------------------------- | ------- | ------ | ------- |
-| **visible** | Toggle the visibility of component. | boolean | - | false |
+| Prop name | Description | Type | Values | Default |
+| ------------------------------------------------------------- | --------------------------------------- | ------- | ------ | ------- |
+| **transition**
5.1.0+
| Enable fade in and fade out transition. | boolean | - | true |
+| **visible** | Toggle the visibility of component. | boolean | - | false |
#### Events
diff --git a/packages/docs/api/tabs/CTabPanel.api.md b/packages/docs/api/tabs/CTabPanel.api.md
new file mode 100644
index 00000000..bf254378
--- /dev/null
+++ b/packages/docs/api/tabs/CTabPanel.api.md
@@ -0,0 +1,22 @@
+### CTabPanel
+
+```jsx
+import { CTabPanel } from '@coreui/vue'
+// or
+import CTabPanel from '@coreui/vue/src/components/tabs/CTabPanel'
+```
+
+#### Props
+
+| Prop name | Description | Type | Values | Default |
+| -------------- | --------------------------------------- | -------------- | ------ | ------- |
+| **item-key** | Item key. | number\|string | - | - |
+| **transition** | Enable fade in and fade out transition. | boolean | - | true |
+| **visible** | Toggle the visibility of component. | boolean | - | false |
+
+#### Events
+
+| Event name | Description | Properties |
+| ---------- | -------------------------------------------------------- | ---------- |
+| **hide** | Callback fired when the component requests to be hidden. |
+| **show** | Callback fired when the component requests to be shown. |
diff --git a/packages/docs/api/tabs/CTabs.api.md b/packages/docs/api/tabs/CTabs.api.md
new file mode 100644
index 00000000..4fea4982
--- /dev/null
+++ b/packages/docs/api/tabs/CTabs.api.md
@@ -0,0 +1,19 @@
+### CTabs
+
+```jsx
+import { CTabs } from '@coreui/vue'
+// or
+import CTabs from '@coreui/vue/src/components/tabs/CTabs'
+```
+
+#### Props
+
+| Prop name | Description | Type | Values | Default |
+| ------------------- | -------------------- | -------------- | ------ | ------- |
+| **active-item-key** | The active item key. | number\|string | - | - |
+
+#### Events
+
+| Event name | Description | Properties |
+| ---------- | -------------------------------------------------- | ---------- |
+| **change** | The callback is fired when the active tab changes. |
diff --git a/packages/docs/api/toast/CToastHeader.api.md b/packages/docs/api/toast/CToastHeader.api.md
index fdd97dc8..a8ff8638 100644
--- a/packages/docs/api/toast/CToastHeader.api.md
+++ b/packages/docs/api/toast/CToastHeader.api.md
@@ -11,9 +11,3 @@ import CToastHeader from '@coreui/vue/src/components/toast/CToastHeader'
| Prop name | Description | Type | Values | Default |
| ---------------- | ----------------------------------------------- | ------- | ------ | ------- |
| **close-button** | Automatically add a close button to the header. | boolean | - | - |
-
-#### Events
-
-| Event name | Description | Properties |
-| ---------- | --------------------------------------------- | ---------- |
-| **close** | Event called after clicking the close button. |
diff --git a/packages/docs/api/tooltip/CTooltip.api.md b/packages/docs/api/tooltip/CTooltip.api.md
index 9794c42c..3b0cac97 100644
--- a/packages/docs/api/tooltip/CTooltip.api.md
+++ b/packages/docs/api/tooltip/CTooltip.api.md
@@ -11,7 +11,7 @@ import CTooltip from '@coreui/vue/src/components/tooltip/CTooltip'
| Prop name | Description | Type | Values | Default |
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------- | ---------------------------------------- |
| **animation**
4.9.0+
| Apply a CSS fade transition to the tooltip. | boolean | - | true |
-| **container**
v5.0.0-rc.3+
| Appends the vue tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
+| **container**
5.0.0+
| Appends the vue tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
| **content** | Content for your component. If you want to pass non-string value please use dedicated slot `...` | string | - | - |
| **delay**
4.9.0+
| The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | number \| { show: number; hide: number } | - | 0 |
| **fallback-placements**
4.9.0+
| Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | Placements \| Placements[] | - | () => ['top', 'right', 'bottom', 'left'] |
diff --git a/packages/docs/build/docgen.config.js b/packages/docs/build/docgen.config.js
index e4c71f24..7d654712 100644
--- a/packages/docs/build/docgen.config.js
+++ b/packages/docs/build/docgen.config.js
@@ -8,7 +8,8 @@ module.exports = {
components: [
'**/[A-Z]*.ts',
'!**/[A-Z]*.d.ts',
- '!**/[A-Z]*.spec.ts'
+ '!**/[A-Z]*.spec.ts',
+ '!**/ComponentProps.ts',
],
outDir: 'api', // folder to save components docs in (relative to the current working directry)
getDocFileName: (componentPath) =>
diff --git a/packages/docs/components/alert.md b/packages/docs/components/alert.md
index 8575ad96..96091ca9 100644
--- a/packages/docs/components/alert.md
+++ b/packages/docs/components/alert.md
@@ -1,5 +1,6 @@
---
title: Vue Alert Component
+name: Alert
description: Vue alert component gives contextual feedback information for common user operations. The alert component is delivered with a bunch of usable and adjustable alert messages.
other_frameworks: alert
---
@@ -18,7 +19,8 @@ Vue Alert is prepared for any length of text, as well as an optional close butto
A simple light alert—check it out!A simple dark alert—check it out!
:::
-```markup
+
+```vue
A simple primary alert—check it out!A simple secondary alert—check it out!A simple success alert—check it out!
@@ -37,9 +39,16 @@ Click the button below to show an alert (hidden with inline styles to start), th
{ liveExampleVisible = false }">A simple primary alert—check it out! { liveExampleVisible = true }">Show live alert
:::
-```markup
- { liveExampleVisible = false }">A simple primary alert—check it out!
- { liveExampleVisible = true }">Show live alert
+
+```vue
+
+
+ { liveExampleVisible = false }">A simple primary alert—check it out!
+ { liveExampleVisible = true }">Show live alert
+
```
### Link color
@@ -47,32 +56,32 @@ Click the button below to show an alert (hidden with inline styles to start), th
Use the `` component to immediately give matching colored links inside any alert.
::: demo
- A simple primary alert with an example link. Give it a click if you like.
+A simple primary alert with an example link. Give it a click if you like.
- A simple secondary alert with an example link. Give it a click if you like.
+A simple secondary alert with an example link. Give it a click if you like.
- A simple success alert with an example link. Give it a click if you like.
+A simple success alert with an example link. Give it a click if you like.
- A simple danger alert with an example link. Give it a click if you like.
+A simple danger alert with an example link. Give it a click if you like.
- A simple warning alert with an example link. Give it a click if you like.
+A simple warning alert with an example link. Give it a click if you like.
- A simple info alert with an example link. Give it a click if you like.
+A simple info alert with an example link. Give it a click if you like.
- A simple light alert with an example link. Give it a click if you like.
+A simple light alert with an example link. Give it a click if you like.
- A simple dark alert with an example link. Give it a click if you like.
+A simple dark alert with an example link. Give it a click if you like.
:::
-```markup
+```vue
A simple primary alert with an example link. Give it a click if you like.
@@ -105,14 +114,15 @@ Alert can also incorporate supplementary HTML elements like heading, paragraph,
::: demo
- Well done!
+Well done!
+
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.
Whenever you need to, be sure to use margin utilities to keep things nice and tidy.
:::
-```markup
+```vue
Well done!
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.
@@ -120,21 +130,23 @@ Alert can also incorporate supplementary HTML elements like heading, paragraph,
Whenever you need to, be sure to use margin utilities to keep things nice and tidy.
```
+
### Icons
Similarly, you can use [flexbox utilities](https//coreui.io/docs/4.0/utilities/flex") and [CoreUI Icons](https://icons.coreui.io) to create alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles.
::: demo
-
+
+