The radio component allows the user to select a single option from an available set of options that are listed side by side.
Element
igc-radio
Slots
default — The radio label.
helper-text — Renders content below the input.
value-missing — Renders content when the required validation fails.
custom-error — Renders content when setCustomValidity(message) is set.
invalid — Renders content when the component is in invalid state (validity.valid = false).
CSS Parts
base — The radio control base wrapper.
control — The radio input control.
label — The radio control label.

Properties

Section titled "Properties"

disabled

Section titled "disabled"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

The disabled state of the component.

 
disabled: boolean

Defined in src/internals/mixins/forms/types.ts:30

invalid

Section titled "invalid"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

Sets the control into invalid state (visual state only).

 
invalid: boolean

Defined in src/internals/mixins/forms/types.ts:37

labelPosition

Section titled "labelPosition"

The label position of the radio control.

 
labelPosition: ToggleLabelPosition = 'after'

Defined in src/components/radio/radio.ts:190

name

Section titled "name"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

The name of the control, submitted with the form data.

 
name: string

Defined in src/internals/mixins/forms/types.ts:43

tagName

Section titled "tagName"

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

 
tagName: "igc-radio" = 'igc-radio'

Defined in src/components/radio/radio.ts:64

Accessors

Section titled "Accessors"

checked

Section titled "checked" 
get checked(): any

Defined in src/components/radio/radio.ts:166

The checked state of the control.

 
set checked(value: boolean): void

Defined in src/components/radio/radio.ts:166

Parameters

  • value: boolean

Returns void

defaultChecked

Section titled "defaultChecked"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) ) 

get defaultChecked(): any

Defined in src/internals/mixins/forms/types.ts:195

The initial checked state of the component.

 
set defaultChecked(value: boolean): void

Defined in src/internals/mixins/forms/types.ts:195

Parameters

  • value: boolean

Returns void

form

Section titled "form"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

Returns the HTMLFormElement associated with this element.

 
get form(): HTMLFormElement | null

Defined in src/internals/mixins/forms/types.ts:46

Returns HTMLFormElement | null

required

Section titled "required"

When set, makes the component a required field for validation.

 
get required(): boolean

Defined in src/components/radio/radio.ts:140

Returns boolean

When set, makes the component a required field for validation.

 
set required(value: boolean): void

Defined in src/components/radio/radio.ts:130

Parameters

  • value: boolean

Returns void

validationMessage

Section titled "validationMessage"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

A string containing the validation message of this element.

 
get validationMessage(): string

Defined in src/internals/mixins/forms/types.ts:55

Returns string

validity

Section titled "validity"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

Returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

 
get validity(): ValidityState

Defined in src/internals/mixins/forms/types.ts:52

Returns ValidityState

value

Section titled "value" 
get value(): any

Defined in src/components/radio/radio.ts:149

The value of the control.

 
set value(value: string): void

Defined in src/components/radio/radio.ts:149

Parameters

  • value: string

Returns void

willValidate

Section titled "willValidate"

Inherited from: FormAssociatedCheckboxRequiredMixin( EventEmitterMixin<IgcRadioComponentEventMap, Constructor<LitElement>>( LitElement ) )

A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

 
get willValidate(): boolean

Defined in src/internals/mixins/forms/types.ts:61

Returns boolean

Methods

Section titled "Methods"

blur

Section titled "blur"

Removes focus from the radio control.

 
blur(): void

Defined in src/components/radio/radio.ts:273

Returns void

checkValidity

Section titled "checkValidity"

Checks for validity of the control and emits the invalid event if it's invalid.

 
checkValidity(): boolean

Defined in src/components/radio/radio.ts:286

Returns boolean

click

Section titled "click"

Simulates a click on the radio control.

 
click(): void

Defined in src/components/radio/radio.ts:261

Returns void

focus

Section titled "focus"

Sets focus on the radio control.

 
focus(options: FocusOptions): void

Defined in src/components/radio/radio.ts:267

Parameters

  • options: FocusOptions

Returns void

reportValidity

Section titled "reportValidity"

Checks for validity of the control and shows the browser message if it's invalid.

 
reportValidity(): boolean

Defined in src/components/radio/radio.ts:295

Returns boolean

setCustomValidity

Section titled "setCustomValidity"

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

 
setCustomValidity(message: string): void

Defined in src/components/radio/radio.ts:307

Parameters

  • message: string

Returns void