mirror of
https://github.com/primefaces/primevue.git
synced 2025-05-10 01:12:37 +00:00
Fixed #3802 - Improve folder structure for nuxt configurations
This commit is contained in:
parent
851950270b
commit
f5fe822afb
563 changed files with 1703 additions and 1095 deletions
306
components/lib/picklist/PickList.d.ts
vendored
Executable file
306
components/lib/picklist/PickList.d.ts
vendored
Executable file
|
@ -0,0 +1,306 @@
|
|||
/**
|
||||
*
|
||||
* PickList is used to reorder items between different lists.
|
||||
*
|
||||
* [Live Demo](https://primevue.org/picklist)
|
||||
*
|
||||
* @module picklist
|
||||
*
|
||||
*/
|
||||
import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
|
||||
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
||||
|
||||
/**
|
||||
* 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 {}
|
||||
|
||||
/**
|
||||
* 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 false
|
||||
*/
|
||||
showSourceControls?: boolean | undefined;
|
||||
/**
|
||||
* Whether to show buttons of target list.
|
||||
* @defaultValue false
|
||||
*/
|
||||
showTargetControls?: boolean | undefined;
|
||||
/**
|
||||
* Index of the list element in tabbing order.
|
||||
*/
|
||||
tabindex?: number | string | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLAttributes to the target list element.
|
||||
*/
|
||||
targetListProps?: HTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLAttributes to the source list element.
|
||||
*/
|
||||
sourceListProps?: HTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move up button inside the component.
|
||||
*/
|
||||
moveUpButtonProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move top button inside the component.
|
||||
*/
|
||||
moveTopButtonProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move down button inside the component.
|
||||
*/
|
||||
moveDownButtonProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move bottom button inside the component.
|
||||
*/
|
||||
moveBottomButtonProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move to target button inside the component.
|
||||
*/
|
||||
moveToTargetProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move all to target button inside the component.
|
||||
*/
|
||||
moveAllToTargetProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move to source button inside the component.
|
||||
*/
|
||||
moveToSourceProps?: ButtonHTMLAttributes | undefined;
|
||||
/**
|
||||
* Uses to pass all properties of the HTMLButtonElement to the move all to source button inside the component.
|
||||
*/
|
||||
moveAllToSourceProps?: ButtonHTMLAttributes | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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[];
|
||||
}
|
||||
|
||||
/**
|
||||
* 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/)
|
||||
* --- ---
|
||||
* 
|
||||
*
|
||||
* @group Component
|
||||
*/
|
||||
declare class PickList extends ClassComponent<PickListProps, PickListSlots, PickListEmits> {}
|
||||
|
||||
declare module '@vue/runtime-core' {
|
||||
interface GlobalComponents {
|
||||
PickList: GlobalComponentConstructor<PickList>;
|
||||
}
|
||||
}
|
||||
|
||||
export default PickList;
|
Loading…
Add table
Add a link
Reference in a new issue