Radio 单选框

介绍

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

代码演示

基础用法

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

<z-radio-group v-model="checked">
  <z-radio name="1">单选框 1</z-radio>
  <z-radio name="2" :custom-style="{ 'margin-top': '20rpx' }"
    >单选框 2</z-radio
  >
</z-radio-group>
import { ref } from 'vue'
const checked = ref('1')

水平排列

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

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

禁用状态

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

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

自定义形状

shape 属性可选值为 squaredot,单选框形状分别对应方形和圆点形。

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

<z-radio-group v-model="checked" shape="dot">
  <z-radio name="1">Radio 1</z-radio>
  <z-radio name="2">Radio 2</z-radio>
</z-radio-group>

自定义颜色

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

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

自定义大小

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

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

自定义图标

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

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

<style>
.demo-radio {
  .img-icon {
    width: 40rpx;
    height: 40rpx;
  }
}
</style>
<script lang="ts" setup>
import { ref } from 'vue'
const checked = ref('1')
const activeIcon =
  'https://cdn.zebraui.com/zebra-ui/images/assets/demo-select.png'
const inactiveIcon =
  'https://cdn.zebraui.com/zebra-ui/images/assets/demo-noselect.png'
</script>

左侧文本

label-position 属性设置为 'left',可以将文本位置调整到单选框左侧。

<z-radio-group v-model="checked">
  <z-radio name="1" label-position="left">单选框 1</z-radio>
  <z-radio name="2" label-position="left">单选框 2</z-radio>
</z-radio-group>

禁用文本点击

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

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

搭配单元格组件使用

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

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

API

Radio Props

参数说明类型默认值
name标识符,通常为一个唯一的字符串或数字any-
shape形状,可选值为 square dotstringround
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
shape形状,可选值为 square dotstringround

Radio Events

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

RadioGroup Events

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

Radio Slots

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

主题定制

样式变量

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

名称默认值描述
--z-radio-size40rpx-
--z-radio-dot-size16rpx圆点到边界的距离
--z-radio-border-colorvar(--z-gray-5)-
--z-radio-durationvar(--z-duration-fast)-
--z-radio-label-marginvar(--z-padding-xs)-
--z-radio-label-colorvar(--z-text-color)-
--z-radio-checked-icon-colorvar(--z-primary-color)-
--z-radio-disabled-icon-colorvar(--z-gray-5)-
--z-radio-disabled-label-colorvar(--z-text-color-3)-
--z-radio-disabled-backgroundvar(--z-border-color)-