8000 docs: update API documentation · suny2042/coreui-vue@4e6611b · GitHub
[go: up one dir, main page]
8000 Skip to content

Commit 4e6611b

< 8000 span role="tooltip" aria-label="Browse the repository at this point in the history" id=":R1abab:" class="Tooltip__TooltipBase-sc-17tf59c-0 jjwhNb d-none d-md-flex tooltipped-sw">Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent ab91bac commit 4e6611b

File tree

7 files changed

+51
-51
lines changed

7 files changed

+51
-51
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ import CFormCheck from '@coreui/vue/src/components/form/CFormCheck'
88

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------------- | ---------- |
13-
| **button** | Create button-like checkboxes and radio buttons.<br/>`@see` http://coreui.io/vue/docs/components/button.html | object | - | |
14-
| **feedback** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback.false | string | - | |
15-
| **feedback-invalid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback.false | string | - | |
16-
| **feedback-valid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.false | string | - | |
17-
| **hit-area** | Sets hit area to the full area of the component. | string | - | |
18-
| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document. | string | - | |
19-
| **indeterminate** | Input Checkbox indeterminate Property | boolean | - | |
20-
| **inline** | Group checkboxes or radios on the same horizontal row by adding. | boolean | - | |
21-
| **invalid** | Set component validation state to invalid. | boolean | - | |
22-
| **label** | The element represents a caption for a component. | string | - | |
23-
| **model-value** | The default name for a value passed using v-model. | boolean\|string | - | |
24-
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip.false | boolean | - | |
25-
| **type** | Specifies the type of component. | string | `'checkbox'`, `'radio'` | 'checkbox' |
26-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------------- | ---------- |
13+
| **button** | Create button-like checkboxes and radio buttons.<br/>`@see` http://coreui.io/vue/docs/components/button.html | object | - | |
14+
| **feedback** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | |
15+
| **feedback-invalid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | |
16+
| **feedback-valid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | |
17+
| **hit-area** | Sets hit area to the full area of the component. | string | - | |
18+
| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document. | string | - | |
19+
| **indeterminate** | Input Checkbox indeterminate Property | boolean | - | |
20+
| **inline** | Group checkboxes or radios on the same horizontal row by adding. | boolean | - | |
21+
| **invalid** | Set component validation state to invalid. | boolean | - | |
22+
| **label** | The element represents a caption for a component. | string | - | |
23+
| **model-value** | The default name for a value passed using v-model. | boolean\|string | - | |
24+
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip. | boolean | - | |
25+
| **type** | Specifies the type of component. | string | `'checkbox'`, `'radio'` | 'checkbox' |
26+
| **valid** | Set component validation state to valid. | boolean | - | |
2727

2828
#### Events
2929

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

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

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ------- |
13-
| **feedback** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback.false | string | - | |
14-
| **feedback-invalid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback.false | string | - | |
15-
| **feedback-valid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.false | string | - | |
16-
| **invalid** | Set component validation state to invalid. | boolean | - | |
17-
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip.false | boolean | - | |
18-
| **valid** | Set component validation state to valid. | boolean | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ------- |
13+
| **feedback** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | |
14+
| **feedback-invalid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable feedback. | string | - | |
15+
| **feedback-valid** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | |
16+
| **invalid** | Set component validation state to invalid. | boolean | - | |
17+
| **tooltip-feedback** <br><div class="badge bg-primary">4.3.0+</div> | Display validation feedback in a styled tooltip. | boolean | - | |
18+
| **valid** | Set component validation state to valid. | boolean | - | |

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

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

99
#### Props
1010

11-
| Prop name | Description | Type | Values | Default |
12-
| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ------- |
13-
| **floating-label** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.false | string | - | |
14-
| **label** <br><div class="badge bg-primary">4.3.0+</div> | Add a caption for a component.false | string | - | |
15-
| **text** <br><div class="badge bg-primary">4.3.0+</div> | Add helper text to the component.false | string | - | |
11+
| Prop name | Description | Type | Values | Default |
12+
| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ------- |
13+
| **floating-label** <br><div class="badge bg-primary">4.3.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | string | - | |
14+
| **label** <br><div class="badge bg-primary">4.3.0+&l 3B2E t;/div> | Add a caption for a component. | string | - | |
15+
| **text** <br><div class="badge bg-primary">4.3.0+</div> | Add helper text to the component. | string | - | |

0 commit comments

Comments
 (0)
0