/** * * PickList is used to reorder items between different lists. * * [Live Demo](https://primevue.org/picklist) * * @module picklist * */ import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue'; import { ComponentHooks } from '../basecomponent'; import { ButtonPassThroughOptionType } from '../button'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export declare type PickListPassThroughOptionType = PickListPassThroughAttributes | ((options: PickListPassThroughMethodOptions) => PickListPassThroughAttributes | string) | string | null | undefined; /** * Custom passthrough(pt) option method. */ export interface PickListPassThroughMethodOptions { instance: any; props: PickListProps; state: PickListState; context: PickListContext; } /** * Custom reorder event. * @see {@link PickListEmits.reorder} */ export interface PickListReorderEvent { /** * Browser event */ originalEvent: Event; /** * Ordered list */ value: any[]; /** * Direction of the change; 'up', 'down', 'bottom', 'top' */ direction: string; /** * Index of the list that is ordered, 0 represents the source and 1 represents the target list. */ listIndex: number; } /** * Custom selection change event. * @see {@link PickListEmits['selection-change']} */ export interface PickListSelectionChangeEvent { /** * Browser event */ originalEvent: Event; /** * Selected item */ value: any[]; } /** * Custom move-to-target event. * @see {@link PickListEmits['move-to-target']} */ export interface PickListMoveToTargetEvent { /** * Browser event */ originalEvent: Event; /** * Moved items */ items: any[]; } /** * Custom move-all-to-target event. * @see {@link PickListEmits['move-all-to-target']} * @extends PickListMoveToTargetEvent */ export interface PickListMoveAllToTargetEvent extends PickListMoveToTargetEvent {} /** * Custom move-to-source event. * @see {@link PickListEmits['move-all-to-target']} * @extends PickListMoveToTargetEvent */ export interface PickListMoveToSourceEvent extends PickListMoveToTargetEvent {} /** * Custom move-all-to-source event. * @see {@link PickListEmits['move-all-to-target']} * @extends PickListMoveToTargetEvent */ export interface PickListMoveAllToSourceEvent extends PickListMoveToTargetEvent {} /** * Custom passthrough(pt) options. * @see {@link PickListProps.pt} */ export interface PickListPassThroughOptions { /** * Used to pass attributes to the root's DOM element. */ root?: PickListPassThroughOptionType; /** * Used to pass attributes to the source controls' DOM element. */ sourceControls?: PickListPassThroughOptionType; /** * Used to pass attributes to the Button component. */ sourceMoveUpButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ sourceMoveTopButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ sourceMoveDownButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ sourceMoveBottomButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the source wrapper's DOM element. */ sourceWrapper?: PickListPassThroughOptionType; /** * Used to pass attributes to the source header's DOM element. */ sourceHeader?: PickListPassThroughOptionType; /** * Used to pass attributes to the source list's DOM element. */ sourceList?: PickListPassThroughOptionType; /** * Used to pass attributes to the buttons' DOM element. */ buttons?: PickListPassThroughOptionType; /** * Used to pass attributes to the Button component. */ moveToTargetButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ moveAllToTargetButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ moveToSourceButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ moveAllToSourceButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the target wrapper's DOM element. */ targetWrapper?: PickListPassThroughOptionType; /** * Used to pass attributes to the target header's DOM element. */ targetHeader?: PickListPassThroughOptionType; /** * Used to pass attributes to the target list's DOM element. */ targetList?: PickListPassThroughOptionType; /** * Used to pass attributes to the target item's DOM element. */ item?: PickListPassThroughOptionType; /** * Used to pass attributes to the target controls' DOM element. */ targetControls?: PickListPassThroughOptionType; /** * Used to pass attributes to the Button component. */ targetMoveUpButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ targetMoveTopButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ targetMoveDownButton?: ButtonPassThroughOptionType; /** * Used to pass attributes to the Button component. */ targetMoveBottomButton?: ButtonPassThroughOptionType; /** * Used to manage all lifecycle hooks * @see {@link BaseComponent.ComponentHooks} */ hooks?: ComponentHooks; /** * Used to control Vue Transition API. */ transition?: any; } /** * Custom passthrough attributes for each DOM elements */ export interface PickListPassThroughAttributes { [key: string]: any; } export interface PickListFocusedState { /** * Current source list's focused state as a boolean. * @defaultValue false */ sourceList: boolean; /** * Current target list's focused state as a boolean. * @defaultValue false */ targetList: boolean; } /** * Defines current inline state in PickList component. */ export interface PickListState { /** * Current id state as a string. */ id: string; /** * Current id state as a string. */ d_selection: any[]; /** * Current focused state as a boolean. * @defaultValue [false, false] */ focused: boolean; /** * Current focused item index as a number. * @defaultvalue -1 */ focusedOptionIndex: number; /** * Current view change state as a boolean. * @defaultValue false */ viewChanged: boolean; } /** * Defines current options in PickList component. */ export interface PickListContext { /** * Current active state of the item as a boolean. * @defaultValue false */ active: boolean; /** * Current focus state of the item as a boolean. * @defaultValue false */ focused: boolean; } /** * Defines valid properties in PickList component. */ export interface PickListProps { /** * Value of the component as a multidimensional array. */ modelValue?: any[][] | undefined; /** * Selected items in the list as a multidimensional array. */ selection?: any[][] | undefined; /** * Name of the field that uniquely identifies the a record in the data. */ dataKey?: string | undefined; /** * Defines whether metaKey is requred or not for the selection. * When true metaKey needs to be pressed to select or unselect an item and * when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically. * @defaultValue true */ metaKeySelection?: boolean | undefined; /** * Inline style of the the list element. */ listStyle?: any | undefined; /** * Whether the list optimizes layout based on screen size. * @defaultValue true */ responsive?: boolean | undefined; /** * The breakpoint to define the maximum width boundary when responsiveness is enabled. * @defaultValue 960px */ breakpoint?: string | undefined; /** * Whether to displays rows with alternating colors. * @defaultValue false */ stripedRows?: boolean | undefined; /** * Whether to show buttons of source list. * @defaultValue true */ showSourceControls?: boolean | undefined; /** * Whether to show buttons of target list. * @defaultValue true */ showTargetControls?: boolean | undefined; /** * Index of the list element in tabbing order. */ tabindex?: number | string | undefined; /** * Used to pass all properties of the HTMLAttributes to the target list element. */ targetListProps?: HTMLAttributes | undefined; /** * Used to pass all properties of the HTMLAttributes to the source list element. */ sourceListProps?: HTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move up button inside the component. */ moveUpButtonProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move top button inside the component. */ moveTopButtonProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move down button inside the component. */ moveDownButtonProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move bottom button inside the component. */ moveBottomButtonProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move to target button inside the component. */ moveToTargetProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move all to target button inside the component. */ moveAllToTargetProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move to source button inside the component. */ moveToSourceProps?: ButtonHTMLAttributes | undefined; /** * Used to pass all properties of the HTMLButtonElement to the move all to source button inside the component. */ moveAllToSourceProps?: ButtonHTMLAttributes | undefined; /** * Used to pass attributes to DOM elements inside the component. * @type {PickListPassThroughOptions} */ pt?: PickListPassThroughOptions; /** * When enabled, it removes component related styles in the core. * @defaultValue false */ unstyled?: boolean; } /** * Defines valid slots in PickList component. */ export interface PickListSlots { /** * Custom header template. */ header(): VNode[]; /** * Custom item template. * @param {Object} scope - item slot's params. */ item(scope: { /** * Item of the component */ item: any; /** * Index of the item */ index: number; }): VNode[]; /** * Custom source header template. */ sourceheader(): VNode[]; /** * Custom target header template. */ targetheader(): VNode[]; /** * Custom source controls start template. */ sourcecontrolsstart(): VNode[]; /** * Custom source controls end template. */ sourcecontrolsend(): VNode[]; /** * Custom move controls start template. */ movecontrolsstart(): VNode[]; /** * Custom move controls end template. */ movecontrolsend(): VNode[]; /** * Custom target controls start template. */ targetcontrolsstart(): VNode[]; /** * Custom target controls end template. */ targetcontrolsend(): VNode[]; /** * Custom move up icon template. */ moveupicon(): VNode[]; /** * Custom move top icon template. */ movetopicon(): VNode[]; /** * Custom move down icon template. */ movedownicon(): VNode[]; /** * Custom move bottom icon template. */ movebottomicon(): VNode[]; /** * Custom move to target icon template. * @param {Object} scope - movetotargeticon slot's params. */ movetotargeticon(scope: { /** * Whether view change. */ viewChanged: boolean; }): VNode[]; /** * Custom move all to target icon template. * @param {Object} scope - movealltotargeticon slot's params. */ movealltotargeticon(scope: { /** * Whether view change. */ viewChanged: boolean; }): VNode[]; /** * Custom move to source icon template. * @param {Object} scope - movetosourceicon slot's params. */ movetosourceicon(scope: { /** * Whether view change. */ viewChanged: boolean; }): VNode[]; /** * Custom move all to source icon template. * @param {Object} scope - movealltosourceicon slot's params. */ movealltosourceicon(scope: { /** * Whether view change. */ viewChanged: boolean; }): VNode[]; } /** * Defines valid emits in PickList component. */ export interface PickListEmits { /** * Emitted when the value changes. * @param {*} value - New value. */ 'update:modelValue'(value: any[][]): void; /** * Emitted when the selection changes. * @param {*} value - New value. */ 'update:selection'(value: any[][]): void; /** * Callback to invoke when the list is reordered. * @param {PickListReorderEvent} event - Custom reorder event. */ reorder(event: PickListReorderEvent): void; /** * Callback to invoke when one or more items are moved to the other list. * @param {PickListSelectionChangeEvent} event - Custom selection change event. */ 'selection-change'(event: PickListSelectionChangeEvent): void; /** * Callback to invoke when one or more items are moved to the target list. * @param {PickListMoveToTargetEvent} event - Custom move to target event. */ 'move-to-target'(event: PickListMoveToTargetEvent): void; /** * Callback to invoke when all items are moved to the target list. * @param {PickListMoveAllToTargetEvent} event - Custom move all to target event. */ 'move-all-to-target'(event: PickListMoveAllToTargetEvent): void; /** * Callback to invoke when one or more items are moved to the source list. * @param {PickListMoveToSourceEvent} event - Custom move to source event. */ 'move-to-source'(event: PickListMoveToSourceEvent): void; /** * Callback to invoke when all items are moved to the source list. * @param {PickListMoveAllToSourceEvent} event - Custom move all to source event. */ 'move-all-to-source'(event: PickListMoveAllToSourceEvent): void; } /** * **PrimeVue - PickList** * * _PickList is used to reorder items between different lists._ * * [Live Demo](https://www.primevue.org/picklist/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component */ declare class PickList extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents { PickList: GlobalComponentConstructor; } } export default PickList;