Skip to content

Commit 8da6775

Browse files
mrholekmrholek
committed
docs: update documentation
1 parent f403793 commit 8da6775

26 files changed

+1423
-464
lines changed

‎packages/docs/.vuepress/config.ts

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,33 +105,49 @@ export default defineUserConfig<DefaultThemeOptions>({
105105
icon: `<rect width="288" height="32" x="112" y="152" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="288" height="32" x="112" y="240" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="152" height="32" x="112" y="328" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><path fill="var(--ci-primary-color, currentColor)" d="M480,48H32V464H480ZM448,432H64V80H448Z" class="ci-primary"></path>`,
106106
link: `/forms/`,
107107
children: [
108+
// {
109+
// text: 'Overview',
110+
// link: `/forms/overview.html`,
111+
// },
108112
{
109-
text: 'Overview',
110-
link: `/forms/overview.html`,
113+
text: 'Checkbox',
114+
link: `/forms/checkbox.html`,
111115
},
112116
{
113-
text: 'Form control',
114-
link: `/forms/form-control.html`,
117+
text: 'Input',
118+
link: `/forms/input.html`,
115119
},
116120
{
117-
text: 'Select',
118-
link: `/forms/select.html`,
121+
text: 'Input group',
122+
link: `/forms/input-group.html`,
119123
},
120124
{
121-
text: 'Checks & radios',
122-
link: `/forms/checks-radios.html`,
125+
text: 'Radio',
126+
link: `/forms/radio.html`,
123127
},
128+
// {
129+
// text: 'Checks & radios',
130+
// link: `/forms/checks-radios.html`,
131+
// },
124132
{
125133
text: 'Range',
126134
link: `/forms/range.html`,
127135
},
128136
{
129-
text: 'Floating labels',
130-
link: `/forms/floating-labels.html`,
137+
text: 'Select',
138+
link: `/forms/select.html`,
131139
},
132140
{
133-
text: 'Input group',
134-
link: `/forms/input-group.html`,
141+
text: 'Switch',
142+
link: `/forms/switch.html`,
143+
},
144+
{
145+
text: 'Textarea',
146+
link: `/forms/textarea.html`,
147+
},
148+
{
149+
text: 'Floating labels',
150+
link: `/forms/floating-labels.html`,
135151
},
136152
{
137153
text: 'Layout',

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

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

99
#### Props
1010

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 |
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` 'line' \| 'bar' \| 'radar' \| 'doughnut' \| 'polarArea' \| 'bubble' \| 'pie' \| 'scatter' | ChartType | - | '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

‎packages/docs/api/button/CButton.api.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,20 @@ import CButton from '@coreui/vue/src/components/button/CButton'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------- | --------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
13-
| **active** | Toggle the active state for the component. | boolean | - | false |
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-
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
16-
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
17-
| **href** | The href attribute specifies the URL of the page the link goes to. | string | - | - |
18-
| **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'` | |
19-
| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
20-
| **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+
| **active** | Toggle the active state for the component. | boolean | - | false |
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+
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'button' |
16+
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
17+
| **href** | The href attribute specifies the URL of the page the link goes to. | string | - | - |
18+
| **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'` | |
19+
| **size** | Size the component small or large. | string | `'sm'`, `'lg'` | - |
20+
| **type** | Specifies the type of button. Always specify the type attribute for the `<button>` element.<br>Different browsers may use different default types for the `<button>` element. | string | `'button'`, `'submit'`, `'reset'` | 'button' |
21+
| **variant** | Set the button variant to an outlined button or a ghost button. | string | `'ghost'`, `'outline'` | - |
22+
23+
#### Events
24+
25+
| Event name | Description | Properties |
26+
| ---------- | ------------------------------------------------ | ---------- |
27+
| **click** | Event called when the user clicks on the button. |

0 commit comments

Comments
 (0)