@kelvininc/ui-components
Version:
Kelvin UI Components
30 lines (29 loc) • 1.26 kB
TypeScript
import { EventEmitter } from '../../stencil-public-runtime';
import { EComponentSize } from '../../types';
import { EIconName } from '../icon/icon.types';
export interface IToggleButton<T = string | number> {
/** (required) The value to be emitted upon click events */
value: T;
/** (optional) The button's icon. Only valid for toggle button icon */
icon?: EIconName;
/** (optional) The button's label. Only valid for toggle button text */
label?: string;
/** (optional) Sets the button's styling to be disabled and disables click events */
disabled?: boolean;
/** (optional) Sets the button as checked */
checked?: boolean;
/** (optional) Defines if the item click event should prevent default behaviour. */
preventDefault?: boolean;
/** (optional) Sets if the button is a radio button */
withRadio?: boolean;
/** (optional) Button's size */
size?: EComponentSize;
/** (optional) Tooltip text */
tooltip?: string;
/** (optional) Custom attributes to be applied to the toggle button element */
customAttributes?: Record<string, string>;
}
export interface IToggleButtonEvents<T = string | number> {
/** Emits when a button is clicked */
checkedChange: EventEmitter<T>;
}