Skip to content

Commit b69bffd

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent fe9ebba commit b69bffd

File tree

6 files changed

+98
-47
lines changed

6 files changed

+98
-47
lines changed

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

+17-9
Large diffs are not rendered by default.

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

+18-9
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,21 @@ import CFormInput from '@coreui/vue/src/components/form/CFormInput'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------- | ------- |
13-
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
14-
| **invalid** | Set component validation state to invalid. | boolean | - | |
15-
| **plain-text** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`. | boolean | - | |
16-
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
17-
| **size** | Size the component small or large. | string | `'sm' \| 'lg'` | - |
18-
| **type** | Specifies the type of component. | string | `'color' \| 'file' \| 'text' \| string` | 'text' |
19-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------- | ------- |
13+
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
14+
| **invalid** | Set component validation state to invalid. | boolean | - | |
15+
| **model-value** | The default name for a value passed using v-model. | string | - | - |
16+
| **plain-text** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`. | boolean | - | |
17+
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
18+
| **size** | Size the component small or large. | string | `'sm' \| 'lg'` | - |
19+
| **type** | Specifies the type of component. | string | `'color' \| 'file' \| 'text' \| string` | 'text' |
20+
| **valid** | Set component validation state to valid. | boolean | - | |
21+
22+
#### Events
23+
24+
| Event name | Description | Properties |
25+
| ---------------------- | ------------------------------------------------------------------------------ | ---------- |
26+
| **change** | Event occurs when the element loses focus, after the content has been changed. |
27+
| **input** | Event occurs immediately after the value of a component has changed. |
28+
| **update-model-value** | Emit the new value whenever there’s an input or change event. |

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

+16-8
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ import CFormRange from '@coreui/vue/src/components/form/CFormRange'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------ | ---------------------------------------------------------------- | ------- | ------ | ------- |
13-
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
14-
| **max** | Specifies the maximum value for the component. | number | - | - |
15-
| **min** | Specifies the minimum value for the component. | number | - | - |
16-
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
17-
| **steps** | Specifies the interval between legal numbers in the component. | number | - | - |
18-
| **value** | The `value` attribute of component.<br/>`@controllable` onChange | number | - | - |
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------- | ---------------------------------------------------------------- | ------- | ------ | ------- |
13+
| **disabled** | Toggle the disabled state for the component. | boolean | - | - |
14+
| **max** | Specifies the maximum value for the component. | number | - | - |
15+
| **min** | Specifies the minimum value for the component. | number | - | - |
16+
| **model-value** | The default name for a value passed using v-model. | string | - | |
17+
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
18+
| **steps** | Specifies the interval between legal numbers in the component. | number | - | - |
19+
| **value** | The `value` attribute of component.<br/>`@controllable` onChange | number | - | - |
20+
21+
#### Events
22+
23+
| Event name | Description | Properties |
24+
| ---------------------- | --------------------------------------------------- | ---------- |
25+
| **change** | Event occurs when the value has been changed. |
26+
| **update-model-value** | Emit the new value whenever there’s a change event. |

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

+15-6
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@ import CFormSelect from '@coreui/vue/src/components/form/CFormSelect'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------- | ------------------------------------------------------------ | ------- | -------------- | ------- |
13-
| **html-size** | Specifies the number of visible options in a drop-down list. | number | - | - |
14-
| **invalid** | Set component validation state to invalid. | boolean | - | |
15-
| **size** | Size the component small or large. | string | `'sm' \| 'lg'` | - |
16-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------- | ------- |
13+
| **html-size** | Specifies the number of visible options in a drop-down list. | number | - | - |
14+
| **invalid** | Set component validation state to invalid. | boolean | - | |
15+
| **model-value** | The default name for a value passed using v-model. | string | - | - |
16+
| **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[] | - | - |
17+
| **size** | Size the component small or large. | string | `'sm' \| 'lg'` | - |
18+
| **valid** | Set component validation state to valid. | boolean | - | |
19+
20+
#### Events
21+
22+
| Event name | Description | Properties |
23+
| ---------------------- | ---------------------------------------------------------------------------------- | ---------- |
24+
| **change** | Event occurs when when a user changes the selected option of a `<select>` element. |
25+
| **update-model-value** | Emit the new value whenever there’s a change event. |

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

+16-8
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ import CFormSwitch from '@coreui/vue/src/components/form/CFormSwitch'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ----------- | -------------------------------------------------------------------------------------------- | ------- | ----------------------- | ---------- |
13-
| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document | string | - | - |
14-
| **invalid** | Set component validation state to invalid. | boolean | - | |
15-
| **label** | The element represents a caption for a component. | string | - | - |
16-
| **size** | Size the component large or extra large. Works only with `switch`. | string | `'lg' \| 'xl'` | - |
17-
| **type** | Specifies the type of component. | string | `'checkbox'`, `'radio'` | 'checkbox' |
18-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------- | -------------------------------------------------------------------------------------------- | --------------- | ----------------------- | ---------- |
13+
| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document | string | - | - |
14+
| **invalid** | Set component validation state to invalid. | boolean | - | |
15+
| **label** | The element represents a caption for a component. | string | - | - |
16+
| **model-value** | The default name for a value passed using v-model. | boolean\|string | - | |
17+
| **size** | Size the component large or extra large. Works only with `switch`. | string | `'lg' \| 'xl'` | - |
18+
| **type** | Specifies the type of component. | string | `'checkbox'`, `'radio'` | 'checkbox' |
19+
| **valid** | Set component validation state to valid. | boolean | - | |
20+
21+
#### Events
22+
23+
| Event name | Description | Properties |
24+
| ---------------------- | ----------------------------------------------------- | ---------- |
25+
| **change** | Event occurs when the checked value has been changed. |
26+
| **update-model-value** | Emit the new value whenever there’s a change event. |

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

+16-7
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,19 @@ import CFormTextarea from '@coreui/vue/src/components/form/CFormTextarea'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ------- |
13-
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
14-
| **invalid** | Set component validation state to invalid. | boolean | - | |
15-
| **plain-text** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`. | boolean | - | |
16-
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
17-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ------- |
13+
| **disabled** | Toggle the disabled state for the component. | boolean | - | |
14+
| **invalid** | Set component validation state to invalid. | boolean | - | |
15+
| **model-value** | The default name for a value passed using v-model. | string | - | - |
16+
| **plain-text** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`. | boolean | - | |
17+
| **readonly** | Toggle the readonly state for the component. | boolean | - | |
18+
| **valid** | Set component validation state to valid. | boolean | - | |
19+
20+
#### Events
21+
22+
| Event name | Description | Properties |
23+
| ---------------------- | ------------------------------------------------------------------------------ | ---------- |
24+
| **change** | Event occurs when the element loses focus, after the content has been changed. |
25+
| **input** | Event occurs immediately after the value of a component has changed. |
26+
| **update-model-value** | Emit the new value whenever there’s an input or change event. |

0 commit comments

Comments
 (0)