mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
d8b6ad7d54
* fix: Tabbar icon line-height * [new feature] progress add showPivot prop * [new feature] TabItem support vue-router * [new feature] update document header style * [Doc] add toast english ducoment * [new feature] add i18n support * feat: Extract demos from markdown * feat: Base components demos * [new feature] complete demo extract & translate * [fix] text cases * fix: add deepAssign test cases * fix: changelog detail * [new feature] AddressEdit support i18n
98 lines
2.0 KiB
Markdown
98 lines
2.0 KiB
Markdown
## Checkbox
|
|
|
|
### Install
|
|
``` javascript
|
|
import { Checkbox, CheckboxGroup } from 'vant';
|
|
|
|
Vue.component(Checkbox.name, Checkbox);
|
|
Vue.component(CheckboxGroup.name, CheckboxGroup);
|
|
```
|
|
|
|
### Usage
|
|
|
|
#### Basic Usage
|
|
|
|
```html
|
|
<van-checkbox v-model="checked">Checkbox 1</van-checkbox>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
checked: true
|
|
};
|
|
}
|
|
};
|
|
```
|
|
|
|
#### Disabled
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" disabled>Checkbox 2</van-checkbox>
|
|
```
|
|
|
|
#### Checkbox Group
|
|
When Checkboxes are inside a CheckboxGroup, the checked checkboxes's name is an array and bound with CheckboxGroup by v-model.
|
|
|
|
```html
|
|
<van-checkbox-group v-model="result">
|
|
<van-checkbox
|
|
v-for="(item, index) in list"
|
|
:key="index"
|
|
:name="item"
|
|
>
|
|
Checkbox {{ item }}
|
|
</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
list: ['a', 'b', 'c'],
|
|
result: ['a', 'b']
|
|
};
|
|
}
|
|
};
|
|
```
|
|
|
|
#### Inside a Cell
|
|
|
|
```html
|
|
<van-checkbox-group v-model="result">
|
|
<van-cell-group>
|
|
<van-cell v-for="(item, index) in list" :key="index">
|
|
<van-checkbox :name="item">Checkbox {{ item }}</van-checkbox>
|
|
</van-cell>
|
|
</van-cell-group>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
### Checkbox API
|
|
|
|
| Attribute | Description | Type | Default | Accepted Values |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| name | Checkbox name | `Boolean` | `false` | - |
|
|
| disabled | Diable checkbox | `Boolean` | `false` | - |
|
|
| shape | Checkbox shape | `String` | `round` | `square` |
|
|
|
|
### CheckboxGroup API
|
|
|
|
| Attribute | Description | Type | Default | Accepted Values |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| disabled | Disable all checkboxes | `Boolean` | `false` | - |
|
|
|
|
### Checkbox Event
|
|
|
|
| Event | Description | Parameters |
|
|
|-----------|-----------|-----------|
|
|
| change | Triggered when value changed | current value |
|
|
|
|
### CheckboxGroup Event
|
|
|
|
| Event | Description | Parameters |
|
|
|-----------|-----------|-----------|
|
|
| change | Triggered when value changed | current value |
|