Radio 单选框

单选框用于让用户在一组选项中选择一个选项。

使用方法

按需导入组件：

import 'mdui/components/radio-group.js';
import 'mdui/components/radio.js';

按需导入组件的 TypeScript 类型：

import type { RadioGroup } from 'mdui/components/radio-group.js';
import type { Radio } from 'mdui/components/radio.js';

使用示例：

Chinese

English

<mdui-radio-group value="chinese">
  <mdui-radio value="chinese">Chinese</mdui-radio>
  <mdui-radio value="english">English</mdui-radio>
</mdui-radio-group>

示例

选中状态

<mdui-radio-group> 组件的 value 属性值即当前选中的 <mdui-radio> 组件的 value 属性值。您也可以通过更新 <mdui-radio-group> 组件的 value 属性值，来切换当前选中的单选框。

Chinese

English

<mdui-radio-group value="chinese">
  <mdui-radio value="chinese">Chinese</mdui-radio>
  <mdui-radio value="english">English</mdui-radio>
</mdui-radio-group>

源码

可以单独使用 <mdui-radio> 组件，此时可以通过 checked 属性来读取和修改选中状态。

Radio

<mdui-radio checked>Radio</mdui-radio>

源码

禁用状态

通过在 <mdui-radio-group> 组件上添加 disabled 属性，可以禁用整个单选框组。

Chinese

English

<mdui-radio-group disabled>
  <mdui-radio value="chinese">Chinese</mdui-radio>
  <mdui-radio value="english">English</mdui-radio>
</mdui-radio-group>

源码

如果需要禁用特定的单选框，可以在 <mdui-radio> 组件上添加 disabled 属性。

Chinese

English

<mdui-radio-group>
  <mdui-radio value="chinese">Chinese</mdui-radio>
  <mdui-radio value="english" disabled>English</mdui-radio>
</mdui-radio-group>

源码

图标

可以通过设置 unchecked-icon 和 checked-icon 属性，分别定义未选中和选中状态下的单选框的 Material Icons 图标。也可以通过 unchecked-icon 和 checked-icon slot 来设置。

Chinese

English

<mdui-radio-group value="chinese">
  <mdui-radio
    unchecked-icon="check_box_outline_blank"
    checked-icon="lock"
    value="chinese"
  >Chinese</mdui-radio>
  <mdui-radio value="english">
    <mdui-icon slot="unchecked-icon" name="check_box_outline_blank"></mdui-icon>
    <mdui-icon slot="checked-icon" name="lock"></mdui-icon>
    English
  </mdui-radio>
</mdui-radio-group>

源码

`mdui-radio-group` API

属性

HTML 属性	JavaScript 属性	类型	默认值
`disabled`	`disabled`	`boolean`	`false`
是否禁用此组件
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。
`name`	`name`	`string`	`''`
单选框组的名称，将与表单数据一起提交
`value`	`value`	`string`	`''`
单选框组的名称，将于表单数据一起提交
	`defaultValue`	`string`	`''`
默认选中的值。在重置表单时，将重置为该默认值。该属性只能通过 JavaScript 属性设置
`required`	`required`	`boolean`	`false`
提交表单时，是否必须选中其中一个单选框
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`string`	-
如果表单验证未通过，此属性将包含提示信息。如果验证通过，此属性将为空字符串

方法

名称	参数	返回值
`checkValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`
`reportValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`。如果验证未通过，还会在组件上显示验证失败的提示。
`setCustomValidity`	`message: string`	`void`
设置自定义的错误提示文本。只要这个文本不为空，就表示字段未通过验证

事件

名称
`change`
选中值变化时触发
`input`
选中值变化时触发
`invalid`
表单字段验证未通过时触发

Slots

名称
默认
`<mdui-radio>` 元素

`mdui-radio` API

属性

HTML 属性	JavaScript 属性	类型	默认值
`value`	`value`	`string`	`''`
当前单选项的值
`disabled`	`disabled`	`boolean`	`false`
是否禁用当前单选项
`checked`	`checked`	`boolean`	`false`
当前单选项是否已选中
`unchecked-icon`	`uncheckedIcon`	`string`	-
未选中状态的 Material Icons 图标名。也可以通过 `slot="unchecked-icon"` 设置
`checked-icon`	`checkedIcon`	`string`	-
选中状态的 Material Icons 图标名。也可以通过 `slot="checked-icon"` 设置
`autofocus`	`autofocus`	`boolean`	`false`
是否在页面加载完成后自动获取焦点
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 键切换焦点时的顺序

方法

名称	参数	返回值
`click`		`void`
模拟鼠标点击元素
`focus`	`options: FocusOptions` (可选)	`void`
将焦点设置到当前元素。可以传入一个对象作为参数，该对象的属性包括： `preventScroll`：默认情况下，元素获取焦点后，页面会滚动以将该元素滚动到视图中。如果不希望页面滚动，可以将此属性设置为 `true`。
`blur`		`void`
移除当前元素的焦点

事件

名称
`focus`
获得焦点时触发
`blur`
失去焦点时触发
`change`
选中该单选项时触发

Slots

名称
默认
文本内容
`unchecked-icon`
未选中状态的图标
`checked-icon`
选中状态的图标

CSS Parts

名称
`control`
左侧图标容器
`unchecked-icon`
未选中状态的图标
`checked-icon`
选中状态的图标
`label`
文本内容

Checkbox 复选框

Switch 开关切换