# Radio 单选框

### 引入

在`index.config.js中引入组件

```json
"usingComponents": {
  "van-radio": "@vant/weapp/radio/index",
  "van-radio-group": "@vant/weapp/radio-group/index"
}
```

## 代码演示

### 基础用法

通过`value`绑定值当前选中项的 name

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1">单选框 1</van-radio>
  <van-radio name="2">单选框 2</van-radio>
</van-radio-group>
```

```js

  state= {
    radio: '1',
  };
  onChange(event) {
    this.setState({
      radio: event.detail,
    });
  }

```

### 禁用状态

通过`disabled`属性禁止选项切换，在`Radio`上设置`diabled`可以禁用单个选项

```html
<van-radio-group value={ this.state.radio } disabled onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1">单选框 1</van-radio>
  <van-radio name="2">单选框 2</van-radio>
</van-radio-group>
```

### 自定义形状

将`shape`属性设置为`square`，单选框的形状会变成方形

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1" shape="square">单选框 1</van-radio>
  <van-radio name="2" shape="square">单选框 2</van-radio>
</van-radio-group>
```

### 自定义颜色

通过`checked-color`属性设置选中状态的图标颜色

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1" checkedColor="#07c160">单选框 1</van-radio>
  <van-radio name="2" checkedColor="#07c160">单选框 2</van-radio>
</van-radio-group>
```

### 自定义大小

通过`icon-size`属性可以自定义图标的大小

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1" iconSize="24px">单选框 1</van-radio>
  <van-radio name="2" iconSize="24px">单选框 2</van-radio>
</van-radio-group>
```

### 自定义图标

通过`icon`插槽自定义图标，需要设置`use-icon-slot`属性

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio useIconSlot value={ this.state.radio } name="1">
    自定义图标
    <image slot="icon" src={ this.state.radio === '1' ? this.state.icon.active : this.state.icon.normal } />
  </van-radio>
  <van-radio use-icon-slot value={ this.state.radio } name="2">
    自定义图标
    <image slot="icon" src={ this.state.radio === '2' ? this.state.icon.active : this.state.icon.normal } />
  </van-radio>
</van-radio-group>
```

```js

  state= {
    radio: true,
    icon: {
      normal: '//img.yzcdn.cn/icon-normal.png',
      active: '//img.yzcdn.cn/icon-active.png',
    },
  },
  onChange(event) {
    this.setState({
      radio: event.detail,
    });
  },

```

### 禁用文本点击

通过设置`label-disabled`属性可以禁用单选框文本点击

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-radio name="1" labelDisabled>单选框 1</van-radio>
  <van-radio name="2" labelDisabled>单选框 2</van-radio>
</van-radio-group>
```

### 与 Cell 组件一起使用

此时你需要再引入`Cell`和`CellGroup`组件。

```html
<van-radio-group value={ this.state.radio } onChange={(e)=>{this.onChange(e)}}>
  <van-cell-group>
    <van-cell title="单选框 1" clickable data-name="1" onClick={(e)=>{this.onClick(e)}>
      <van-radio slot="right-icon" name="1" />
    </van-cell>
    <van-cell title="单选框 2" clickable data-name="2" onClick={(e)=>{this.onClick(e)}>
      <van-radio slot="right-icon" name="2" />
    </van-cell>
  </van-cell-group>
</van-radio-group>
```

```js

  state: {
    radio: '1',
  };

  onChange(event) {
    this.setState({
      radio: event.detail,
    });
  };

  onClick(event) {
    const { name } = event.currentTarget.dataset;
    this.setState({
      radio: name,
    });
  },

```

## API
### 注:属性应用在组件上需要统一使用驼峰式命名，如custom-class应变为
```html
<van-button type="primary" customClass='myClass' size="large">大号按钮</van-button>
```
### 注:事件应用在组件上需要统一使用驼峰式命名，如bind:click/bind:search/bind:before-enter应变为
```html
<van-button type="primary" onClick={()=>this.onClick()}>大号按钮</van-button>
<van-search type="primary" onSearch={()=>this.onSearch()}>大号按钮</van-search>
<van-transition type="primary" onBeforeEnter={()=>this.onBeforeEnter()}>大号按钮</van-transition>
```
### RadioGroup Props

| 参数     | 说明                   | 类型      | 默认值  | 版本 |
| -------- | ---------------------- | --------- | ------- | ---- |
| name     | 在表单内提交时的标识符 | _string_  | -       | -    |
| value    | 当前选中项的标识符     | _any_     | -       | -    |
| disabled | 是否禁用所有单选框     | _boolean_ | `false` | -    |

### Radio Props

| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| name | 标识符 | _string_ | - | - |
| shape | 形状，可选值为 `square` | _string_ | `round` | - |
| disabled | 是否为禁用状态 | _boolean_ | `false` | - |
| label-disabled | 是否禁用文本内容点击 | _boolean_ | `false` | - |
| label-position | 文本位置，可选值为 `left` | _string_ | `right` | - |
| icon-size | 图标大小，默认单位为`px` | _string \| number_ | `20px` | - |
| checked-color | 选中状态颜色 | _string_ | `#1989fa` | - |
| use-icon-slot | 是否使用 icon 插槽 | _boolean_ | `false` | - |

### Radio Event

| 事件名      | 说明                     | 回调参数          |
| ----------- | ------------------------ | ----------------- |
| bind:change | 当绑定值变化时触发的事件 | 当前选中项的 name |

### Radio 外部样式类

| 类名         | 说明           |
| ------------ | -------------- |
| custom-class | 根节点样式类   |
| icon-class   | 图标样式类     |
| label-class  | 描述信息样式类 |

### RadioGroup Event

| 事件名      | 说明                     | 回调参数          |
| ----------- | ------------------------ | ----------------- |
| bind:change | 当绑定值变化时触发的事件 | 当前选中项的 name |