Skip to content

Commit 7cc0c88

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent d15e705 commit 7cc0c88

File tree

11 files changed

+40
-40
lines changed

11 files changed

+40
-40
lines changed

‎packages/coreui-vue/src/components/conditional-teleport/CConditionalTeleport.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const CConditionalTeleport = defineComponent({
1616
/**
1717
* An HTML element or function that returns a single element, with `document.body` as the default.
1818
*
19-
* @since v5.0.0
19+
* @since 5.0.0
2020
*/
2121
container: {
2222
type: [Object, String] as PropType<HTMLElement | (() => HTMLElement) | string>,

‎packages/coreui-vue/src/components/dropdown/CDropdown.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ const CDropdown = defineComponent({
6262
/**
6363
* 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`.
6464
*
65-
* @since v5.0.0
65+
* @since 5.0.0
6666
*/
6767
container: {
6868
type: [Object, String] as PropType<HTMLElement | (() => HTMLElement) | string>,
@@ -115,7 +115,7 @@ const CDropdown = defineComponent({
115115
/**
116116
* Generates dropdown menu using Teleport.
117117
*
118-
* @since v5.0.0
118+
* @since 5.0.0
119119
*/
120120
teleport: {
121121
type: Boolean,

‎packages/coreui-vue/src/components/dropdown/CDropdownToggle.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const CDropdownToggle = defineComponent({
4949
/**
5050
* If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button.
5151
*
52-
* @since v5.0.0
52+
* @since 5.0.0
5353
*/
5454
navLink: {
5555
type: Boolean,

‎packages/coreui-vue/src/components/popover/CPopover.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const CPopover = defineComponent({
2323
/**
2424
* 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`.
2525
*
26-
* @since v5.0.0
26+
* @since 5.0.0
2727
*/
2828
container: {
2929
type: [Object, String] as PropType<HTMLElement | (() => HTMLElement) | string>,

‎packages/coreui-vue/src/components/tooltip/CTooltip.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const CTooltip = defineComponent({
2323
/**
2424
* 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`.
2525
*
26-
* @since v5.0.0
26+
* @since 5.0.0
2727
*/
2828
container: {
2929
type: [Object, String] as PropType<HTMLElement | (() => HTMLElement) | string>,

‎packages/docs/api/conditional-teleport/CConditionalTeleport.api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import CConditionalTeleport from '@coreui/vue/src/components/conditional-telepor
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------- | ------ | ------- |
13-
| **container** <br><div class="badge bg-primary">v5.0.0+</div> | An HTML element or function that returns a single element, with `document.body` as the default. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
14-
| **teleport** | Render some children into a different part of the DOM | boolean | - | true |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -------------------------------------------- | ------ | ------- |
13+
| **container** <br><div class="badge bg-primary">5.0.0+</div> | An HTML element or function that returns a single element, with `document.body` as the default. | HTMLElement \| (() => HTMLElement) \| string | - | 'body' |
14+
| **teleport** | Render some children into a different part of the DOM | boolean | - | true |

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

Lines changed: 15 additions & 15 deletions
Large diffs are not rendered by default.

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

Lines changed: 12 additions & 12 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-
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
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-
| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
16-
| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
17-
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
18-
| **nav-link** <br><div class="badge bg-primary">v5.0.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'` | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | -------- |
13+
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
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+
| **caret** | Enables pseudo element caret on toggler. | boolean | - | true |
16+
| **custom** | Create a custom toggler which accepts any content. | boolean | - | - |
17+
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
18+
| **nav-link** <br><div class="badge bg-primary">5.0.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'` | - |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import CFormSelect from '@coreui/vue/src/components/form/CFormSelect'
1919
| **invalid** | Set component validation state to invalid. | boolean | - | - |
2020
| **label** <br><div class="badge bg-primary">4.3.0+</div> | Add a caption for a component. | string | - | - |
2121
| **model-value** | The default name for a value passed using v-model. | string \| string[] | - | - |
22-
| **options** | Options list of the select component. Available keys: `label`, `value`, `disabled`, `selected`.<br>Examples:<br>- `:options="[{ value: 'js', label: 'JavaScript', selected: true }, { value: 'html', label: 'HTML', disabled: true }]"`<br>- `:options="['js', 'html']"` | Option[] \| string[] | - | - |
22+
| **options** | Options list of the select component. Available keys: `label`, `value`, `disabled`.<br>Examples:<br>- `:options="[{ value: 'js', label: 'JavaScript' }, { value: 'html', label: 'HTML', disabled: true }]"`<br>- `:options="['js', 'html']"` | Option[] \| string[] | - | - |
2323
| **size** | Size the component small or large. | string | `'sm' \| 'lg'` | - |
2424
| **text** <br><div class="badge bg-primary">4.3.0+</div> | Add helper text to the component. | string | - | - |
2525
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip. | boolean | - | - |

‎packages/docs/api/popover/CPopover.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import CPopover from '@coreui/vue/src/components/popover/CPopover'
1111
| Prop name | Description | Type | Values | Default |
1212
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------- | ---------------------------------------- |
1313
| **animation** <br><div class="badge bg-primary">4.9.0+</div> | Apply a CSS fade transition to the popover. | boolean | - | true |
14-
| **container** <br><div class="badge bg-primary">v5.0.0+</div> | 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' |
14+
| **container** <br><div class="badge bg-primary">5.0.0+</div> | 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' |
1515
| **content** | Content for your component. If you want to pass non-string value please use dedicated slot `<template #content>...</template>` | string | - | - |
1616
| **delay** <br><div class="badge bg-primary">4.9.0+</div> | 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 |
1717
| **fallback-placements** <br><div class="badge bg-primary">4.9.0+</div> | 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'] |

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy