Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrRadio

Slot

  • The radio label.

Slot

helper-text - Renders content below the input.

Slot

value-missing - Renders content when the required validation fails.

Slot

custom-error - Renders content when setCustomValidity(message) is set.

Slot

invalid - Renders content when the component is in invalid state (validity.valid = false).

Csspart

base - The radio control base wrapper.

Csspart

control - The radio input control.

Csspart

label - The radio control label.

Callable

  • IgrRadio(): ReactNode

    Returns ReactNode

Events

Methods

Properties

Events

onChange

onChange: (args: CustomEvent<IgrRadioChangeEventArgsDetail>) => void

Emitted when the control's checked state changes.

Type declaration

Methods

blur

  • blur(): void

    Removes focus from the radio control.

    Returns void

checkValidity

  • checkValidity(): boolean

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

    Returns boolean

click

  • click(): void

    Simulates a click on the radio control.

    Returns void

focus

  • focus(options?: FocusOptions): void

    Sets focus on the radio control.

    Parameters

    • options: FocusOptions

    Returns void

reportValidity

  • reportValidity(): boolean

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

    Returns boolean

setCustomValidity

  • setCustomValidity(message: string): void

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

    Parameters

    • message: string

    Returns void

Properties

checked

checked: boolean

The checked state of the control.

labelPosition

labelPosition: ToggleLabelPosition

The label position of the radio control.

required

required: boolean

value

value: string

The value attribute of the control.