Skip to content

Commit eb170af

Browse files
committed
docs: update API documentation
1 parent 60896c2 commit eb170af

File tree

11 files changed

+93
-64
lines changed

11 files changed

+93
-64
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ const CDropdown = defineComponent({
121121
/**
122122
* Offset of the dropdown menu relative to its target.
123123
*
124-
* @since 4.9.0-beta.2
124+
* @since 4.9.0
125125
*/
126126
offset: {
127127
type: Array,

packages/coreui-vue/src/components/form/CFormCheck.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const CFormCheck = defineComponent({
1717
/**
1818
* 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.
1919
*
20-
* @since 4.9.0-beta.2
20+
* @since 4.9.0
2121
*/
2222
falseValue: String,
2323
/**
@@ -90,7 +90,7 @@ const CFormCheck = defineComponent({
9090
/**
9191
* 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.
9292
*
93-
* @since 4.9.0-beta.2
93+
* @since 4.9.0
9494
*/
9595
trueValue: String,
9696
/**

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const CPopover = defineComponent({
1212
/**
1313
* Apply a CSS fade transition to the popover.
1414
*
15-
* @since 4.9.0-beta.2
15+
* @since 4.9.0
1616
*/
1717
animation: {
1818
type: Boolean,
@@ -25,7 +25,7 @@ const CPopover = defineComponent({
2525
/**
2626
* 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 }`.
2727
*
28-
* @since 4.9.0-beta.2
28+
* @since 4.9.0
2929
*/
3030
delay: {
3131
type: [Number, Object] as PropType<number | { show: number; hide: number }>,
@@ -34,7 +34,7 @@ const CPopover = defineComponent({
3434
/**
3535
* Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
3636
*
37-
* @since 4.9.0-beta.2
37+
* @since 4.9.0
3838
*/
3939
fallbackPlacements: {
4040
type: [String, Array] as PropType<Placements | Placements[]>,

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const CTooltip = defineComponent({
1212
/**
1313
* Apply a CSS fade transition to the tooltip.
1414
*
15-
* @since 4.9.0-beta.2
15+
* @since 4.9.0
1616
*/
1717
animation: {
1818
type: Boolean,
@@ -25,7 +25,7 @@ const CTooltip = defineComponent({
2525
/**
2626
* 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 }`.
2727
*
28-
* @since 4.9.0-beta.2
28+
* @since 4.9.0
2929
*/
3030
delay: {
3131
type: [Number, Object] as PropType<number | { show: number; hide: number }>,
@@ -34,7 +34,7 @@ const CTooltip = defineComponent({
3434
/**
3535
* Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
3636
*
37-
* @since 4.9.0-beta.2
37+
* @since 4.9.0
3838
*/
3939
fallbackPlacements: {
4040
type: [String, Array] as PropType<Placements | Placements[]>,

packages/docs/api/CChart.api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import CChart from '@coreui/vue-chartjs/src/CChart'
1414
| **data** | The data object that is passed into the Chart.js chart (more info). | ChartData \| ((canvas: HTMLCanvasElement) => ChartData) | - | - |
1515
| **height** | Height attribute applied to the rendered canvas.<br/>`@default` 150 | number | - | 150 |
1616
| **id** | ID attribute applied to the rendered canvas. | string | - | - |
17-
| **options** | The options object that is passed into the Chart.js chart.<br><br>{@link https://www.chartjs.org/docs/latest/general/options.html More Info} | ChartOptions | - | - |
17+
| **options** | The options object that is passed into the Chart.js chartRef.value.<br><br>{@link https://www.chartjs.org/docs/latest/general/options.html More Info} | ChartOptions | - | - |
1818
| **plugins** | The plugins array that is passed into the Chart.js chart (more info)<br><br>{@link https://www.chartjs.org/docs/latest/developers/plugins.html More Info} | Plugin[] | - | - |
1919
| **redraw** | If true, will tear down and redraw chart on all updates. | boolean | - | - |
2020
| **type** | Chart.js chart type.<br/>`@type` 'line' \| 'bar' \| 'radar' \| 'doughnut' \| 'polarArea' \| 'bubble' \| 'pie' \| 'scatter' | ChartType | - | 'bar' |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### CIcon
2+
3+
```jsx
4+
import { CIcon } from '@coreui/icons-vue'
5+
// or
6+
import CIcon from '@coreui/icons-vue/src/CIcon'
7+
```
8+
9+
#### Props
10+
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------------- | ------------------------------------------------------------------------------------------------- | --------------------- | ------ | ------- |
13+
| **content** | Use `:icon="..."` instead of<br/>`@deprecated` since version 3.0 | string\|array | - | - |
14+
| **custom-class-name** | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. | string\|array\|object | - | - |
15+
| **icon** | Name of the icon placed in React object or SVG content. | string \| string[] | - | - |
16+
| **name** | Use `icon="..."` instead of<br/>`@deprecated` since version 3.0 | string | - | - |
17+
| **size** | Size of the icon. Available sizes: 'sm', 'lg', 'xl', 'xxl', '3xl...9xl', 'custom', 'custom-size'. | string | - | - |
18+
| **title** | Title tag content. | string | - | - |
19+
| **use** | If defined component will be rendered using 'use' tag. | string | - | - |

0 commit comments

Comments
 (0)