taolin/docs_vue2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat: add link for individual props/events/slots/configs/icons

Browse Source
This commit is contained in:
Justineo
2021-10-20 01:11:27 +08:00
parent df2b6892d2
commit b0dcdbb873
162 changed files with 2176 additions and 2073 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
one/docs/en-US/components/checkbox.md
View File

@@ -4,13 +4,13 @@
### Size variants
Available size variant for the `ui` prop: `s`/`m`.
Available size variant for the [`ui`](#props-ui) prop: `s` / `m`.
[[ demo src="/demo/checkbox/size.vue" ]]
### True/false values
Use the `true-value` and `false-value` props to customize the `model` value (used in its `v-model`) of the checkbox in checked/unchecked state.
Use the [`true-value`](#props-true-value) and [`false-value`](#props-false-value) props to customize the `model` value (used in its `v-model`) of the checkbox in checked/unchecked state.
[[ demo src="/demo/checkbox/value.vue" ]]
@@ -20,14 +20,14 @@ Use the `true-value` and `false-value` props to customize the `model` value (use
| Name | Type | Default | Description |
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `checked` | `boolean` | `false` | [^checked] |
| `value` | `*` | - | Denotes the value of current checkbox when `v-model` is bound to an array. |
| `true-value` | `*=` | `true` | The value for checked state. |
| `false-value` | `*=` | `false` | The value for unchecked state. |
| `indeterminate` | `boolean=` | `false` | Whether the checkbox is in an indeterminate state. |
| `disabled` | `boolean=` | `false` | Whether the checkbox is disabled. |
| `readonly` | `boolean=` | `false` | Whether the checkbox is read-only. |
| ``ui`` | `string=` | - | [^ui] |
| ``checked`` | `boolean` | `false` | [^checked] |
| ``value`` | `*` | - | Denotes the value of current checkbox when `v-model` is bound to an array. |
| ``true-value`` | `*=` | `true` | The value for checked state. |
| ``false-value`` | `*=` | `false` | The value for unchecked state. |
| ``indeterminate`` | `boolean=` | `false` | Whether the checkbox is in an indeterminate state. |
| ``disabled`` | `boolean=` | `false` | Whether the checkbox is disabled. |
| ``readonly`` | `boolean=` | `false` | Whether the checkbox is read-only. |
^^^ui
Style variants.
@@ -52,21 +52,21 @@ Whether the checkbox is checked.
| Name | Description |
| -- | -- |
| `default` | The label text of the checkbox. The checkbox is toggled when the label is clicked. Displays nothing by default. |
| ``default`` | The label text of the checkbox. The checkbox is toggled when the label is clicked. Displays nothing by default. |
### Events
| Name | Description |
| -- | -- |
| `change` | Triggered when user toggles the state of the checkbox. The callback parameter list is `(checked: boolean)`. `checked` denotes whether the checkbox is checked. |
| `input` | [^event-input] |
| ``change`` | Triggered when user toggles the state of the checkbox. The callback parameter list is `(checked: boolean)`. `checked` denotes whether the checkbox is checked. |
| ``input`` | [^event-input] |
^^^event-input
:::badges
`v-model`
:::
Triggered when the check state is changed. The callback parameter list is `(val: *)`, with `val` being the current value of `v-model`. Unlike the `change` event, `input` is triggered even without user interaction.
Triggered when the check state is changed. The callback parameter list is `(val: *)`, with `val` being the current value of `v-model`. Unlike the [`change`](#events-change) event, `input` is triggered even without user interaction.
^^^
Additionally, `Checkbox` exposes the following native events:
@@ -79,5 +79,5 @@ The callback parameter is the corresponding native event object for all events a
| Name | Description |
| -- | -- |
| `checked` | Checked state. |
| `indeterminate` | Indeterminate state. |
| ``checked`` | Checked state. |
| ``indeterminate`` | Indeterminate state. |