package.src.vaadin-radio-button.d.ts Maven / Gradle / Ivy
/**
* @license
* Copyright (c) 2017 - 2024 Vaadin Ltd.
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
*/
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
import { type RadioButtonEventMap, RadioButtonMixin } from './vaadin-radio-button-mixin.js';
export * from './vaadin-radio-button-mixin.js';
/**
* `` is a web component representing a choice in a radio group.
* Only one radio button in the group can be selected at the same time.
*
* ```html
*
*
* ```
*
* ### Styling
*
* The following shadow DOM parts are available for styling:
*
* Part name | Description
* ------------|----------------
* `radio` | The wrapper element which contains slotted ``.
*
* The following state attributes are available for styling:
*
* Attribute | Description | Part name
* -------------|-------------|------------
* `active` | Set when the radio button is pressed down, either with a pointer or the keyboard. | `:host`
* `disabled` | Set when the radio button is disabled. | `:host`
* `focus-ring` | Set when the radio button is focused using the keyboard. | `:host`
* `focused` | Set when the radio button is focused. | `:host`
* `checked` | Set when the radio button is checked. | `:host`
* `has-label` | Set when the radio button has a label. | `:host`
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* @fires {CustomEvent} checked-changed - Fired when the `checked` property changes.
*/
declare class RadioButton extends RadioButtonMixin(ElementMixin(ThemableMixin(ControllerMixin(HTMLElement)))) {
addEventListener(
type: K,
listener: (this: RadioButton, ev: RadioButtonEventMap[K]) => void,
options?: AddEventListenerOptions | boolean,
): void;
removeEventListener(
type: K,
listener: (this: RadioButton, ev: RadioButtonEventMap[K]) => void,
options?: EventListenerOptions | boolean,
): void;
}
declare global {
interface HTMLElementTagNameMap {
'vaadin-radio-button': RadioButton;
}
}
export { RadioButton };