657 lines
18 KiB
TypeScript
Executable File
657 lines
18 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* Dropdown also known as Select, is used to choose an item from a collection of options.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/dropdown/)
|
|
*
|
|
* @module dropdown
|
|
*
|
|
*/
|
|
import { HTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
import { VirtualScrollerItemOptions, VirtualScrollerPassThroughOptionType, VirtualScrollerProps } from '../virtualscroller';
|
|
|
|
export declare type DropdownPassThroughOptionType = DropdownPassThroughAttributes | ((options: DropdownPassThroughMethodOptions) => DropdownPassThroughAttributes) | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface DropdownPassThroughMethodOptions {
|
|
props: DropdownProps;
|
|
state: DropdownState;
|
|
context: DropdownContext;
|
|
}
|
|
|
|
/**
|
|
* Custom change event.
|
|
* @see {@link DropdownEmits.change}
|
|
*/
|
|
export interface DropdownChangeEvent {
|
|
/**
|
|
* Browser event.
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* Selected option value
|
|
*/
|
|
value: any;
|
|
}
|
|
|
|
/**
|
|
* Custom filter event.
|
|
* @see {@link DropdownEmits.filter}
|
|
*/
|
|
export interface DropdownFilterEvent {
|
|
/**
|
|
* Browser event.
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* Filter value
|
|
*/
|
|
value: any;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link DropdownProps.pt}
|
|
*/
|
|
export interface DropdownPassThroughOptions {
|
|
/**
|
|
* Uses to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the input's DOM element.
|
|
*/
|
|
input?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the clear icon's DOM element.
|
|
*/
|
|
clearIcon?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the trigger' DOM element.
|
|
*/
|
|
trigger?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the loading icon's DOM element.
|
|
*/
|
|
loadingIcon?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the panel's DOM element.
|
|
*/
|
|
panel?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the header's DOM element.
|
|
*/
|
|
header?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the filter container's DOM element.
|
|
*/
|
|
filterContainer?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the filter input's DOM element.
|
|
*/
|
|
filterInput?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the filter icon's DOM element.
|
|
*/
|
|
filterIcon?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the wrapper's DOM element.
|
|
*/
|
|
wrapper?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the VirtualScroller component.
|
|
* @see {@link VirtualScrollerPassThroughOptionType}
|
|
*/
|
|
virtualScroller?: VirtualScrollerPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the list's DOM element.
|
|
*/
|
|
list?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the item group's DOM element.
|
|
*/
|
|
itemGroup?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the item's DOM element.
|
|
*/
|
|
item?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the emptyMessage's DOM element.
|
|
*/
|
|
emptyMessage?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the hidden first focusable element's DOM element.
|
|
*/
|
|
hiddenFirstFocusableEl?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the hidden filter result's DOM element.
|
|
*/
|
|
hiddenFilterResult?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the hidden selected message's DOM element.
|
|
*/
|
|
hiddenSelectedMessage?: DropdownPassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the hidden last focusable element's DOM element.
|
|
*/
|
|
hiddenLastFocusableEl?: DropdownPassThroughOptionType;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface DropdownPassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines current inline state in Dropdown component.
|
|
*/
|
|
export interface DropdownState {
|
|
/**
|
|
* Current id state as a string.
|
|
*/
|
|
id: string;
|
|
/**
|
|
* Current focused state as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
focused: boolean;
|
|
/**
|
|
* Current focused item index as a number.
|
|
* @defaultvalue -1
|
|
*/
|
|
focusedOptionIndex: number;
|
|
/**
|
|
* Current filter value state as a string.
|
|
*/
|
|
filterValue: string;
|
|
/**
|
|
* Current overlay visible state as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
overlayVisible: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines current options in Dropdown component.
|
|
*/
|
|
export interface DropdownContext {
|
|
/**
|
|
* Current selection state of the item as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
selected: boolean;
|
|
/**
|
|
* Current focus state of the item as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
focused: boolean;
|
|
/**
|
|
* Current disabled state of the item as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
disabled: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in Dropdown component.
|
|
*/
|
|
export interface DropdownProps {
|
|
/**
|
|
* Value of the component.
|
|
*/
|
|
modelValue?: any;
|
|
/**
|
|
* An array of selectitems to display as the available options.
|
|
*/
|
|
options?: any[];
|
|
/**
|
|
* 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;
|
|
/**
|
|
* Property name or getter function to use as the label of an option group.
|
|
*/
|
|
optionGroupLabel?: string | ((data: any) => string) | undefined;
|
|
/**
|
|
* Property name or getter function that refers to the children options of option group.
|
|
*/
|
|
optionGroupChildren?: string | ((data: any) => any[]) | undefined;
|
|
/**
|
|
* Height of the viewport, a scrollbar is defined if height of list exceeds this value.
|
|
* @defaultValue 200px
|
|
*/
|
|
scrollHeight?: string | undefined;
|
|
/**
|
|
* When specified, displays a filter input at header.
|
|
* @defaultValue false
|
|
*/
|
|
filter?: boolean | undefined;
|
|
/**
|
|
* Placeholder text to show when filter input is empty.
|
|
*/
|
|
filterPlaceholder?: string | undefined;
|
|
/**
|
|
* Locale to use in filtering. The default locale is the host environment's current locale.
|
|
*/
|
|
filterLocale?: string | undefined;
|
|
/**
|
|
* Defines the filtering algorithm to use when searching the options.
|
|
* @defaultValue contains
|
|
*/
|
|
filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | string | undefined;
|
|
/**
|
|
* Fields used when filtering the options, defaults to optionLabel.
|
|
*/
|
|
filterFields?: string[] | undefined;
|
|
/**
|
|
* When present, custom value instead of predefined options can be entered using the editable input field.
|
|
* @defaultValue false
|
|
*/
|
|
editable?: boolean | undefined;
|
|
/**
|
|
* Default text to display when no option is selected.
|
|
*/
|
|
placeholder?: string | undefined;
|
|
/**
|
|
* When present, it specifies that the component should be disabled.
|
|
* @defaultValue false
|
|
*/
|
|
disabled?: boolean | undefined;
|
|
/**
|
|
* A property to uniquely identify an option.
|
|
*/
|
|
dataKey?: string | undefined;
|
|
/**
|
|
* When enabled, a clear icon is displayed to clear the value.
|
|
* @defaultValue false
|
|
*/
|
|
showClear?: boolean | undefined;
|
|
/**
|
|
* Identifier of the underlying input element.
|
|
*/
|
|
inputId?: string | undefined;
|
|
/**
|
|
* Inline style of the input field.
|
|
*/
|
|
inputStyle?: object | undefined;
|
|
/**
|
|
* Style class of the input field.
|
|
*/
|
|
inputClass?: string | object | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.
|
|
*/
|
|
inputProps?: InputHTMLAttributes | HTMLAttributes | undefined;
|
|
/**
|
|
* Inline style of the overlay panel.
|
|
*/
|
|
panelStyle?: object | undefined;
|
|
/**
|
|
* Style class of the overlay panel.
|
|
*/
|
|
panelClass?: string | object | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.
|
|
*/
|
|
panelProps?: HTMLAttributes | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLInputElement to the filter input inside the component.
|
|
*/
|
|
filterInputProps?: InputHTMLAttributes | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLElement to the clear icon inside the component.
|
|
* @deprecated since v3.26.0. Use 'pt' peroperty.
|
|
*/
|
|
clearIconProps?: HTMLAttributes | undefined;
|
|
/**
|
|
* A valid query selector or an HTMLElement to specify where the overlay gets attached.
|
|
* @defaultValue body
|
|
*/
|
|
appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
|
|
/**
|
|
* Whether the dropdown is in loading state.
|
|
* @defaultValue false
|
|
*/
|
|
loading?: boolean | undefined;
|
|
/**
|
|
* Icon to display in clear button.
|
|
* @deprecated since v3.27.0. Use 'clearicon' slot.
|
|
*/
|
|
clearIcon?: string | undefined;
|
|
/**
|
|
* Icon to display in the dropdown.
|
|
* @deprecated since v3.27.0. Use 'dropdownicon' slot.
|
|
*/
|
|
dropdownIcon?: string | undefined;
|
|
/**
|
|
* Icon to display in filter input.
|
|
* @deprecated since v3.27.0. Use 'filtericon' slot.
|
|
*/
|
|
filterIcon?: string | undefined;
|
|
/**
|
|
* Icon to display in loading state.
|
|
* @deprecated since v3.27.0. Use 'loadingicon' slot.
|
|
*/
|
|
loadingIcon?: string | undefined;
|
|
/**
|
|
* Clears the filter value when hiding the dropdown.
|
|
* @defaultValue false
|
|
*/
|
|
resetFilterOnHide?: boolean;
|
|
/**
|
|
* Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.
|
|
*/
|
|
virtualScrollerOptions?: VirtualScrollerProps;
|
|
/**
|
|
* Whether to focus on the first visible or selected element when the overlay panel is shown.
|
|
* @defaultValue true
|
|
*/
|
|
autoOptionFocus?: boolean | undefined;
|
|
/**
|
|
* Whether to focus on the filter element when the overlay panel is shown.
|
|
* @defaultValue false
|
|
*/
|
|
autoFilterFocus?: boolean | undefined;
|
|
/**
|
|
* When enabled, the focused option is selected.
|
|
* @defaultValue false
|
|
*/
|
|
selectOnFocus?: boolean | undefined;
|
|
/**
|
|
* Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.
|
|
* @defaultValue '{0} results are available'
|
|
*/
|
|
filterMessage?: string | undefined;
|
|
/**
|
|
* Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.
|
|
* @defaultValue '{0} items selected'
|
|
*/
|
|
selectionMessage?: string | undefined;
|
|
/**
|
|
* Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.
|
|
* @defaultValue No selected item
|
|
*/
|
|
emptySelectionMessage?: string | undefined;
|
|
/**
|
|
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.
|
|
* @defaultValue No results found
|
|
*/
|
|
emptyFilterMessage?: string | undefined;
|
|
/**
|
|
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.
|
|
* @defaultValue No results foun
|
|
*/
|
|
emptyMessage?: string | undefined;
|
|
/**
|
|
* Index of the element in tabbing order.
|
|
*/
|
|
tabindex?: number | string | undefined;
|
|
/**
|
|
* Defines a string value that labels an interactive element.
|
|
*/
|
|
'aria-label'?: string | undefined;
|
|
/**
|
|
* Identifier of the underlying input element.
|
|
*/
|
|
'aria-labelledby'?: string | undefined;
|
|
/**
|
|
* Uses to pass attributes to DOM elements inside the component.
|
|
* @type {DropdownPassThroughOptions}
|
|
*/
|
|
pt?: DropdownPassThroughOptions;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Dropdown component.
|
|
*/
|
|
export interface DropdownSlots {
|
|
/**
|
|
* Custom value template.
|
|
* @param {Object} scope - value slot's params.
|
|
*/
|
|
value(scope: {
|
|
/**
|
|
* Value of the component
|
|
*/
|
|
value: any;
|
|
/**
|
|
* Placeholder prop value
|
|
*/
|
|
placeholder: string;
|
|
}): VNode[];
|
|
/**
|
|
* Custom indicator template.
|
|
* @deprecated since v3.27.0. Use 'dropdownicon or loadingicon' slots.
|
|
*/
|
|
indicator(): VNode[];
|
|
/**
|
|
* Custom header template of panel.
|
|
* @param {Object} scope - header slot's params.
|
|
*/
|
|
header(scope: {
|
|
/**
|
|
* Value of the component
|
|
*/
|
|
value: any;
|
|
/**
|
|
* Displayed options
|
|
*/
|
|
options: any[];
|
|
}): VNode[];
|
|
/**
|
|
* Custom footer template of panel.
|
|
* @param {Object} scope - footer slot's params.
|
|
*/
|
|
footer(scope: {
|
|
/**
|
|
* Value of the component
|
|
*/
|
|
value: any;
|
|
/**
|
|
* Displayed options
|
|
*/
|
|
options: any[];
|
|
}): VNode[];
|
|
/**
|
|
* Custom option template.
|
|
* @param {Object} scope - option slot's params.
|
|
*/
|
|
option(scope: {
|
|
/**
|
|
* Option instance
|
|
*/
|
|
option: any;
|
|
/**
|
|
* Index of the option
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
/**
|
|
* Custom option group template.
|
|
* @param {Object} scope - option group slot's params.
|
|
*/
|
|
optiongroup(scope: {
|
|
/**
|
|
* Option instance
|
|
*/
|
|
option: any;
|
|
/**
|
|
* Index of the option
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
/**
|
|
* Custom empty filter template.
|
|
*/
|
|
emptyfilter(): VNode[];
|
|
/**
|
|
* Custom empty template.
|
|
*/
|
|
empty(): VNode[];
|
|
/**
|
|
* Custom content template.
|
|
* @param {Object} scope - content slot's params.
|
|
*/
|
|
content(scope: {
|
|
/**
|
|
* An array of objects to display for virtualscroller
|
|
*/
|
|
items: any;
|
|
/**
|
|
* Style class of the component
|
|
*/
|
|
styleClass: string;
|
|
/**
|
|
* Referance of the content
|
|
* @param {HTMLElement} el - Element of 'ref' property
|
|
*/
|
|
contentRef(el: any): void;
|
|
/**
|
|
* Options of the items
|
|
* @param {number} index - Rendered index
|
|
* @return {@link VirtualScroller.VirtualScrollerItemOptions}
|
|
*/
|
|
getItemOptions(index: number): VirtualScrollerItemOptions;
|
|
}): VNode[];
|
|
/**
|
|
* Custom loader template.
|
|
* @param {Object} scope - loader slot's params.
|
|
*/
|
|
loader(scope: {
|
|
/**
|
|
* Options of the loader items for virtualscroller
|
|
*/
|
|
options: any[];
|
|
}): VNode[];
|
|
/**
|
|
* Custom clear icon template.
|
|
* @param {Object} scope - clear icon slot's params.
|
|
*/
|
|
clearicon(scope: {
|
|
/**
|
|
* Clear icon click function.
|
|
*/
|
|
onClick: void;
|
|
}): VNode[];
|
|
/**
|
|
* Custom dropdown icon template.
|
|
* @param {Object} scope - dropdown icon slot's params.
|
|
*/
|
|
dropdownicon(scope: {
|
|
/**
|
|
* Style class of the component
|
|
*/
|
|
class: any;
|
|
}): VNode[];
|
|
/**
|
|
* Custom loading icon template.
|
|
* @param {Object} scope - loading icon slot's params.
|
|
*/
|
|
loadingicon(scope: {
|
|
/**
|
|
* Style class of the component
|
|
*/
|
|
class: any;
|
|
}): VNode[];
|
|
/**
|
|
* Custom filter icon template.
|
|
*/
|
|
filtericon(): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in Dropdown component.
|
|
*/
|
|
export interface DropdownEmits {
|
|
/**
|
|
* Emitted when the value changes.
|
|
* @param {*} value - New value.
|
|
*/
|
|
'update:modelValue'(value: any): void;
|
|
/**
|
|
* Callback to invoke on value change.
|
|
* @param {DropdownChangeEvent} event - Custom change event.
|
|
*/
|
|
change(event: DropdownChangeEvent): void;
|
|
/**
|
|
* Callback to invoke when the component receives focus.
|
|
* @param {Event} event - Browser event.
|
|
*/
|
|
focus(event: Event): void;
|
|
/**
|
|
* Callback to invoke when the component loses focus.
|
|
* @param {Event} event - Browser event.
|
|
*/
|
|
blur(event: Event): void;
|
|
/**
|
|
* Callback to invoke before the overlay is shown.
|
|
*/
|
|
'before-show'(): void;
|
|
/**
|
|
* Callback to invoke before the overlay is hidden.
|
|
*/
|
|
'before-hide'(): void;
|
|
/**
|
|
* Callback to invoke when the overlay is shown.
|
|
*/
|
|
show(): void;
|
|
/**
|
|
* Callback to invoke when the overlay is hidden.
|
|
*/
|
|
hide(): void;
|
|
/**
|
|
* Callback to invoke on filter input.
|
|
* @param {DropdownFilterEvent} event - Custom filter event.
|
|
*/
|
|
filter(event: DropdownFilterEvent): void;
|
|
}
|
|
|
|
/**
|
|
* **PrimeVue - Dropdown**
|
|
*
|
|
* _Dropdown also known as Select, is used to choose an item from a collection of options._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/dropdown/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*/
|
|
declare class Dropdown extends ClassComponent<DropdownProps, DropdownSlots, DropdownEmits> {
|
|
/**
|
|
* Shows the overlay.
|
|
* @param {boolean} [isFocus] - Decides whether to focus on the component. @defaultValue false.
|
|
*
|
|
* @memberof Dropdown
|
|
*/
|
|
show: (isFocus?: boolean) => void;
|
|
/**
|
|
* Hides the overlay.
|
|
* @param {boolean} [isFocus] - Decides whether to focus on the component. @defaultValue false.
|
|
*
|
|
* @memberof Dropdown
|
|
*/
|
|
hide: (isFocus?: boolean) => void;
|
|
}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Dropdown: GlobalComponentConstructor<Dropdown>;
|
|
}
|
|
}
|
|
|
|
export default Dropdown;
|