Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcRadioComponent

@element

igc-radio

@slot
  • The radio label.
@fires

igcChange - Emitted when the control's checked state changes.

@fires

igcFocus - Emitted when the control gains focus.

@fires

igcBlur - Emitted when the control loses focus.

@csspart

base - The radio control base wrapper.

@csspart

control - The radio control.

@csspart

label - The radio control label.

Hierarchy

  • EventEmitterInterface<IgcRadioEventMap, this> & LitElement<this>
    • IgcRadioComponent

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

ariaLabelledby

ariaLabelledby: string

Sets the aria-labelledby attribute for the radio control.

checked

checked: boolean = false

The checked state of the control.

disabled

disabled: boolean = false

Disables the radio control.

invalid

invalid: boolean = false

Controls the validity of the control.

labelPosition

labelPosition: "before" | "after" = 'after'

The label position of the radio control.

name

name: string

The name attribute of the control.

required

required: boolean = false

Makes the control a required field.

value

value: string

The value attribute of the control.

Static Readonly tagName

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

Methods

blur

  • blur(): void

  • Removes focus from the radio control.

    Returns void

click

  • click(): void

  • Simulates a click on the radio control.

    Returns void

connectedCallback

  • connectedCallback(): void

disconnectedCallback

  • disconnectedCallback(): void

emitEvent

  • emitEvent<K, D>(type: K, eventInitDict?: CustomEventInit<D>): boolean

  • Type parameters

    • K: keyof IgcRadioEventMap

    • D: boolean | void

    Parameters

    • type: K
    • Optional eventInitDict: CustomEventInit<D>

    Returns boolean

focus

  • focus(options?: FocusOptions): void

  • Sets focus on the radio control.

    Parameters

    • Optional options: FocusOptions

    Returns void

reportValidity

  • reportValidity(): void

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