/** * * SelectButton is used to choose single or multiple items from a list using buttons. * * [Live Demo](https://www.primevue.org/selectbutton/) * * @module selectbutton * */ import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; /** * Custom change event. */ export interface SelectButtonChangeEvent { /** * Browser event. */ originalEvent: Event; /** * Single value or an array of values that are selected. */ value: any; } /** * Defines valid properties in SelectButton component. */ export interface SelectButtonProps { /** * Value of the component. */ modelValue?: any; /** * An array of selectitems to display as the available options. */ options?: any[] | undefined; /** * Property name or getter function to use as the label of an option. */ optionLabel?: string | ((data: any) => string) | undefined; /** * Property name or getter function to use as the value of an option, defaults to the option itself when not defined. */ optionValue?: string | ((data: any) => any) | undefined; /** * Property name or getter function to use as the disabled flag of an option, defaults to false when not defined. */ optionDisabled?: string | ((data: any) => boolean) | undefined; /** * When specified, allows selecting multiple values. * @defaultValue false */ multiple?: boolean | undefined; /** * When present, it specifies that the element should be disabled. * @defaultValue false */ disabled?: boolean | undefined; /** * A property to uniquely identify an option. */ dataKey?: string | undefined; /** * Whether selection can be cleared. * @defaultValue true */ unselectable?: boolean | undefined; /** * Identifier of the underlying element. */ 'aria-labelledby'?: string | undefined; } /** * Defines valid slots in SelectButton component. */ export interface SelectButtonSlots { /** * Custom content for each option. * @param {Object} scope - option slot's params. */ option(scope: { /** * Option instance */ option: any; /** * Index of the option */ index: number; }): VNode[]; } /** * Defines valid emits in SelectButton component. */ export interface SelectButtonEmits { /** * Emitted when the value changes. * @param {*} value - New value. */ 'update:modelValue'(value: any): void; /** * Callback to invoke on value change. * @param {SelectButtonChangeEvent} event - Custom change event. */ change(event: SelectButtonChangeEvent): void; /** * Callback to invoke on focus. * @param {SelectButtonChangeEvent} event - Browser event. */ focus(event: Event): void; /** * Callback to invoke on blur. * @param {Event} event - Browser event. */ blur(event: Event): void; } /** * **PrimeVue - SelectButton** * * _SelectButton is used to choose single or multiple items from a list using buttons._ * * [Live Demo](https://www.primevue.org/selectbutton/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component */ export declare class SelectButton extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents { SelectButton: GlobalComponentConstructor; } } export default SelectButton;