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

Hierarchy

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

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

checked

checked: boolean = false

The checked state of the control.

Attr

disabled

disabled: boolean

The disabled state of the component

Attr

[disabled=false]

invalid

invalid: boolean

Control the validity of the control.

Attr

labelPosition

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

The label position of the radio control.

Attr

label-position

name

name: string

The name attribute of the control.

Attr

required

required: boolean

Makes the control a required field in a form context.

Attr

value

value: string

The value attribute of the control.

Attr

Static Readonly tagName

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

Accessors

form

  • get form(): null | HTMLFormElement

  • Returns the HTMLFormElement associated with this element.

    Returns null | HTMLFormElement

validationMessage

  • get validationMessage(): string

  • A string containing the validation message of this element.

    Returns string

validity

  • get validity(): ValidityState

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

    Returns ValidityState

willValidate

  • get willValidate(): boolean

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

    Returns boolean

Methods

blur

  • Removes focus from the radio control.

    Returns void

checkValidity

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

    Returns boolean

click

  • Simulates a click on the radio control.

    Returns void

emitEvent

  • Type parameters

    Type Parameters

    • K extends keyof IgcRadioEventMap

    • D extends boolean | void

    Parameters

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

    Returns boolean

focus

  • Sets focus on the radio control.

    Parameters

    • Optional options: FocusOptions

    Returns void

reportValidity

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

    Returns boolean

setCustomValidity

  • 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

Static register