primevue 3.9.1 → 3.10.0

package/autocomplete/AutoComplete.d.ts

@@ -1,81 +1,298 @@
-import VirtualScrollerProps from '../virtualscroller';
+import { VNode } from 'vue';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+import { VirtualScrollerProps, VirtualScrollerItemOptions } from '../virtualscroller';
 
-interface AutoCompleteProps {
+type AutoCompleteFieldType = string | ((data: any) => string) | undefined;
+
+type AutoCompleteDropdownMode = 'blank' | 'current' | undefined;
+
+type AutoCompleteAppendTo = 'body' | 'self' | string | undefined;
+
+export interface AutoCompleteItemSelectEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected item
+     */
+    value: any;
+}
+
+/**
+ * @extends AutoCompleteItemSelectEvent
+ */
+export interface AutoCompleteItemUnselectEvent extends AutoCompleteItemSelectEvent { }
+
+export interface AutoCompleteDropdownClickEvent {
+    /**
+     * Browser mouse event
+     */
+    originalEvent: MouseEvent;
+    /**
+     * Current value of the input field
+     */
+    query: string;
+}
+
+export interface AutoCompleteCompleteEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Value to search with
+     */
+    query: string;
+}
+
+export interface AutoCompleteProps {
+    /**
+     * Value of the component.
+     */
     modelValue?: any;
+    /**
+     * An array of suggestions to display.
+     */
     suggestions?: any[];
-    field?: string|Function;
-    optionGroupLabel?: string;
-    optionGroupChildren?: string;
-    scrollHeight?: string;
-    dropdown?: boolean;
-    dropdownMode?: string;
-    autoHighlight?: boolean;
-    multiple?: boolean;
-    minLength?: number;
-    delay?: number;
-    appendTo?: string;
-    completeOnFocus?: boolean;
+    /**
+     * Property name or getter function of a suggested object to resolve and display.
+     * @type {AutoCompleteFieldType}
+     */
+    field?: AutoCompleteFieldType;
+    /**
+     * Property name or getter function to use as the label of an option group.
+     */
+    optionGroupLabel?: string | undefined;
+    /**
+     * Property name or getter function that refers to the children options of option group.
+     */
+    optionGroupChildren?: string | undefined;
+    /**
+     * Maximum height of the suggestions panel.
+     * Default value is '200px'.
+     */
+    scrollHeight?: string | undefined;
+    /**
+     * Displays a button next to the input field when enabled.
+     */
+    dropdown?: boolean | undefined;
+    /**
+     * Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value.
+     * @see AutoCompleteDropdownMode
+     * Default value is 'blank'.
+     */
+    dropdownMode?: AutoCompleteDropdownMode;
+    /**
+     * Highlights automatically the first item of the dropdown to be selected.
+     */
+    autoHighlight?: boolean | undefined;
+    /**
+     * Specifies if multiple values can be selected.
+     */
+    multiple?: boolean | undefined;
+    /**
+     * Minimum number of characters to initiate a search.
+     * Default value is 1.
+     */
+    minLength?: number | undefined;
+    /**
+     * Delay between keystrokes to wait before sending a query.
+     * Default value is 300.
+     */
+    delay?: number | 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.
+     * Default value is body.
+     */
+    appendTo?: AutoCompleteAppendTo;
+    /**
+     * When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions.
+     */
+    forceSelection?: boolean;
+    /**
+     * Whether to run a query when input receives focus.
+     */
+    completeOnFocus?: boolean | undefined;
+    /**
+     * Inline style of the input field.
+     */
     inputStyle?: any;
+    /**
+     * Style class of the input field.
+     */
     inputClass?: string;
-    forceSelection?: boolean;
+    /**
+     * Inline style of the component.
+     */
     class?: any;
+    /**
+     * Style class of the component input field.
+     */
     style?: any;
+    /**
+     * Style class of the overlay panel.
+     */
     panelClass?: string;
+    /**
+     * Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.
+     * @see VirtualScroller.VirtualScrollerProps
+     */
     virtualScrollerOptions?: VirtualScrollerProps;
 }
 
-interface AutoCompleteItemSlotInterface {
-    item: any;
-    index: number;
+export interface AutoCompleteSlots {
+    /**
+     * Custom content for each item.
+     * @param {Object} scope - item slot's params.
+     */
+    item: (scope: {
+        /**
+         * Option instance
+         */
+        item: any;
+        /**
+         * Index of the option
+         */
+        index: number;
+    }) => VNode[];
+    /**
+     * Custom option group template.
+     * @param {Object} scope - option group slot's params.
+     */
+    optiongroup: (scope: {
+        /**
+         * Option instance
+         */
+        item: any;
+        /**
+         * Index of the option
+         */
+        index: number;
+    }) => VNode[];
+    /**
+     * Custom header template of panel.
+     * @param {Object} scope - header slot's params.
+     */
+    header: (scope: {
+        /**
+         * Value of the component
+         */
+        value: any;
+        /**
+         * Displayed options
+         */
+        suggestions: any[];
+    }) => VNode[];
+    /**
+     * Custom footer template of panel.
+     * @param {Object} scope - footer slot's params.
+     */
+    footer: (scope: {
+        /**
+         * Value of the component
+         */
+        value: any;
+        /**
+         * Displayed options
+         */
+        suggestions: any[];
+    }) => VNode[];
+    /**
+     * Custom chip template.
+     * @param {Object} scope - chip slot's params.
+     */
+    chip: (scope: {
+        /**
+         * A value in the selection
+         */
+        value: any;
+    }) => VNode[];
+    /**
+     * Custom panel 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[];
 }
 
-interface AutoCompleteOptionGroupInterface {
-    item: any;
-    index: number;
+export declare type AutoCompleteEmits = {
+    /**
+     * Emitted when the value changes.
+     * @param {*} value - New value.
+     */
+    'update:modelValue': (value: any) => void;
+    /**
+     * Callback to invoke when a suggestion is selected.
+     * @param {AutoCompleteItemSelectEvent} event - Custom item select event.
+     */
+    'item-select': (event: AutoCompleteItemSelectEvent) => void;
+    /**
+     * Callback to invoke when a selected value is removed.
+     * @param {AutoCompleteItemUnselectEvent} event - Custom item unselect event.
+     */
+    'item-unselect': (event: AutoCompleteItemUnselectEvent) => void;
+    /**
+     * Callback to invoke to when dropdown button is clicked.
+     * @param {AutoCompleteDropdownClickEvent} event - Custom dropdown click event.
+     */
+    'dropdown-click': (event: AutoCompleteDropdownClickEvent) => void;
+    /**
+     * Callback to invoke to search for suggestions.
+     * @param {AutoCompleteCompleteEvent} event - Custom complete event.
+     */
+    'complete': (event: AutoCompleteCompleteEvent) => void;
+    /**
+     * Callback to invoke when input is cleared by the user.
+     */
+    'clear': () => void;
 }
 
-interface AutoCompleteHeaderInterface {
-    value: any;
-    suggestions: any;
-}
-
-interface AutoCompleteFooterInterface {
-    value: any;
-    suggestions: any;
-}
-
-interface AutoCompleteChipInterface {
-    value: any;
-}
-
-interface AutoCompleteContentInterface {
-    items: any;
-    styleClass: string;
-    contentRef: string;
-    getItemOptions: any;
-}
-
-interface AutoCompleteLoaderInterface {
-    options: any[];
-}
+declare class AutoComplete extends ClassComponent<AutoCompleteProps, AutoCompleteSlots, AutoCompleteEmits> { }
 
-declare class AutoComplete {
-    $props: AutoCompleteProps;
-    $emit(eventName: 'update:modelValue', value: any): this;
-    $emit(eventName: 'item-select', e: {originalEvent: Event, value: any}): this;
-    $emit(eventName: 'item-unselect', e: {originalEvent: Event, value: any}): this;
-    $emit(eventName: 'dropdown-click', e: {originalEvent: Event, query: string}): this;
-    $emit(eventName: 'complete', e: {originalEvent: Event, query: string}): this;
-    $emit(eventName: 'clear'): this;
-    $slots: {
-        item: AutoCompleteItemSlotInterface;
-        optiongroup: AutoCompleteOptionGroupInterface;
-        header: AutoCompleteHeaderInterface;
-        footer: AutoCompleteFooterInterface;
-        chip: AutoCompleteChipInterface;
-        content: AutoCompleteContentInterface;
-        loader: AutoCompleteLoaderInterface;
-    };
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        AutoComplete: GlobalComponentConstructor<AutoComplete>
+    }
 }
 
+/**
+ *
+ * AutoComplete is an input component that provides real-time suggestions when being typed.
+ *
+ * Demos:
+ *
+ * - [AutoComplete](https://www.primefaces.org/primevue/showcase/#/autocomplete)
+ *
+ */
 export default AutoComplete;

package/avatar/Avatar.d.ts

@@ -1,13 +1,62 @@
-interface AvatarProps {
-    label?: string;
-    icon?: string;
-    image?: string;
-    size?: string;
-    shape?: string;
+import { VNode } from 'vue';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+
+type AvatarSizeType = 'normal' | 'large' | 'xlarge' | undefined;
+
+type AvatarShapeType = 'square' | 'circle' | undefined;
+
+export interface AvatarProps {
+    /**
+     * Defines the text to display.
+     */
+    label?: string | undefined;
+    /**
+     * Defines the icon to display.
+     */
+    icon?: string | undefined;
+    /**
+     * Defines the image to display.
+     */
+    image?: string | undefined;
+    /**
+     * Size of the element, valid options are 'normal', 'large' and 'xlarge'.
+     * @see AvatarSizeType
+     * Default value is 'normal'.
+     */
+    size?: AvatarSizeType;
+    /**
+     * Shape of the element, valid options are 'square' and 'circle'.
+     * @see AvatarShapeType
+     * Default value is 'square'.
+     */
+    shape?: AvatarShapeType;
+}
+
+export interface AvatarSlots {
+    /**
+     * Content can easily be customized with the default slot instead of using the built-in modes.
+     */
+    default: () => VNode[];
+}
+
+export declare type AvatarEmits = {
 }
 
-declare class Avatar {
-    $props: AvatarProps
+declare class Avatar extends ClassComponent<AvatarProps, AvatarSlots, AvatarEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        Avatar: GlobalComponentConstructor<Avatar>
+    }
 }
 
+/**
+ *
+ * Avatar represents people using icons, labels and images.
+ *
+ * Demos:
+ *
+ * - [Avatar](https://www.primefaces.org/primevue/showcase/#/avatar)
+ *
+ */
 export default Avatar;

package/avatargroup/AvatarGroup.d.ts

@@ -1,7 +1,33 @@
-interface AvatarGroupProps {}
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-declare class AvatarGroup {
-    $props: AvatarGroupProps;
+export interface AvatarGroupProps {
 }
 
+export interface AvatarGroupSlots {
+}
+
+export declare type AvatarGroupEmits = {
+}
+
+declare class AvatarGroup extends ClassComponent<AvatarGroupProps, AvatarGroupSlots, AvatarGroupEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        AvatarGroup: GlobalComponentConstructor<AvatarGroup>
+    }
+}
+
+/**
+ *
+ * A set of Avatars can be displayed together using the AvatarGroup component.
+ *
+ * Helper Components:
+ *
+ * - Avatar
+ *
+ * Demos:
+ *
+ * - [AvatarGroup](https://www.primefaces.org/primevue/showcase/#/avatar)
+ *
+ */
 export default AvatarGroup;

package/badge/Badge.d.ts

@@ -1,11 +1,52 @@
-interface BadgeProps {
+import { VNode } from 'vue';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+
+type BadgeSeverityType = 'info' | 'success' | 'warning' | 'danger' | undefined;
+
+type BadgeSizeType = 'large' | 'xlarge' | undefined;
+
+export interface BadgeProps {
+    /**
+     * Value to display inside the badge.
+     */
     value?: any;
-    severity?: string;
-    size?: string;
+    /**
+     * Severity type of the badge.
+     * @see BadgeSeverityType
+     */
+    severity?: BadgeSeverityType;
+    /**
+     * Size of the badge, valid options are 'large' and 'xlarge'.
+     * @see BadgeSizeType
+     */
+    size?: BadgeSizeType;
+}
+
+export interface BadgeSlots {
+    /**
+     * Content can easily be customized with the default slot instead of using the built-in display.
+     */
+     default: () => VNode[];
+}
+
+export declare type BadgeEmits = {
 }
 
-declare class Badge {
-    $props: BadgeProps;
+declare class Badge extends ClassComponent<BadgeProps, BadgeSlots, BadgeEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        Badge: GlobalComponentConstructor<Badge>
+    }
 }
 
+/**
+ *
+ * Badge is a small status indicator for another element.
+ *
+ * Demos:
+ *
+ * - [Badge](https://www.primefaces.org/primevue/showcase/#/badge)
+ *
+ */
 export default Badge;

package/blockui/BlockUI.d.ts

@@ -1,19 +1,60 @@
 import { VNode } from 'vue';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-interface BlockUIProps {
-    blocked?: boolean;
-    fullScreen?: boolean;
-    baseZIndex?: number;
-    autoZIndex?: boolean;
+export interface BlockUIProps {
+    /**
+     * Controls the blocked state.
+     */
+    blocked?: boolean | undefined;
+    /**
+     * When enabled, the whole document gets blocked.
+     */
+    fullScreen?: boolean | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * Default value is 0.
+     */
+    baseZIndex?: number | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * Default value is true.
+     */
+    autoZIndex?: boolean | undefined;
 }
 
-declare class BlockUI {
-    $props: BlockUIProps;
-    $emit(eventName: 'block'): this;
-    $emit(eventName: 'unblock'): this;
-    $slots: {
-        '': VNode[];
+export interface BlockUISlots {
+    /**
+     * Custom content's slot.
+     */
+     default: () => VNode[];
+}
+
+export declare type BlockUIEmits = {
+    /**
+     * Fired when the element gets blocked.
+     */
+    'block': () => void;
+    /**
+     * Fired when the element gets unblocked.
+     */
+    'unblock': () => void;
+}
+
+declare class BlockUI extends ClassComponent<BlockUIProps, BlockUISlots, BlockUIEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        BlockUI: GlobalComponentConstructor<BlockUI>
     }
 }
 
+/**
+ *
+ * BlockUI can either block other components or the whole page.
+ *
+ * Demos:
+ *
+ * - [BlockUI](https://www.primefaces.org/primevue/showcase/#/blockui)
+ *
+ */
 export default BlockUI;

package/breadcrumb/Breadcrumb.d.ts

@@ -1,18 +1,58 @@
-interface BreadcrumbProps {
-    home?: any;
-    model?: any[];
+import { VNode } from 'vue';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+import { MenuItem } from '../menuitem';
+
+export interface BreadcrumbProps {
+    /**
+     * An array of menuitems.
+     */
+    model?: MenuItem[];
+    /**
+     * Configuration for the home icon.
+     */
+    home?: MenuItem;
+    /**
+     * Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
+     * Default value is true.
+     */
     exact?: boolean;
 }
 
-interface BreadcrumbItemSlotInterface {
-    item: any;
+export interface BreadcrumbSlots {
+    /**
+     * Custom item template.
+     * @param {Object} scope - item slot's params.
+     */
+    item: (scope: {
+        /**
+         * Menuitem instance
+         */
+        item: MenuItem;
+    }) => VNode[];
+}
+
+export declare type BreadcrumbEmits = {
 }
 
-declare class Breadcrumb {
-    $props: BreadcrumbProps;
-    $slots: {
-        item: BreadcrumbItemSlotInterface
+declare class Breadcrumb extends ClassComponent<BreadcrumbProps, BreadcrumbSlots, BreadcrumbEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        Breadcrumb: GlobalComponentConstructor<Breadcrumb>
     }
 }
 
+/**
+ *
+ * Breadcrumb provides contextual information about page hierarchy.
+ *
+ * Helper API:
+ *
+ * - [MenuItem](https://www.primefaces.org/primevue/showcase/#/menumodel)
+ *
+ * Demos:
+ *
+ * - [Breadcrumb](https://www.primefaces.org/primevue/showcase/#/breadcrumb)
+ *
+ */
 export default Breadcrumb;