@anguless/angulux/radiobutton

radiobutton

1 declarations2 demos

import

import { RadioButtonModule } from '@anguless/angulux/radiobutton';

Basic

Radio buttons sharing a name and bound to the same value form one group.

Hanoi

Da Nang

Ho Chi Minh City

@for (city of cities; track city) {    <agl-radioButton [(ngModel)]="selected" [value]="city" [inputId]="city" name="city" />    <label [for]="city">{{ city }}</label>}

Sizes

RadioButton provides small and large sizes as alternatives to the standard.

<agl-radioButton [(ngModel)]="selected" value="small" size="small" name="size" /><agl-radioButton [(ngModel)]="selected" value="normal" name="size" /><agl-radioButton [(ngModel)]="selected" value="large" size="large" name="size" />

API

Generated from the committed corpus, which check:corpus holds to the built library.

RadioButton

componentagl-radioButton, agl-radiobutton, agl-radio-button

RadioButton is an extension to standard radio button element with theming.

Input	Type	Default	Description
value	any	not documented	Value of the radiobutton.
tabindex	number \| undefined	not documented	Index of the element in tabbing order.
inputId	string \| undefined	not documented	Identifier of the focus input to match a label defined for the component.
ariaLabelledBy	string \| undefined	not documented	Establishes relationships between the component and label(s) where its value should be one or more element IDs.
ariaLabel	string \| undefined	not documented	Used to define a string that labels the input element.
styleClass deprecated — since v20.0.0, use `class` instead.	string \| undefined	not documented	Style class of the component.
autofocus	boolean \| undefined	not documented	When present, it specifies that the component should automatically get focus on load.
binary	boolean \| undefined	not documented	Allows to select a boolean value.
variant	'filled' \| 'outlined' \| undefined	undefined	Specifies the input variant of the component.
size	'large' \| 'small' \| undefined	undefined	Specifies the size of the component.

Output	Type	Description
onClick	EventEmitter<RadioButtonClickEvent>	Callback to invoke on radio button click.
onFocus	EventEmitter<Event>	Callback to invoke when the receives focus.
onBlur	EventEmitter<Event>	Callback to invoke when the loses focus.

Inherited from BaseEditableHolder

inherited

Input	Type	Default	Description
required		false	There must be a value (if set). Left unbound, a control bound through `formControlName`, `[formControl]` or `ngModel` is required when that control carries `Validators.required` or `Validators.requiredTrue`.
invalid		false	When present, it specifies that the component should have invalid state style. Left unbound, a control bound through `formControlName`, `[formControl]` or `ngModel` shows the state of that control once it is touched or dirty.
touched	boolean \| undefined	undefined	Whether the user has visited the control. Once this or `dirty` is set, the invalid state style waits for interaction: it appears when the control is touched or dirty. Signal Forms' `[formField]` sets both, so an untouched required field is not shown as invalid. Leave both unset and `invalid` alone decides.
dirty	boolean \| undefined	undefined	Whether the user has changed the value. See `touched`.
disabled		false	When present, it specifies that the component should have disabled state style.
name	string \| undefined	undefined	When present, it specifies that the name of the input.

Inherited from BaseComponent

inherited

Input	Type	Default	Description
dt	Object \| undefined	undefined	Defines scoped design tokens of the component.
unstyled	boolean \| undefined	undefined	Indicates whether the component should be rendered without styles.
pt	PT \| undefined	undefined	Used to pass attributes to DOM elements inside the component. TRUSTED INPUT ONLY. Whatever you put here is applied to the DOM as given: keys become attributes, and a key that names a DOM property is assigned to that property directly, with no sanitizer in between. That is what makes the API useful, and it means a value reaching it from a user, a database or a CMS can execute script. Treat it like markup you wrote yourself, not like data you received.
ptOptions	PassThroughOptions \| undefined	undefined	Used to configure passthrough(pt) options of the component.