igniteui-angular
Version:
Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps
129 lines (128 loc) • 3.69 kB
TypeScript
import { AfterViewInit, EventEmitter } from '@angular/core';
import { ControlValueAccessor } from '@angular/forms';
import { EditorProvider } from '../core/edit-provider';
import { CheckboxBaseDirective } from '../checkbox/checkbox-base.directive';
import * as i0 from "@angular/core";
/**
* **Ignite UI for Angular Radio Button** -
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/radio_button.html)
*
* 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:
* ```html
* <igx-radio>
* Simple radio button
* </igx-radio>
* ```
*/
export declare class IgxRadioComponent extends CheckboxBaseDirective implements AfterViewInit, ControlValueAccessor, EditorProvider {
/** @hidden @internal */
blurRadio: EventEmitter<any>;
/**
* Returns the class of the radio component.
* ```typescript
* let radioClass = this.radio.cssClass;
* ```
*
* @memberof IgxRadioComponent
*/
cssClass: string;
/**
* Sets/gets the `checked` attribute.
* Default value is `false`.
* ```html
* <igx-radio [checked]="true"></igx-radio>
* ```
* ```typescript
* let isChecked = this.radio.checked;
* ```
*
* @memberof IgxRadioComponent
*/
set checked(value: boolean);
get checked(): boolean;
/**
* Sets/gets the `disabled` attribute.
* Default value is `false`.
* ```html
* <igx-radio disabled></igx-radio>
* ```
* ```typescript
* let isDisabled = this.radio.disabled;
* ```
*
* @memberof IgxRadioComponent
*/
disabled: boolean;
/**
* Sets/gets whether the radio button is invalid.
* Default value is `false`.
* ```html
* <igx-radio invalid></igx-radio>
* ```
* ```typescript
* let isInvalid = this.radio.invalid;
* ```
*
* @memberof IgxRadioComponent
*/
invalid: boolean;
/**
* Sets/gets whether the radio component is on focus.
* Default value is `false`.
* ```typescript
* this.radio.focus = true;
* ```
* ```typescript
* let isFocused = this.radio.focused;
* ```
*
* @memberof IgxRadioComponent
*/
focused: boolean;
/**
* @hidden
* @internal
*/
_changed(event: Event): void;
/**
* @hidden
*/
_onCheckboxClick(): void;
/**
* Selects the current radio button.
* ```typescript
* this.radio.select();
* ```
*
* @memberof IgxRadioComponent
*/
select(): void;
/**
* Deselects the current radio button.
* ```typescript
* this.radio.deselect();
* ```
*
* @memberof IgxRadioComponent
*/
deselect(): void;
/**
* Checks whether the provided value is consistent to the current radio button.
* If it is, the checked attribute will have value `true`;
* ```typescript
* this.radio.writeValue('radioButtonValue');
* ```
*/
writeValue(value: any): void;
/**
* @hidden
*/
onBlur(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxRadioComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxRadioComponent, "igx-radio", never, { "checked": { "alias": "checked"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "invalid": { "alias": "invalid"; "required": false; }; }, {}, never, ["*"], true, never>;
static ngAcceptInputType_checked: unknown;
static ngAcceptInputType_disabled: unknown;
static ngAcceptInputType_invalid: unknown;
}