API reference for Angular Material radio

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

A group of radio buttons. May contain one or more <mat-radio-button> elements.

Selector: mat-radio-group

Exported as: matRadioGroup
Properties
Name Description
@Input()

color: ThemePalette

Theme color for all of the radio buttons in the group.

@Input()

disabled: boolean

Whether the radio group is disabled

@Input()

labelPosition: 'before' | 'after'

Whether the labels should appear after or before the radio-buttons. Defaults to 'after'

@Input()

name: string

Name of the radio button group. All radio buttons inside this group will use this name.

@Input()

required: boolean

Whether the radio group is required

@Input()

selected: T

The currently selected radio button. If set to a new radio button, the radio group value will be updated to match the new selected button.

@Input()

value: any

Value for the radio-group. Should equal the value of the selected radio button if there is a corresponding radio button with a matching value. If there is not such a corresponding radio button, this value persists to be applied in case a new radio button is added with a matching value.

@Output()

change: EventEmitter<MatRadioChange>

Event emitted when the group value changes. Change events are only emitted when the value changes due to user interaction with a radio button (the same behavior as <input type-"radio">).

A Material design radio-button. Typically placed inside of <mat-radio-group> elements.

Selector: mat-radio-button

Exported as: matRadioButton
Properties
Name Description
@Input('aria-describedby')

ariaDescribedby: string

The 'aria-describedby' attribute is read after the element's label and field type.

@Input('aria-label')

ariaLabel: string

Used to set the 'aria-label' attribute on the underlying input element.

@Input('aria-labelledby')

ariaLabelledby: string

The 'aria-labelledby' attribute takes precedence as the element's text alternative.

@Input()

checked: boolean

Whether this radio button is checked.

@Input()

color: ThemePalette

Theme color of the radio button.

@Input()

disableRipple: boolean

Whether ripples are disabled.

@Input()

disabled: boolean

Whether the radio button is disabled.

@Input()

id: string

The unique ID for the radio button.

@Input()

labelPosition: 'before' | 'after'

Whether the label should appear after or before the radio button. Defaults to 'after'

@Input()

name: string

Analog to HTML 'name' attribute used to group radios for unique selection.

@Input()

required: boolean

Whether the radio button is required.

@Input()

value: any

The value of this radio button.

@Output()

change: EventEmitter<MatRadioChange>

Event emitted when the checked state of this radio button changes. Change events are only emitted when the value changes due to user interaction with the radio button (the same behavior as <input type-"radio">).

inputId: string

ID of the native input element inside <mat-radio-button>

radioGroup: _MatRadioGroupBase<_MatRadioButtonBase>

The parent radio group. May or may not be present.

Methods
focus

Focuses the radio button.

Parameters

options?

FocusOptions

Change event object emitted by MatRadio and MatRadioGroup.

Properties
Name Description

source: _MatRadioButtonBase

The MatRadioButton that emits the change event.

value: any

The value of the MatRadioButton.

Properties
Name Description

color: ThemePalette

MAT_RADIO_DEFAULT_OPTIONS_FACTORY
Returns
MatRadioDefaultOptions

const MAT_RADIO_DEFAULT_OPTIONS: InjectionToken<MatRadioDefaultOptions>;