Skip to content

Commit

Permalink
docs: update component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlmoravek
mlmoravek committed Apr 21, 2024
1 parent 29a114c commit 02d1552
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 116 deletions.
33 changes: 16 additions & 17 deletions packages/docs/components/Checkbox.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,22 @@ title: Checkbox

### Props

| Prop name | Description | Type | Values | Default |
| ------------------ | ------------------------------------------------------------------------------------ | ------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ariaLabelledby | Accessibility label to establish relationship between the checkbox and control label | string | - | Default function (see source code) |
| autocomplete | Same as native autocomplete options to use in HTML5 validation | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;autocomplete: "off"<br>}</code> |
| disabled | Same as native disabled | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| falseValue | Overrides the returned value when it's not checked | string\|number\|boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| indeterminate | Same as native indeterminate | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| label | Input label, unnecessary when default slot is used | string | - | |
| name | Same as native name | string | - | |
| nativeValue | Same as native value | string\|number\|boolean | - | |
| override | Override existing theme classes completely | boolean | - | |
| required | Same as native required | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| size | Size of the control | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| trueValue | Overrides the returned value when it's checked | string\|number\|boolean | - | <code style='white-space: nowrap; padding: 0;'>true</code> |
| useHtml5Validation | Enable html 5 native validation | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>{<br>&nbsp;&nbsp;useHtml5Validation: true<br>}</code> |
| v-model | | string\|number\|boolean\|array | - | |
| variant | Color of the control | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |
| Prop name | Description | Type | Values | Default |
| ------------------ | -------------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| autocomplete | Same as native autocomplete options to use in HTML5 validation | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;autocomplete: "off"<br>}</code> |
| disabled | Same as native disabled | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| falseValue | Overrides the returned value when it's not checked | string\|number\|boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| indeterminate | Same as native indeterminate | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| label | Input label, unnecessary when default slot is used | string | - | |
| name | Same as native name | string | - | |
| nativeValue | Same as native value | string\|number\|boolean | - | |
| override | Override existing theme classes completely | boolean | - | |
| required | Same as native required | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| size | Size of the control | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| trueValue | Overrides the returned value when it's checked | string\|number\|boolean | - | <code style='white-space: nowrap; padding: 0;'>true</code> |
| useHtml5Validation | Enable html 5 native validation | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>{<br>&nbsp;&nbsp;useHtml5Validation: true<br>}</code> |
| v-model | | string\|number\|boolean\|array | - | |
| variant | Color of the control | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |

### Events

Expand Down

0 comments on commit 02d1552

Please sign in to comment.