小程序开发框架

# 介绍

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

# 引入

在app.json或index.json中引入组件，详细介绍见快速上手

"usingComponents": {
  "mx-radio": "/miniprogram_npm/m-ui/mx-radio/index",
  "mx-radio-group": "/miniprogram_npm/m-ui/mx-radio-group/index"
}

# 小程序码

可使用微信扫码查看小程序码

#

# 代码演示

# 基本用法

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio name="1">单选框 1</mx-radio>
  <mx-radio name="2">单选框 2</mx-radio>
</mx-radio-group>

Page({
  data: {
    radio: '1',
  },

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

# 水平排列

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

<mx-radio-group
  value="{{ radio }}"
  bind:change="onChange"
  direction="horizontal"
>
  <mx-radio name="1">单选框 1</mx-radio>
  <mx-radio name="2">单选框 2</mx-radio>
</mx-radio-group>

# 禁用状态

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

<mx-radio-group value="{{ radio }}" disabled bind:change="onChange">
  <mx-radio name="1">单选框 1</mx-radio>
  <mx-radio name="2">单选框 2</mx-radio>
</mx-radio-group>

# 自定义形状

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio name="1" shape="square">单选框 1</mx-radio>
  <mx-radio name="2" shape="square">单选框 2</mx-radio>
</mx-radio-group>

# 自定义颜色

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio name="1" checked-color="#07c160">单选框 1</mx-radio>
  <mx-radio name="2" checked-color="#07c160">单选框 2</mx-radio>
</mx-radio-group>

# 自定义大小

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio name="1" icon-size="24px">单选框 1</mx-radio>
  <mx-radio name="2" icon-size="24px">单选框 2</mx-radio>
</mx-radio-group>

# 自定义图标

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio use-icon-slot value="{{ radio }}" name="1">
    自定义图标
    <image slot="icon" src="{{ radio === '1' ? icon.active : icon.normal }}" />
  </mx-radio>
  <mx-radio use-icon-slot value="{{ radio }}" name="2">
    自定义图标
    <image slot="icon" src="{{ radio === '2' ? icon.active : icon.normal }}" />
  </mx-radio>
</mx-radio-group>

Page({
  data: {
    radio: true,
    icon: {
      normal: '/icon-normal.png',
      active: '/icon-active.png',
    },
  },
  onChange(event) {
    this.setData({
      radio: event.detail,
    });
  },
});

# 禁用文本点击

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-radio name="1" label-disabled>单选框 1</mx-radio>
  <mx-radio name="2" label-disabled>单选框 2</mx-radio>
</mx-radio-group>

# 与 Cell 组件一起使用

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

<mx-radio-group value="{{ radio }}" bind:change="onChange">
  <mx-cell-group>
    <mx-cell title="单选框 1" clickable data-name="1" bind:click="onClick">
      <mx-radio slot="right-icon" name="1" />
    </mx-cell>
    <mx-cell title="单选框 2" clickable data-name="2" bind:click="onClick">
      <mx-radio slot="right-icon" name="2" />
    </mx-cell>
  </mx-cell-group>
</mx-radio-group>

Page({
  data: {
    radio: '1',
  },

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

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

# API

# RadioGroup Props

参数 说明 类型 默认值
name 在表单内提交时的标识符 string -
value 当前选中项的标识符 any -
disabled 是否禁用所有单选框 boolean false
direction 排列方向，可选值为 horizontal string vertical

# 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 18
checked-color 选中状态颜色 string #1989fa
use-icon-slot 是否使用 icon 插槽 boolean false

# Radio Event

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

# RadioGroup Event

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

# RadioGroup Event

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

← 多选（checkbox） →