Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxRadioComponent

Ignite UI for Angular Radio Button - Documentation

The Ignite UI Radio Button allows the user to select a single option from an available set of options that are listed side by side.

Example:

<igx-radio>
  Simple radio button
</igx-radio>

Hierarchy

Hierarchy (View Summary)

Implements

  • AfterViewInit
  • OnDestroy
  • ControlValueAccessor

Constructors

Properties

Accessors

Methods

Constructors

Properties

ariaLabel: string = null

Sets/gets the value of the aria-label attribute.

<igx-checkbox aria-label="Checkbox1"></igx-checkbox>

let ariaLabel = this.checkbox.ariaLabel;
ariaLabelledBy: string = ...

Sets/gets the aria-labelledby attribute. If not set, the aria-labelledby will be equal to the value of labelId attribute.

<igx-checkbox aria-labelledby="Checkbox1"></igx-checkbox>

let ariaLabelledBy = this.checkbox.ariaLabelledBy;
change: EventEmitter<IChangeCheckboxEventArgs> = ...

An event that is emitted after the checkbox state is changed. Provides references to the IgxCheckboxComponent and the checked property as event arguments.

cssClass: string = 'igx-radio'

Returns the class of the radio component.

let radioClass = this.radio.cssClass;

IgxRadioComponent

disabled: boolean = false

Sets/gets the disabled attribute. Default value is false.

<igx-radio disabled></igx-radio>

let isDisabled =  this.radio.disabled;

IgxRadioComponent

disableRipple: boolean = false

Enables/Disables the ripple effect. If not set, disableRipple will have value false.

<igx-checkbox [disableRipple]="true"></igx-checkbox>

let isRippleDisabled = this.checkbox.desableRipple;
focused: boolean = false

Sets/gets whether the radio component is on focus. Default value is false.

this.radio.focus = true;

let isFocused =  this.radio.focused;

IgxRadioComponent

id: string = ...

Sets/gets the id of the checkbox component. If not set, the id of the first checkbox component will be "igx-checkbox-0".

<igx-checkbox id="my-first-checkbox"></igx-checkbox>

let checkboxId =  this.checkbox.id;
indeterminate: boolean
invalid: boolean = false

Sets/gets whether the radio button is invalid. Default value is false.

<igx-radio invalid></igx-radio>

let isInvalid =  this.radio.invalid;

IgxRadioComponent

labelId: string = ...

Sets/gets the id of the label element. If not set, the id of the label in the first checkbox component will be "igx-checkbox-0-label".

<igx-checkbox labelId="Label1"></igx-checkbox>

let labelId =  this.component.labelId;
labelPosition: string = LabelPosition.AFTER

Sets/gets the position of the label. If not set, the labelPosition will have value "after".

<igx-checkbox labelPosition="before"></igx-checkbox>

let labelPosition =  this.checkbox.labelPosition;
name: string

Sets/gets the name attribute.

<igx-checkbox name="Checkbox1"></igx-checkbox>

let name =  this.checkbox.name;
nativeInput: ElementRef

Returns reference to the native checkbox element.

let checkboxElement =  this.component.checkboxElement;
nativeLabel: ElementRef

Returns reference to the native label element.


@example
let labelElement =  this.component.nativeLabel;
ngControl: NgControl = ...
placeholderLabel: ElementRef

Returns reference to the label placeholder element.


@example
let labelPlaceholder =  this.component.placeholderLabel;
readonly: boolean
tabindex: number = null

Sets/gets the value of the tabindex attribute.

<igx-checkbox [tabindex]="1"></igx-checkbox>

let tabIndex =  this.checkbox.tabindex;
value: any

Sets/gets the value attribute.

<igx-checkbox [value]="'CheckboxValue'"></igx-checkbox>

let value =  this.checkbox.value;

Accessors

Methods

  • Checks whether the provided value is consistent to the current radio button. If it is, the checked attribute will have value true;

    this.radio.writeValue('radioButtonValue');

    Parameters

    • value: any

    Returns void