primevue 3.16.2 → 3.18.0

package/dropdown/Dropdown.d.ts

@@ -1,6 +1,6 @@
-import { VNode } from 'vue';
+import { HTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
-import { VirtualScrollerProps, VirtualScrollerItemOptions } from '../virtualscroller';
+import { VirtualScrollerItemOptions, VirtualScrollerProps } from '../virtualscroller';
 
 type DropdownOptionLabelType = string | ((data: any) => string) | undefined;
 
@@ -132,7 +132,7 @@ export interface DropdownProps {
     /**
      * Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.
      */
-    inputProps?: HTMLInputElement | HTMLSpanElement | undefined;
+    inputProps?: InputHTMLAttributes | HTMLAttributes | undefined;
     /**
      * Inline style of the overlay panel.
      */
@@ -144,15 +144,15 @@ export interface DropdownProps {
     /**
      * Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.
      */
-    panelProps?: HTMLDivElement | undefined;
+    panelProps?: HTMLAttributes | undefined;
     /**
      * Uses to pass all properties of the HTMLInputElement to the filter input inside the component.
      */
-    filterInputProps?: HTMLInputElement | undefined;
+    filterInputProps?: InputHTMLAttributes | undefined;
     /**
      * Uses to pass all properties of the HTMLElement to the clear icon inside the component.
      */
-    clearIconProps?: HTMLElement | undefined;
+    clearIconProps?: HTMLAttributes | 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 DropdownAppendToType
@@ -163,11 +163,30 @@ export interface DropdownProps {
      * Whether the dropdown is in loading state.
      */
     loading?: boolean | undefined;
+    /**
+     * Icon to display in clear button.
+     * Default value is 'pi pi-times'.
+     */
+    clearIcon?: string | undefined;
+    /**
+     * Icon to display in the dropdown.
+     * Default value is 'pi pi-chevron-down'.
+     */
+    dropdownIcon?: string | undefined;
+    /**
+     * Icon to display in filter input.
+     * Default value is 'pi pi-search'.
+     */
+    filterIcon?: string | undefined;
     /**
      * Icon to display in loading state.
      * Default value is 'pi pi-spinner pi-spin'.
      */
     loadingIcon?: string | undefined;
+    /**
+     * Clears the filter value when hiding the dropdown.
+     */
+    resetFilterOnHide?: boolean;
     /**
      * Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.
      * @see VirtualScroller.VirtualScrollerProps
@@ -178,6 +197,16 @@ export interface DropdownProps {
      * Default value is true.
      */
     autoOptionFocus?: boolean | undefined;
+    /**
+     * Whether to focus on the filter element when the overlay panel is shown.
+     * Default value is false.
+     */
+    autoFilterFocus?: boolean | undefined;
+    /**
+     * When enabled, the focused option is selected.
+     * Default value is false.
+     */
+    selectOnFocus?: boolean | undefined;
     /**
      * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.
      * Default value is '{0} results are available'.
@@ -210,11 +239,11 @@ export interface DropdownProps {
     /**
      * Defines a string value that labels an interactive element.
      */
-    "aria-label"?: string | undefined;
+    'aria-label'?: string | undefined;
     /**
      * Identifier of the underlying input element.
      */
-    "aria-labelledby"?: string | undefined;
+    'aria-labelledby'?: string | undefined;
 }
 
 export interface DropdownSlots {
@@ -347,17 +376,17 @@ export declare type DropdownEmits = {
      * Callback to invoke on value change.
      * @param {DropdownChangeEvent} event - Custom change event.
      */
-    'change': (event: DropdownChangeEvent) => void;
+    change: (event: DropdownChangeEvent) => void;
     /**
      * Callback to invoke when the component receives focus.
      * @param {Event} event - Browser event.
      */
-    'focus': (event: Event) => void;
+    focus: (event: Event) => void;
     /**
      * Callback to invoke when the component loses focus.
      * @param {Event} event - Browser event.
      */
-    'blur': (event: Event) => void;
+    blur: (event: Event) => void;
     /**
      * Callback to invoke before the overlay is shown.
      */
@@ -369,17 +398,17 @@ export declare type DropdownEmits = {
     /**
      * Callback to invoke when the overlay is shown.
      */
-    'show': () => void;
+    show: () => void;
     /**
      * Callback to invoke when the overlay is hidden.
      */
-    'hide': () => void;
+    hide: () => void;
     /**
      * Callback to invoke on filter input.
      * @param {DropdownFilterEvent} event - Custom filter event.
      */
-    'filter': (event: DropdownFilterEvent) => void;
-}
+    filter: (event: DropdownFilterEvent) => void;
+};
 
 declare class Dropdown extends ClassComponent<DropdownProps, DropdownSlots, DropdownEmits> {
     /**
@@ -400,7 +429,7 @@ declare class Dropdown extends ClassComponent<DropdownProps, DropdownSlots, Drop
 
 declare module '@vue/runtime-core' {
     interface GlobalComponents {
-        Dropdown: GlobalComponentConstructor<Dropdown>
+        Dropdown: GlobalComponentConstructor<Dropdown>;
     }
 }
 
@@ -410,7 +439,7 @@ declare module '@vue/runtime-core' {
  *
  * Demos:
  *
- * - [Dropdown](https://www.primefaces.org/primevue/showcase/#/dropdown)
+ * - [Dropdown](https://www.primefaces.org/primevue/dropdown)
  *
  */
 export default Dropdown;