Class RadioButton

<theoplayer-radio-button> - A button that can be checked.

When part of a RadioGroup, at most one button in the group can be checked.

Hierarchy (view full)

Button
- RadioButton

Index

Constructors

Accessors

checked disabled value observedAttributes

Methods

_upgradeProperty attributeChangedCallback connectedCallback disconnectedCallback handleClick

Constructors

constructor

new RadioButton(options?): RadioButton
Parameters
- Optional options: ButtonOptions
Returns RadioButton
Overrides Button.constructor
- Defined in components/RadioButton.ts:24

Accessors

checked

get checked(): boolean
Whether this radio button is checked.

Returns boolean
- Defined in components/RadioButton.ts:43
set checked(checked): void
Parameters
- checked: boolean
Returns void
- Defined in components/RadioButton.ts:47

disabled

get disabled(): boolean
Whether the button is disabled.

When disabled, the button cannot be clicked.

Returns boolean
Inherited from Button.disabled
- Defined in components/Button.ts:82
set disabled(disabled): void
Parameters
- disabled: boolean
Returns void
Inherited from Button.disabled
- Defined in components/Button.ts:86

value

get value(): any
The value associated with this radio button.

Returns any
- Defined in components/RadioButton.ts:54
set value(value): void
Parameters
- value: any
Returns void
- Defined in components/RadioButton.ts:58

`Static` observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Overrides Button.observedAttributes
- Defined in components/RadioButton.ts:18

Methods

`Protected` _upgradeProperty

_upgradeProperty(prop): void
Parameters
- prop: keyof RadioButton
Returns void
Inherited from Button._upgradeProperty
- Defined in components/Button.ts:48

attributeChangedCallback

attributeChangedCallback(attrName, oldValue, newValue): void
Parameters
- attrName: string
- oldValue: any
- newValue: any
Returns void
Overrides Button.attributeChangedCallback
- Defined in components/RadioButton.ts:67

connectedCallback

connectedCallback(): void
Returns void
Overrides Button.connectedCallback
- Defined in components/RadioButton.ts:29

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from Button.disconnectedCallback
- Defined in components/Button.ts:73

`Protected` handleClick

handleClick(): void
Handle a button click.

By default, this does nothing. Subclasses can override this method to add behavior to the button.

Returns void
Overrides Button.handleClick
- Defined in components/RadioButton.ts:62

Generated using TypeDoc