Skip to content

Commit 203b5f2

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 231ad1f commit 203b5f2

File tree

17 files changed

+116
-116
lines changed

17 files changed

+116
-116
lines changed

‎packages/docs/api/CChart.api.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ import CChart from '@coreui/vue-chartjs/src/CChart'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------- | ------- |
13-
| **customTooltips** | Enables custom html based tooltips instead of standard tooltips.<br/>`@default` true | boolean | - | true |
14-
| **data** | The data object that is passed into the Chart.js chart (more info). | ChartData \| ((canvas: HTMLCanvasElement) => ChartData) | - | |
15-
| **height** | Height attribute applied to the rendered canvas.<br/>`@default` 150 | number | - | 150 |
16-
| **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 | - | - |
18-
| **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[] | - | - |
19-
| **redraw** | If true, will tear down and redraw chart on all updates. | boolean | - | |
20-
| **type** | Chart.js chart type.<br/>`@type` undefined | ChartType | `line`, `bar`, `radar`, `doughnut`, `polarArea`, `bubble`, `pie`, `scatter` | 'bar' |
21-
| **width** | Width attribute applied to the rendered canvas.<br/>`@default` 300 | number | - | 300 |
22-
| **wrapper** | Put the chart into the wrapper div element.<br/>`@default` true | boolean | - | true |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------- | ------- |
13+
| **custom-tooltips** | Enables custom html based tooltips instead of standard tooltips.<br/>`@default` true | boolean | - | true |
14+
| **data** | The data object that is passed into the Chart.js chart (more info). | ChartData \| ((canvas: HTMLCanvasElement) => ChartData) | - | |
15+
| **height** | Height attribute applied to the rendered canvas.<br/>`@default` 150 | number | - | 150 |
16+
| **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 | - | - |
18+
| **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[] | - | - |
19+
| **redraw** | If true, will tear down and redraw chart on all updates. | boolean | - | |
20+
| **type** | Chart.js chart type.<br/>`@type` undefined | ChartType | `line`, `bar`, `radar`, `doughnut`, `polarArea`, `bubble`, `pie`, `scatter` | 'bar' |
21+
| **width** | Width attribute applied to the rendered canvas.<br/>`@default` 300 | number | - | 300 |
22+
| **wrapper** | Put the chart into the wrapper div element.<br/>`@default` true | boolean | - | true |
2323

2424
#### Events
2525

26-
| Event name | Description | Properties |
27-
| ---------------------- | ------------------------------------------------------------------------------------------- | ---------- |
28-
| **getDatasetAtEvent** | Proxy for Chart.js getDatasetAtEvent. Calls with dataset and triggering event. |
29-
| **getElementAtEvent** | Proxy for Chart.js getElementAtEvent. Calls with single element array and triggering event. |
30-
| **getElementsAtEvent** | Proxy for Chart.js getElementsAtEvent. Calls with element array and triggering event. |
26+
| Event name | Description | Properties |
27+
| ------------------------- | ------------------------------------------------------------------------------------------- | ---------- |
28+
| **get-dataset-at-event** | Proxy for Chart.js getDatasetAtEvent. Calls with dataset and triggering event. |
29+
| **get-element-at-event** | Proxy for Chart.js getElementAtEvent. Calls with single element array and triggering event. |
30+
| **get-elements-at-event** | Proxy for Chart.js getElementsAtEvent. Calls with element array and triggering event. |

‎packages/docs/api/accordion/CAccordion.api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import CAccordion from '@coreui/vue/src/components/accordion/CAccordion'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
13-
| **activeItemKey** | The active item key. | number\|string | - | - |
14-
| **alwaysOpen** | Make accordion items stay open when another item is opened | boolean | - | |
15-
| **flush** | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
13+
| **active-item-key** | The active item key. | number\|string | - | - |
14+
| **always-open** | Make accordion items stay open when another item is opened | boolean | - | |
15+
| **flush** | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | boolean | - | |

‎packages/docs/api/accordion/CAccordionItem.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ import CAccordionItem from '@coreui/vue/src/components/accordion/CAccordionItem'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ----------- | ------------- | -------------- | ------ | ------- |
13-
| **itemKey** | The item key. | number\|string | - | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------ | ------------- | -------------- | ------ | ------- |
13+
| **item-key** | The item key. | number\|string | - | - |

‎packages/docs/api/avatar/CAvatar.api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ import CAvatar from '@coreui/vue/src/components/avatar/CAvatar'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------- | -------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
13-
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
14-
| **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'` | |
15-
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'md'`, `'lg'`, `'xl'` | - |
16-
| **src** | The src attribute for the img element. | string | - | - |
17-
| **status** | Sets the color context of the status indicator to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
18-
| **textColor** | Sets the text color of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |
11+
| Prop name | Description | Type | Values | Default |
12+
| -------------- | -------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
13+
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | |
14+
| **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'` | |
15+
| **size** | Size the component small, large, or extra large. | string | `'sm'`, `'md'`, `'lg'`, `'xl'` | - |
16+
| **src** | The src attribute for the img element. | string | - | - |
17+
| **status** | Sets the color context of the status indicator to one of CoreUI’s themed colors. | string | `'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'` | - |
18+
| **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'`, `'white'`, `'muted'`, `'high-emphasis'`, `'medium-emphasis'`, `'disabled'`, `'high-emphasis-inverse'`, `'medium-emphasis-inverse'`, `'disabled-inverse'` | |

0 commit comments

Comments
 (0)