npm package: @ophiuchus/radio
Description: ### 介绍
Author: songbug1024
Latest version: 1.0.1

# Radio 单选框

### 介绍

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

### 引入

```js
// 方式1（推荐）
import Vue from 'vue';
import Radio from '@ophiuchus/radio';

Vue.use(Radio);

// 方式2
import Vue from 'vue';
import { Radio, RadioGroup } from '@ophiuchus/radio';

Vue.component(Radio.name, Radio);
Vue.component(RadioGroup.name, RadioGroup);
```

## 代码演示

### 基础用法

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

```html
<sf-radio-group v-model="radio">
  <sf-radio name="1">单选框 1</sf-radio>
  <sf-radio name="2">单选框 2</sf-radio>
</sf-radio-group>
```

```js
export default {
  data() {
    return {
      radio: '1',
    };
  },
};
```

### 水平排列

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

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

### 禁用状态

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

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

### 自定义形状

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

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

### 自定义颜色

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

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

### 自定义大小

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

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

### 自定义图标

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

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

<style>
  .img-icon {
    height: 20px;
  }
</style>
```

```js
export default {
  data() {
    return {
      radio: '1',
      activeIcon: 'https://img3.tuhu.org/3rq0A7JtvChtaD5QMO3HgA_w98_h78.png',
      inactiveIcon: 'https://img3.tuhu.org/4rjx6O9PLzcq84oLWQeXww_w98_h78.png',
    };
  },
};
```

### 禁用文本点击

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

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

### 与 Cell 组件一起使用

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

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

## API

### Radio Props

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

### RadioGroup Props

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| v-model (value) | 当前选中项的标识符 | _any_ | - |
| disabled | 是否禁用所有单选框 | _boolean_ | `false` |
| direction | 排列方向，可选值为`horizontal` | _string_ | `vertical` |
| icon-size | 所有单选框的图标大小，默认单位为`px` | _number \| string_ | `20px` |
| checked-color | 所有单选框的选中状态颜色 | _string_ | `#1989fa` |

### Radio Events

| 事件名 | 说明             | 回调参数       |
| ------ | ---------------- | -------------- |
| click  | 点击单选框时触发 | _event: Event_ |

### RadioGroup Events

| 事件名 | 说明                     | 回调参数       |
| ------ | ------------------------ | -------------- |
| change | 当绑定值变化时触发的事件 | _name: string_ |

### Radio Slots

| 名称    | 说明       | 参数               |
| ------- | ---------- | ------------------ |
| default | 自定义文本 | -                  |
| icon    | 自定义图标 | _checked: boolean_ |

### 样式变量

组件提供了下列 Less 变量，可用于自定义样式，使用方法请参考[主题定制](#/theme)。

| 名称                             | 默认值                     | 描述 |
| -------------------------------- | -------------------------- | ---- |
| @radio-size                      | `20px`                     | -    |
| @radio-border-color              | `@gray-5`                  | -    |
| @radio-transition-duration       | `@animation-duration-fast` | -    |
| @radio-label-margin              | `@padding-xs`              | -    |
| @radio-label-color               | `@text-color`              | -    |
| @radio-checked-icon-color        | `@blue`                    | -    |
| @radio-disabled-icon-color       | `@gray-5`                  | -    |
| @radio-disabled-label-color      | `@gray-5`                  | -    |
| @radio-disabled-background-color | `@border-color`            | -    |