当前位置: 首页 > 文档资料 > Vant 中文文档 >

Radio 单选框

优质
小牛编辑
133浏览
2023-12-01

介绍

用于在多个选项中选择单个结果。

引入

import { createApp } from 'vue';
import { RadioGroup, Radio } from 'vant';

const app = createApp();
app.use(Radio);
app.use(RadioGroup);

代码演示

基础用法

通过 v-model 绑定值当前选中项的 name。

<van-radio-group v-model="radio">
  <van-radio name="1">单选框 1</van-radio>
  <van-radio name="2">单选框 2</van-radio>
</van-radio-group>
export default {
  data() {
    return {
      radio: '1',
    };
  },
};

水平排列

direction 属性设置为 horizontal 后,单选框组会变成水平排列。

<van-radio-group v-model="radio" direction="horizontal">
  <van-radio name="1">单选框 1</van-radio>
  <van-radio name="2">单选框 2</van-radio>
</van-radio-group>

禁用状态

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

<van-radio-group v-model="radio" disabled>
  <van-radio name="1">单选框 1</van-radio>
  <van-radio name="2">单选框 2</van-radio>
</van-radio-group>

自定义形状

shape 属性设置为 square,单选框的形状会变成方形。

<van-radio-group v-model="radio">
  <van-radio name="1" shape="square">单选框 1</van-radio>
  <van-radio name="2" shape="square">单选框 2</van-radio>
</van-radio-group>

自定义颜色

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

<van-radio-group v-model="radio">
  <van-radio name="1" checked-color="#07c160">单选框 1</van-radio>
  <van-radio name="2" checked-color="#07c160">单选框 2</van-radio>
</van-radio-group>

自定义大小

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

<van-radio-group v-model="radio">
  <van-radio name="1" icon-size="24px">单选框 1</van-radio>
  <van-radio name="2" icon-size="24px">单选框 2</van-radio>
</van-radio-group>

自定义图标

通过 icon 插槽自定义图标,并通过 slotProps 判断是否为选中状态。

<van-radio-group v-model="radio">
  <van-radio name="1">
    单选框 1
    <template #icon="props">
      <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
    </template>
  </van-radio>
  <van-radio name="2">
    单选框 2
    <template #icon="props">
      <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
    </template>
  </van-radio>
</van-radio-group>

<style>
  .img-icon {
    height: 20px;
  }
</style>
export default {
  data() {
    return {
      radio: '1',
      activeIcon: 'https://img.yzcdn.cn/vant/user-active.png',
      inactiveIcon: 'https://img.yzcdn.cn/vant/user-inactive.png',
    };
  },
};

禁用文本点击

设置 label-disabled 属性后,点击图标以外的内容不会触发单选框切换。

<van-radio-group v-model="radio">
  <van-radio name="1" label-disabled>单选框 1</van-radio>
  <van-radio name="2" label-disabled>单选框 2</van-radio>
</van-radio-group>

与 Cell 组件一起使用

此时你需要再引入 CellCellGroup 组件。

<van-radio-group v-model="radio">
  <van-cell-group>
    <van-cell title="单选框 1" clickable @click="radio = '1'">
      <template #right-icon>
        <van-radio name="1" />
      </template>
    </van-cell>
    <van-cell title="单选框 2" clickable @click="radio = '2'">
      <template #right-icon>
        <van-radio name="2" />
      </template>
    </van-cell>
  </van-cell-group>
</van-radio-group>

API

Radio Props

参数说明类型默认值
name标识符any-
shape形状,可选值为 squarestringround
disabled是否为禁用状态booleanfalse
label-disabled是否禁用文本内容点击booleanfalse
label-position文本位置,可选值为 leftstringright
icon-size图标大小,默认单位为pxnumber / string20px
checked-color选中状态颜色string#1989fa

RadioGroup Props

参数说明类型默认值
v-model (value)当前选中项的标识符any-
disabled是否禁用所有单选框booleanfalse
direction v2.5.0排列方向,可选值为horizontalstringvertical
icon-size所有单选框的图标大小,默认单位为pxnumber / string20px
checked-color所有单选框的选中状态颜色string#1989fa

Radio Events

事件名说明回调参数
click点击单选框时触发event: Event

RadioGroup Events

事件名说明回调参数
change当绑定值变化时触发的事件name: string

Radio Slots

名称说明参数
default自定义文本-
icon自定义图标checked: boolean