Angular Material 单选按钮的 API 参考

import {MatRadioModule} from '@angular/material/radio';

指令

`MatRadioGroup`

一组单选按钮。可以包含一个或多个 <mat-radio-button> 元素。

选择器： mat-radio-group

Exported as: matRadioGroup

属性

名称	描述
@Input() `color: ThemePalette`	该组中所有单选按钮的主题颜色。
@Input({ transform: booleanAttribute }) `disabled: boolean`	单选按钮组是否已禁用
@Input() `labelPosition: 'before' \| 'after'`	标签是应该出现在单选按钮之后还是之前。默认为 'after'
@Input() `name: string`	单选按钮组的名称。该组中的所有单选按钮都将使用此名称。
@Input({ transform: booleanAttribute }) `required: boolean`	单选按钮组是否为必填项
@Input() `selected: MatRadioButton`	当前选定的单选按钮。如果设置为新的单选按钮，则会更新该单选按钮组的值以匹配新选定的按钮。
@Input() `value: any`	单选按钮组的值。如果有一个与匹配值对应的单选按钮，它应该等于选定单选按钮的值。如果没有这样一个对应的单选按钮，在加入了一个带有匹配值的新单选按钮，该值仍然会生效。
@Output() `change: EventEmitter<MatRadioChange>`	本组的值发生变化时发出的事件。只有在值是因用户与单选按钮的交互而发生变化时才会发出变更事件（与 `<input type-"radio">` 的行为相同）。

`MatRadioButton`

选择器： mat-radio-button

Exported as: matRadioButton

属性

名称	描述
@Input('aria-describedby') `ariaDescribedby: string`	'aria-describedby' 属性是在该元素的标签和字段类型之后读取的。
@Input('aria-label') `ariaLabel: string`	用来在底层的 input 元素上设置 'aria-label' 属性。
@Input('aria-labelledby') `ariaLabelledby: string`	'aria-labelledby' 属性优先于该元素上的替换文本。
@Input({ transform: booleanAttribute }) `checked: boolean`	这个单选按钮是否被勾选。
@Input() `color: ThemePalette`	单选按钮的主题颜色。
@Input({ transform: booleanAttribute }) `disableRipple: boolean`	单选按钮内部是否禁用波纹。
@Input({ transform: booleanAttribute }) `disabled: boolean`	单选按钮是否已禁用。
@Input() `id: string`	单选按钮的唯一 ID。
@Input() `labelPosition: 'before' \| 'after'`	标签是应该出现在单选按钮之后还是之前。默认为 'after'
@Input() `name: string`	模拟 HTML 的 “name” 属性，用于对单选按钮进行分组以进行唯一选择。
@Input({ transform: booleanAttribute }) `required: boolean`	单选按钮是否为必填项。
@Input() `value: any`	这个单选按钮的值。
@Output() `change: EventEmitter<MatRadioChange>`	该单选按钮的 checked 属性发生变化时，会发出本事件。只会在值因用户与单选按钮的交互而发生变化时发出此变更事件（与 `<input type-"radio">` 的行为相同）。
`inputId: string`	`<mat-radio-button>` 里面的原生输入框元素的 ID
`radioGroup: MatRadioGroup`	父单选按钮组。可能存在，也可能不存在。

方法

focus
让此单选按钮获得焦点。
参数
选项 ? `FocusOptions`
origin ? `FocusOrigin`

类

`MatRadioChange`

更改单选按钮和单选组发出的事件对象。

属性

名称	描述
`source: MatRadioButton`	发出更改事件的单选按钮。
`value: any`	单选按钮的值。

接口

`MatRadioDefaultOptions`

属性

名称	描述
`color: ThemePalette`

函数

MAT_RADIO_DEFAULT_OPTIONS_FACTORY
返回值
`MatRadioDefaultOptions`

常量

`MAT_RADIO_GROUP`

这个注入令牌可以用来注入 MatRadioGroup 实例。它可以作为实际 MatRadioGroup 类的备用令牌，如果使用真实类可能导致此类及其组件元数据无法优化掉。

const MAT_RADIO_GROUP: InjectionToken<MatRadioGroup>;

`MAT_RADIO_DEFAULT_OPTIONS`

const MAT_RADIO_DEFAULT_OPTIONS: InjectionToken<MatRadioDefaultOptions>;