Fixed #1836 - For MultiSelect
mertsincan
parent
f4dde1a99e
commit
e468f64b80
|
|
@ -1,111 +1,391 @@
|
|||
import { VNode } from 'vue';
|
||||
import VirtualScrollerProps from '../virtualscroller';
|
||||
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
||||
import { VirtualScrollerProps, VirtualScrollerItemOptions } from '../virtualscroller';
|
||||
|
||||
type MultiSelectOptionLabelType = string | ((data: any) => string) | undefined;
|
||||
|
||||
type MultiSelectOptionValueType = string | ((data: any) => any) | undefined;
|
||||
|
||||
type MultiSelectOptionDisabledType = string | ((data: any) => boolean) | undefined;
|
||||
|
||||
type MultiSelectOptionChildrenType = string | ((data: any) => any[]) | undefined;
|
||||
|
||||
interface MultiSelectProps {
|
||||
type MultiSelectFilterMatchModeType = 'contains' | 'startsWith' | 'endsWith';
|
||||
|
||||
type MultiSelectAppendToType = 'body' | 'self' | string | undefined;
|
||||
|
||||
type MultiSelectDisplayType = 'comma' | 'chip';
|
||||
|
||||
export interface MultiSelectChangeEvent {
|
||||
/**
|
||||
* Browser event
|
||||
*/
|
||||
originalEvent: Event;
|
||||
/**
|
||||
* Selected option value
|
||||
*/
|
||||
value: any;
|
||||
}
|
||||
|
||||
export interface MultiSelectAllChangeEvent {
|
||||
/**
|
||||
* Browser event
|
||||
*/
|
||||
originalEvent: Event;
|
||||
/**
|
||||
* Whether all data is selected.
|
||||
*/
|
||||
checked: boolean;
|
||||
}
|
||||
|
||||
export interface MultiSelectFilterEvent {
|
||||
/**
|
||||
* Original event
|
||||
*/
|
||||
originalEvent: Event;
|
||||
/**
|
||||
* Filter value
|
||||
*/
|
||||
value: string;
|
||||
}
|
||||
|
||||
export interface MultiSelectProps {
|
||||
/**
|
||||
* Value of the component.
|
||||
*/
|
||||
modelValue?: any;
|
||||
options?: 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?: MultiSelectOptionLabelType;
|
||||
/**
|
||||
* Property name or getter function to use as the value of an option, defaults to the option itself when not defined.
|
||||
*/
|
||||
optionValue?: MultiSelectOptionValueType;
|
||||
/**
|
||||
* Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.
|
||||
*/
|
||||
optionDisabled?: MultiSelectOptionDisabledType;
|
||||
/**
|
||||
* Property name or getter function to use as the label of an option group.
|
||||
*/
|
||||
optionGroupLabel?: MultiSelectOptionLabelType;
|
||||
/**
|
||||
* Property name or getter function that refers to the children options of option group.
|
||||
*/
|
||||
optionGroupChildren?: MultiSelectOptionChildrenType;
|
||||
scrollHeight?: string;
|
||||
placeholder?: string;
|
||||
disabled?: boolean;
|
||||
tabindex?: string;
|
||||
inputId?: string;
|
||||
dataKey?: string;
|
||||
filter?: boolean;
|
||||
filterPlaceholder?: string;
|
||||
filterLocale?: string;
|
||||
filterMatchMode?: string;
|
||||
filterFields?: string[];
|
||||
ariaLabelledBy?: string;
|
||||
appendTo?: string;
|
||||
emptyFilterMessage?: string;
|
||||
emptyMessage?: string;
|
||||
display?: string;
|
||||
panelClass?: string;
|
||||
selectedItemsLabel?: string;
|
||||
maxSelectedLabels?: number;
|
||||
selectionLimit?: number;
|
||||
showToggleAll?: boolean;
|
||||
loading?: boolean;
|
||||
loadingIcon?: string;
|
||||
/**
|
||||
* Height of the viewport, a scrollbar is defined if height of list exceeds this value.
|
||||
* Default value is '200px'.
|
||||
*/
|
||||
scrollHeight?: string | undefined;
|
||||
/**
|
||||
* Label to display when there are no selections.
|
||||
*/
|
||||
placeholder?: string | undefined;
|
||||
/**
|
||||
* When present, it specifies that the component should be disabled.
|
||||
*/
|
||||
disabled?: boolean | undefined;
|
||||
/**
|
||||
* Index of the element in tabbing order.
|
||||
*/
|
||||
tabindex?: string | number | undefined;
|
||||
/**
|
||||
* Identifier of the underlying input element.
|
||||
*/
|
||||
inputId?: string | undefined;
|
||||
/**
|
||||
* A property to uniquely identify an option.
|
||||
*/
|
||||
dataKey?: string | undefined;
|
||||
/**
|
||||
* When specified, displays a filter input at header.
|
||||
*/
|
||||
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.
|
||||
* @see MultiSelectFilterMatchModeType
|
||||
* Default value is 'contains'.
|
||||
*/
|
||||
filterMatchMode?: MultiSelectFilterMatchModeType;
|
||||
/**
|
||||
* Fields used when filtering the options, defaults to optionLabel.
|
||||
*/
|
||||
filterFields?: string[] | undefined;
|
||||
/**
|
||||
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
|
||||
*/
|
||||
ariaLabelledBy?: string | undefined;
|
||||
/**
|
||||
* A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.
|
||||
* @see MultiSelectAppendToType
|
||||
* Default value is 'body'.
|
||||
*/
|
||||
appendTo?: MultiSelectAppendToType;
|
||||
/**
|
||||
* Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.
|
||||
* Default value is 'No results found'.
|
||||
*/
|
||||
emptyFilterMessage?: string | undefined;
|
||||
/**
|
||||
* Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.
|
||||
* Default value is 'No results found'.
|
||||
*/
|
||||
emptyMessage?: string | undefined;
|
||||
/**
|
||||
* Defines how the selected items are displayed.
|
||||
* @see MultiSelectDisplayType
|
||||
* Default value is 'comma'.
|
||||
*/
|
||||
display?: MultiSelectDisplayType;
|
||||
/**
|
||||
* Style class of the overlay panel.
|
||||
*/
|
||||
panelClass?: string | undefined;
|
||||
/**
|
||||
* Label to display after exceeding max selected labels.
|
||||
* Default value is '{0} items selected'.
|
||||
*/
|
||||
selectedItemsLabel?: string | undefined;
|
||||
/**
|
||||
* Decides how many selected item labels to show at most.
|
||||
*/
|
||||
maxSelectedLabels?: number | undefined;
|
||||
/**
|
||||
* Maximum number of selectable items.
|
||||
*/
|
||||
selectionLimit?: number | undefined;
|
||||
/**
|
||||
* Whether to show the header checkbox to toggle the selection of all items at once.
|
||||
* Default value is true.
|
||||
*/
|
||||
showToggleAll?: boolean | undefined;
|
||||
/**
|
||||
* Whether the multiselect is in loading state.
|
||||
*/
|
||||
loading?: boolean | undefined;
|
||||
/**
|
||||
* Icon to display in loading state.
|
||||
* Default value is 'pi pi-spinner pi-spin'.
|
||||
*/
|
||||
loadingIcon?: string | undefined;
|
||||
/**
|
||||
* Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.
|
||||
* @see VirtualScroller.VirtualScrollerProps
|
||||
*/
|
||||
virtualScrollerOptions?: VirtualScrollerProps;
|
||||
selectAll?: boolean;
|
||||
/**
|
||||
* Whether all data is selected.
|
||||
*/
|
||||
selectAll?: boolean | undefined;
|
||||
}
|
||||
|
||||
interface MultiSelectValueSlotInterface {
|
||||
value: any;
|
||||
placeholder: string;
|
||||
export interface MultiSelectSlots {
|
||||
/**
|
||||
* 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 header template.
|
||||
* @param {Object} scope - header slot's params.
|
||||
*/
|
||||
header: (scope: {
|
||||
/**
|
||||
* Value of the component
|
||||
*/
|
||||
value: any;
|
||||
/**
|
||||
* Displayed options
|
||||
*/
|
||||
options: any[];
|
||||
}) => VNode[];
|
||||
/**
|
||||
* Custom footer template.
|
||||
* @param {Object} scope - footer slot's params.
|
||||
*/
|
||||
footer: (scope: {
|
||||
/**
|
||||
* Value of the component
|
||||
*/
|
||||
value: any;
|
||||
/**
|
||||
* Displayed options
|
||||
*/
|
||||
options: any[];
|
||||
}) => VNode[];
|
||||
/**
|
||||
* Custom emptyfilter template.
|
||||
*/
|
||||
emptyfilter: () => VNode[];
|
||||
/**
|
||||
* Custom empty template.
|
||||
*/
|
||||
empty: () => 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 chip template.
|
||||
* @param {Object} scope - chip slot's params.
|
||||
*/
|
||||
chip: (scope: {
|
||||
/**
|
||||
* A value in the selection
|
||||
*/
|
||||
value: any;
|
||||
}) => 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 indicator template.
|
||||
*/
|
||||
indicator: () => VNode[];
|
||||
}
|
||||
|
||||
interface MultiSelectHeaderSlotInterface {
|
||||
value: any;
|
||||
options: any[];
|
||||
export declare type MultiSelectEmits = {
|
||||
/**
|
||||
* Emitted when the value changes.
|
||||
* @param {*} value - New value.
|
||||
*/
|
||||
'update:modelValue': (value: any) => void;
|
||||
/**
|
||||
* Callback to invoke on value change.
|
||||
* @param {MultiSelectChangeEvent} event - Custom change event.
|
||||
*/
|
||||
'change': (event: MultiSelectChangeEvent) => 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 {MultiSelectFilterEvent} event - Custom filter event.
|
||||
*/
|
||||
'filter': (event: MultiSelectFilterEvent) => void;
|
||||
/**
|
||||
* Callback to invoke when all data is selected.
|
||||
* @param {MultiSelectAllChangeEvent} event - Custom select all change event.
|
||||
*/
|
||||
'selectall-change': (event: MultiSelectAllChangeEvent) => void;
|
||||
}
|
||||
|
||||
interface MultiSelectFooterSlotInterface {
|
||||
value: any;
|
||||
options: any[];
|
||||
declare class MultiSelect extends ClassComponent<MultiSelectProps, MultiSelectSlots, MultiSelectEmits> {
|
||||
/**
|
||||
* Shows the overlay.
|
||||
*/
|
||||
show: () => void;
|
||||
/**
|
||||
* Hides the overlay.
|
||||
*/
|
||||
hide: () => void;
|
||||
}
|
||||
|
||||
interface MultiSelectOptionSlotInterface {
|
||||
option: any;
|
||||
index: number;
|
||||
}
|
||||
|
||||
interface MultiSelectOptionGroupSlotInterface {
|
||||
option: any;
|
||||
index: number;
|
||||
}
|
||||
|
||||
interface MultiSelectChipSlotContent {
|
||||
value: any;
|
||||
}
|
||||
|
||||
interface MultiSelectContentInterface {
|
||||
items: any;
|
||||
styleClass: string;
|
||||
contentRef: string;
|
||||
getItemOptions: any;
|
||||
}
|
||||
|
||||
interface MultiSelectLoaderSlotInterface {
|
||||
options: any[];
|
||||
}
|
||||
|
||||
declare class MultiSelect {
|
||||
$props: MultiSelectProps;
|
||||
$emit(eventName: 'update:modelValue', value: any): this;
|
||||
$emit(eventName: 'change', e: {originalEvent: Event, value: any}): this;
|
||||
$emit(eventName: 'before-show'): this;
|
||||
$emit(eventName: 'before-leave'): this;
|
||||
$emit(eventName: 'show'): this;
|
||||
$emit(eventName: 'hide'): this;
|
||||
$emit(eventName: 'filter', e: { originalEvent: Event, value: string }): this;
|
||||
$emit(eventName: 'selectall-change', e: { originalEvent: Event, checked: boolean }): this;
|
||||
show(): void;
|
||||
hide(): void;
|
||||
$slots: {
|
||||
value: MultiSelectValueSlotInterface;
|
||||
header: MultiSelectHeaderSlotInterface;
|
||||
footer: MultiSelectFooterSlotInterface;
|
||||
emptyfilter: VNode[];
|
||||
empty: VNode[];
|
||||
option: MultiSelectOptionSlotInterface;
|
||||
optiongroup: MultiSelectOptionGroupSlotInterface;
|
||||
chip: MultiSelectChipSlotContent;
|
||||
content: MultiSelectContentInterface;
|
||||
loader: MultiSelectLoaderSlotInterface;
|
||||
indicator: VNode[];
|
||||
declare module '@vue/runtime-core' {
|
||||
interface GlobalComponents {
|
||||
MultiSelect: GlobalComponentConstructor<MultiSelect>
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* MultiSelect is used to multiple values from a list of options.
|
||||
*
|
||||
* Demos:
|
||||
*
|
||||
* - [MultiSelect](https://www.primefaces.org/primevue/showcase/#/multiselect)
|
||||
*
|
||||
*/
|
||||
export default MultiSelect;
|
||||
|
|
|
|||
Loading…
Reference in New Issue