mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
186 lines
4.0 KiB
Markdown
186 lines
4.0 KiB
Markdown
# Radio 单选框
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-radio": "path/to/vant-weapp/dist/radio/index",
|
|
"van-radio-group": "path/to/vant-weapp/dist/radio-group/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
通过`value`绑定值当前选中项的 name
|
|
|
|
```html
|
|
<van-radio-group value="{{ radio }}" bind:change="onChange">
|
|
<van-radio name="1">单选框 1</van-radio>
|
|
<van-radio name="2">单选框 2</van-radio>
|
|
</van-radio-group>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
radio: '1'
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
checked: event.detail
|
|
});
|
|
}
|
|
});
|
|
```
|
|
|
|
### 禁用状态
|
|
|
|
通过`disabled`属性禁止选项切换，在`van-radio`上设置`diabled`可以禁用单个选项
|
|
|
|
```html
|
|
<van-radio-group value="{{ radio }}" bind:change="onChange" disabled>
|
|
<van-radio name="1">单选框 1</van-radio>
|
|
<van-radio name="2">单选框 2</van-radio>
|
|
</van-radio-group>
|
|
```
|
|
|
|
### 自定义颜色
|
|
|
|
```html
|
|
<van-radio checked-color="#07c160">复选框</van-radio>
|
|
```
|
|
|
|
### 自定义图标
|
|
|
|
通过 icon 插槽自定义图标
|
|
|
|
```html
|
|
<van-radio use-icon-slot value="{{ radio }}" name="1" bind:change="onChange">
|
|
自定义图标
|
|
<image
|
|
slot="icon"
|
|
src="{{ radio === '1' ? icon.active : icon.normal }}"
|
|
/>
|
|
</van-radio>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
radio: true,
|
|
icon: {
|
|
normal: '//img.yzcdn.cn/icon-normal.png',
|
|
active: '//img.yzcdn.cn/icon-active.png'
|
|
}
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
radio: event.detail
|
|
});
|
|
}
|
|
});
|
|
```
|
|
|
|
### 与 Cell 组件一起使用
|
|
|
|
此时你需要再引入`Cell`和`CellGroup`组件。
|
|
|
|
```html
|
|
<van-radio-group value="{{ radio }}" bind:change="onChange">
|
|
<van-cell-group>
|
|
<van-cell
|
|
title="单选框 1"
|
|
value-class="value-class"
|
|
clickable
|
|
data-name="1"
|
|
bind:click="onClick"
|
|
>
|
|
<van-radio name="1" />
|
|
</van-cell>
|
|
<van-cell
|
|
title="单选框 2"
|
|
value-class="value-class"
|
|
clickable
|
|
data-name="2"
|
|
bind:click="onClick"
|
|
>
|
|
<van-radio name="2" />
|
|
</van-cell>
|
|
</van-cell-group>
|
|
</van-radio-group>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
radio: '1'
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
radio: event.detail
|
|
});
|
|
},
|
|
|
|
onClick(event) {
|
|
const { name } = event.currentTarget.dataset;
|
|
this.setData({
|
|
radio: name
|
|
});
|
|
}
|
|
});
|
|
```
|
|
|
|
```css
|
|
.value-class {
|
|
flex: none !important;
|
|
}
|
|
```
|
|
|
|
### Radio API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| name | 标识 Radio 名称 | *string* | - | - |
|
|
| value | 当前选中项的 name | *any* | - | - |
|
|
| shape | 形状，可选值为 `round` `square` | *string* | `round` | - |
|
|
| disabled | 是否为禁用状态 | *boolean* | `false` | - |
|
|
| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` | - |
|
|
| label-position | 文本位置，可选值为 `left` | *string* | `right` | - |
|
|
| use-icon-slot | 是否使用 icon slot | *boolean* | `false` | - |
|
|
| checked-color | 选中状态颜色 | *string* | `#1989fa` | - |
|
|
|
|
### Radio Event
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| bind:change | 当绑定值变化时触发的事件 | 当前选中项的 name |
|
|
|
|
### Radio 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
|-----------|-----------|
|
|
| custom-class | 根节点样式类 |
|
|
| icon-class | 图标样式类 |
|
|
| label-class | 描述信息样式类 |
|
|
|
|
### RadioGroup API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| name | 在表单内提交时的标识符 | *string* | - | - |
|
|
| value | 当前选中项的 name | *any* | - | - |
|
|
| disabled | 是否禁用所有单选框 | *boolean* | `false` | - |
|
|
|
|
### RadioGroup Event
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| bind:change | 当绑定值变化时触发的事件 | 当前选中项的 name |
|