Radio 单选框

介绍

在一组备选项中进行单选。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { RadioGroup, Radio } from 'vant';
  3. const app = createApp();
  4. app.use(Radio);
  5. app.use(RadioGroup);

代码演示

基础用法

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

  1. <van-radio-group v-model="checked">
  2. <van-radio name="1">单选框 1</van-radio>
  3. <van-radio name="2">单选框 2</van-radio>
  4. </van-radio-group>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const checked = ref('1');
  5. return { checked };
  6. },
  7. };

水平排列

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

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

禁用状态

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

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

自定义形状

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

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

自定义颜色

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

  1. <van-radio-group v-model="checked">
  2. <van-radio name="1" checked-color="#ee0a24">单选框 1</van-radio>
  3. <van-radio name="2" checked-color="#ee0a24">单选框 2</van-radio>
  4. </van-radio-group>

自定义大小

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

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

自定义图标

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

  1. <van-radio-group v-model="checked">
  2. <van-radio name="1">
  3. 单选框 1
  4. <template #icon="props">
  5. <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
  6. </template>
  7. </van-radio>
  8. <van-radio name="2">
  9. 单选框 2
  10. <template #icon="props">
  11. <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
  12. </template>
  13. </van-radio>
  14. </van-radio-group>
  15. <style>
  16. .img-icon {
  17. height: 20px;
  18. }
  19. </style>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const checked = ref('1');
  5. return {
  6. checked,
  7. activeIcon:
  8. 'https://fastly.jsdelivr.net/npm/@vant/assets/user-active.png',
  9. inactiveIcon:
  10. 'https://fastly.jsdelivr.net/npm/@vant/assets/user-inactive.png',
  11. };
  12. },
  13. };

禁用文本点击

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

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

搭配单元格组件使用

搭配单元格组件使用时,需要再引入 CellCellGroup 组件。

  1. <van-radio-group v-model="checked">
  2. <van-cell-group inset>
  3. <van-cell title="单选框 1" clickable @click="checked = '1'">
  4. <template #right-icon>
  5. <van-radio name="1" />
  6. </template>
  7. </van-cell>
  8. <van-cell title="单选框 2" clickable @click="checked = '2'">
  9. <template #right-icon>
  10. <van-radio name="2" />
  11. </template>
  12. </van-cell>
  13. </van-cell-group>
  14. </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当前选中项的标识符any-
disabled是否禁用所有单选框booleanfalse
direction排列方向,可选值为 horizontalstringvertical
icon-size所有单选框的图标大小,默认单位为 pxnumber | string20px
checked-color所有单选框的选中状态颜色string#1989fa

Radio Events

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

RadioGroup Events

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

Radio Slots

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

类型定义

组件导出以下类型定义:

  1. import type {
  2. RadioProps,
  3. RadioShape,
  4. RadioGroupProps,
  5. RadioLabelPosition,
  6. RadioGroupDirection,
  7. } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-radio-size20px-
—van-radio-border-colorvar(—van-gray-5)-
—van-radio-durationvar(—van-duration-fast)-
—van-radio-label-marginvar(—van-padding-xs)-
—van-radio-label-colorvar(—van-text-color)-
—van-radio-checked-icon-colorvar(—van-primary-color)-
—van-radio-disabled-icon-colorvar(—van-gray-5)-
—van-radio-disabled-label-colorvar(—van-text-color-3)-
—van-radio-disabled-backgroundvar(—van-border-color)-

Radio 单选框 - 图1