mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
120 lines
2.5 KiB
Markdown
120 lines
2.5 KiB
Markdown
# Switch 开关
|
|
|
|
### 介绍
|
|
|
|
用于在打开和关闭状态之间进行切换。
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-switch": "@vant/weapp/switch/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
```html
|
|
<van-switch checked="{{ checked }}" bind:change="onChange" />
|
|
```
|
|
|
|
```javascript
|
|
Page({
|
|
data: {
|
|
checked: true,
|
|
},
|
|
|
|
onChange({ detail }) {
|
|
// 需要手动对 checked 状态进行更新
|
|
this.setData({ checked: detail });
|
|
},
|
|
});
|
|
```
|
|
|
|
### 禁用状态
|
|
|
|
```html
|
|
<van-switch checked="{{ checked }}" disabled />
|
|
```
|
|
|
|
### 加载状态
|
|
|
|
```html
|
|
<van-switch checked="{{ checked }}" loading />
|
|
```
|
|
|
|
### 自定义大小
|
|
|
|
```html
|
|
<van-switch checked="{{ checked }}" size="24px" />
|
|
```
|
|
|
|
### 自定义颜色
|
|
|
|
```html
|
|
<van-switch
|
|
checked="{{ checked }}"
|
|
active-color="#07c160"
|
|
inactive-color="#ee0a24"
|
|
/>
|
|
```
|
|
|
|
### 异步控制
|
|
|
|
```html
|
|
<van-switch checked="{{ checked }}" bind:change="onChange" />
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
checked: true,
|
|
},
|
|
|
|
onChange({ detail }) {
|
|
wx.showModal({
|
|
title: '提示',
|
|
content: '是否切换开关？',
|
|
success: (res) => {
|
|
if (res.confirm) {
|
|
this.setData({ checked2: detail });
|
|
}
|
|
},
|
|
});
|
|
},
|
|
});
|
|
```
|
|
|
|
## API
|
|
|
|
### Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| -------------- | ---------------------- | --------- | --------- |
|
|
| name | 在表单内提交时的标识符 | _string_ | - |
|
|
| checked | 开关选中状态 | _any_ | `false` |
|
|
| loading | 是否为加载状态 | _boolean_ | `false` |
|
|
| disabled | 是否为禁用状态 | _boolean_ | `false` |
|
|
| size | 开关尺寸 | _string_ | `30px` |
|
|
| active-color | 打开时的背景色 | _string_ | `#1989fa` |
|
|
| inactive-color | 关闭时的背景色 | _string_ | `#fff` |
|
|
| active-value | 打开时的值 | _any_ | `true` |
|
|
| inactive-value | 关闭时的值 | _any_ | `false` |
|
|
|
|
### Events
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
| ----------- | ---------------- | -------------------------- |
|
|
| bind:change | 开关状态切换回调 | event.detail: 是否选中开关 |
|
|
|
|
### 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
| ------------ | ------------ |
|
|
| custom-class | 根节点样式类 |
|
|
| node-class | 圆点样式类 |
|