mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
339 lines
7.6 KiB
Markdown
339 lines
7.6 KiB
Markdown
# Checkbox
|
|
|
|
### Install
|
|
|
|
```js
|
|
import { createApp } from 'vue';
|
|
import { Checkbox, CheckboxGroup } from 'vant';
|
|
|
|
const app = createApp();
|
|
app.use(Checkbox);
|
|
app.use(CheckboxGroup);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```html
|
|
<van-checkbox v-model="checked">Checkbox</van-checkbox>
|
|
```
|
|
|
|
```js
|
|
import { ref } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref(true);
|
|
return {
|
|
checked,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### Disabled
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" disabled>Checkbox</van-checkbox>
|
|
```
|
|
|
|
### Custom Shape
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" shape="square">Checkbox</van-checkbox>
|
|
```
|
|
|
|
### Custom Color
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" checked-color="#ee0a24">Checkbox</van-checkbox>
|
|
```
|
|
|
|
### Custom Icon Size
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" icon-size="24px">Checkbox</van-checkbox>
|
|
```
|
|
|
|
### Custom Icon
|
|
|
|
Use icon slot to custom icon.
|
|
|
|
```html
|
|
<van-checkbox v-model="checked">
|
|
customize icon
|
|
<template #icon="props">
|
|
<img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
|
|
</template>
|
|
</van-checkbox>
|
|
|
|
<style>
|
|
.img-icon {
|
|
height: 20px;
|
|
}
|
|
</style>
|
|
```
|
|
|
|
```js
|
|
import { ref } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref(true);
|
|
return {
|
|
checked,
|
|
activeIcon: 'https://img01.yzcdn.cn/vant/user-active.png',
|
|
inactiveIcon: 'https://img01.yzcdn.cn/vant/user-inactive.png',
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### Disable Label Click
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" label-disabled>Checkbox</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="checked">
|
|
<van-checkbox name="a">Checkbox a</van-checkbox>
|
|
<van-checkbox name="b">Checkbox b</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```js
|
|
import { ref } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref(['a', 'b']);
|
|
return { checked };
|
|
},
|
|
};
|
|
```
|
|
|
|
### Horizontal
|
|
|
|
```html
|
|
<van-checkbox-group v-model="checked" direction="horizontal">
|
|
<van-checkbox name="a">Checkbox a</van-checkbox>
|
|
<van-checkbox name="b">Checkbox b</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```js
|
|
import { ref } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref([]);
|
|
return { checked };
|
|
},
|
|
};
|
|
```
|
|
|
|
### Maximum amount of checked options
|
|
|
|
```html
|
|
<van-checkbox-group v-model="result" :max="2">
|
|
<van-checkbox name="a">Checkbox a</van-checkbox>
|
|
<van-checkbox name="b">Checkbox b</van-checkbox>
|
|
<van-checkbox name="c">Checkbox c</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
### Toggle All
|
|
|
|
```html
|
|
<van-checkbox-group v-model="checked" ref="checkboxGroup">
|
|
<van-checkbox name="a">Checkbox a</van-checkbox>
|
|
<van-checkbox name="b">Checkbox b</van-checkbox>
|
|
<van-checkbox name="c">Checkbox c</van-checkbox>
|
|
</van-checkbox-group>
|
|
|
|
<van-button type="primary" @click="checkAll">Check All</van-button>
|
|
<van-button type="primary" @click="toggleAll">Toggle All</van-button>
|
|
```
|
|
|
|
```js
|
|
import { ref } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref([]);
|
|
const checkboxGroup = ref(null);
|
|
|
|
const checkAll = () => {
|
|
checkboxGroup.value.toggleAll(true);
|
|
}
|
|
const toggleAll = () => {
|
|
checkboxGroup.value.toggleAll();
|
|
},
|
|
|
|
return {
|
|
checked,
|
|
checkAll,
|
|
toggleAll,
|
|
checkboxGroup,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### Inside a Cell
|
|
|
|
```html
|
|
<van-checkbox-group v-model="checked">
|
|
<van-cell-group>
|
|
<van-cell
|
|
v-for="(item, index) in list"
|
|
clickable
|
|
:key="item"
|
|
:title="`Checkbox ${item}`"
|
|
@click="toggle(index)"
|
|
>
|
|
<template #right-icon>
|
|
<van-checkbox
|
|
:name="item"
|
|
:ref="el => checkboxRefs[index] = el"
|
|
@click.stop
|
|
/>
|
|
</template>
|
|
</van-cell>
|
|
</van-cell-group>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```js
|
|
import { ref, onBeforeUpdate } from 'vue';
|
|
|
|
export default {
|
|
setup() {
|
|
const checked = ref([]);
|
|
const checkboxRefs = ref([]);
|
|
const toggle = (index) => {
|
|
checkboxRefs.value[index].toggle();
|
|
};
|
|
|
|
onBeforeUpdate(() => {
|
|
checkboxRefs.value = [];
|
|
});
|
|
|
|
return {
|
|
list: ['a', 'b'],
|
|
toggle,
|
|
checked,
|
|
checkboxRefs,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
## API
|
|
|
|
### Checkbox Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| v-model | Check status | _boolean_ | `false` |
|
|
| name | Checkbox name | _any_ | - |
|
|
| shape | Can be set to `square` | _string_ | `round` |
|
|
| disabled | Disable checkbox | _boolean_ | `false` |
|
|
| label-disabled | Whether to disable label click | _boolean_ | `false` |
|
|
| label-position | Can be set to `left` | _string_ | `right` |
|
|
| icon-size | Icon size | _number \| string_ | `20px` |
|
|
| checked-color | Checked color | _string_ | `#1989fa` | - |
|
|
| bind-group | Whether to bind with CheckboxGroup | _boolean_ | `true` |
|
|
|
|
### CheckboxGroup Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| v-model | Names of all checked checkboxes | _any[]_ | - |
|
|
| disabled | Whether to disable all checkboxes | _boolean_ | `false` |
|
|
| max | Maximum amount of checked options | _number \| string_ | `0`(Unlimited) |
|
|
| direction | Direction, can be set to `horizontal` | _string_ | `vertical` |
|
|
| icon-size | Icon size of all checkboxes | _number \| string_ | `20px` |
|
|
| checked-color | Checked color of all checkboxes | _string_ | `#1989fa` | - |
|
|
|
|
### Checkbox Events
|
|
|
|
| Event | Description | Parameters |
|
|
| ------ | ------------------------------------ | ------------------- |
|
|
| change | Emitted when value changed | _checked: boolean_ |
|
|
| click | Emitted when the checkbox is clicked | _event: MouseEvent_ |
|
|
|
|
### CheckboxGroup Events
|
|
|
|
| Event | Description | Parameters |
|
|
| ------ | -------------------------- | -------------- |
|
|
| change | Emitted when value changed | _names: any[]_ |
|
|
|
|
### Checkbox Slots
|
|
|
|
| Name | Description | SlotProps |
|
|
| ------- | ------------ | ------------------ |
|
|
| default | Custom label | - |
|
|
| icon | Custom icon | _checked: boolean_ |
|
|
|
|
### CheckboxGroup Methods
|
|
|
|
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CheckboxGroup instance and call instance methods.
|
|
|
|
| Name | Description | Attribute | Return value |
|
|
| --- | --- | --- | --- |
|
|
| toggleAll | Toggle check status of all checkboxes | _options?: boolean \| object_ | - |
|
|
|
|
### toggleAll Usage
|
|
|
|
```js
|
|
const { checkboxGroup } = this.$refs;
|
|
|
|
// Toggle all
|
|
checkboxGroup.toggleAll();
|
|
// Select all
|
|
checkboxGroup.toggleAll(true);
|
|
// Unselect all
|
|
checkboxGroup.toggleAll(false);
|
|
|
|
// Toggle all, skip disabled
|
|
checkboxGroup.toggleAll({
|
|
skipDisabled: true,
|
|
});
|
|
// Select all, skip disabled
|
|
checkboxGroup.toggleAll({
|
|
checked: true,
|
|
skipDisabled: true,
|
|
});
|
|
```
|
|
|
|
### Checkbox Methods
|
|
|
|
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Checkbox instance and call instance methods.
|
|
|
|
| Name | Description | Attribute | Return value |
|
|
| ------ | ------------------- | ------------------- | ------------ |
|
|
| toggle | Toggle check status | _checked?: boolean_ | - |
|
|
|
|
### Less Variables
|
|
|
|
How to use: [Custom Theme](#/en-US/theme).
|
|
|
|
| Name | Default Value | Description |
|
|
| --- | --- | --- |
|
|
| @checkbox-size | `20px` | - |
|
|
| @checkbox-border-color | `@gray-5` | - |
|
|
| @checkbox-transition-duration | `@animation-duration-fast` | - |
|
|
| @checkbox-label-margin | `@padding-xs` | - |
|
|
| @checkbox-label-color | `@text-color` | - |
|
|
| @checkbox-checked-icon-color | `@blue` | - |
|
|
| @checkbox-disabled-icon-color | `@gray-5` | - |
|
|
| @checkbox-disabled-label-color | `@gray-5` | - |
|
|
| @checkbox-disabled-background-color | `@border-color` | - |
|