@progress/kendo-vue-dropdowns 8.0.3-develop.2 → 8.0.3-develop.4

package/ComboBox/ComboBox.d.ts

@@ -0,0 +1,371 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ComboBoxChangeEvent, ComboBoxOpenEvent, ComboBoxCloseEvent, ComboBoxFocusEvent, ComboBoxBlurEvent, ComboBoxFilterChangeEvent, ComboBoxPageChangeEvent } from './ComboBoxProps';
+import { InternalState } from './../common/settings';
+import { FormComponentValidity } from '@progress/kendo-vue-common';
+import { PropType } from 'vue';
+/**
+ * @hidden
+ */
+declare const ComboBox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    id: PropType<string>;
+    dataItemKey: {
+        type: PropType<string>;
+    };
+    defaultValue: {
+        type: PropType<any>;
+        default: any;
+    };
+    name: StringConstructor;
+    modelValue: {
+        type: PropType<any>;
+        default: any;
+    };
+    value: {
+        type: PropType<any>;
+        default: any;
+    };
+    label: {
+        type: PropType<string>;
+    };
+    placeholder: PropType<string>;
+    required: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    valid: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    validationMessage: {
+        type: PropType<string>;
+        default: any;
+    };
+    validityStyles: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    iconClassName: PropType<string>;
+    opened: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    disabled: PropType<boolean>;
+    dir: {
+        type: PropType<string>;
+        default: any;
+    };
+    tabIndex: {
+        type: PropType<number>;
+        default: number;
+    };
+    accessKey: PropType<string>;
+    dataItems: PropType<any[]>;
+    textField: PropType<string>;
+    className: PropType<string>;
+    loading: PropType<boolean>;
+    popupSettings: {
+        type: PropType<import('./../common/settings').DropDownsPopupSettings>;
+        default: () => {
+            animate: boolean;
+            height: string;
+            anchor: string;
+        };
+    };
+    itemRender: PropType<any>;
+    groupHeaderItemRender: PropType<any>;
+    groupStickyHeaderItemRender: PropType<any>;
+    listNoDataRender: PropType<any>;
+    focusedItemIndex: PropType<(data: any, inputText: string, textField?: string) => number>;
+    header: PropType<any>;
+    footer: PropType<any>;
+    filterable: PropType<boolean>;
+    filter: {
+        type: PropType<string>;
+        default: any;
+    };
+    virtual: {
+        type: PropType<import('./../common/settings').VirtualizationSettings>;
+        default: any;
+    };
+    suggest: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    allowCustom: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    clearButton: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    ariaLabel: {
+        type: PropType<string>;
+        default: any;
+    };
+    ariaLabelledBy: PropType<string>;
+    ariaDescribedBy: PropType<string>;
+    valueField: PropType<string>;
+    valuePrimitive: PropType<boolean>;
+    rounded: {
+        type: PropType<"small" | "medium" | "large" | "full" | "none">;
+        validator: (value: string) => boolean;
+    };
+    fillMode: {
+        type: PropType<"flat" | "solid" | "outline">;
+        validator: (value: string) => boolean;
+    };
+    size: {
+        type: PropType<"small" | "medium" | "large">;
+        validator: (value: string) => boolean;
+    };
+    groupField: {
+        type: PropType<string>;
+    };
+    adaptive: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    adaptiveTitle: {
+        type: PropType<string>;
+        default: any;
+    };
+    onFilterchange: PropType<(event: ComboBoxFilterChangeEvent) => void>;
+    inputAttributes: PropType<Object>;
+}>, {
+    inputRef: import('vue').Ref<any, any>;
+    elementRef: import('vue').Ref<any, any>;
+    kendoAnchorRef: import('vue').Ref<any, any>;
+    kendoLocalizationService: {};
+}, {
+    hasMounted: boolean;
+    currentText: string;
+    currentValue: string;
+    currentFocused: boolean;
+    currentOpened: boolean;
+    searchState: {
+        word: string;
+        last: string;
+    };
+    _skipFocusEvent: boolean;
+    valueDuringOnChange: {};
+    _navigated: boolean;
+    suggested: string;
+    group: any;
+    isScrolling: boolean;
+    itemHeight: number;
+    state: any;
+    popupWidth: any;
+    windowWidth: number;
+}, {
+    index(): number;
+    spanClassNames(): object;
+    isOpen(): boolean;
+    animationStyles(): object | undefined;
+    classNameAdaptive(): string;
+    adaptiveState(): any;
+}, {
+    focus(): void;
+    computedValue(): any;
+    findByFieldValue(field: string, value: string): any;
+    primitiveValue(): any;
+    validity(): FormComponentValidity;
+    handleItemSelect(index: number, state: InternalState): void;
+    onNavigate(state: InternalState, keyCode: number): void;
+    toggleBtnClick(event: MouseEvent): void;
+    applyValueOnEnter(value: string, state: InternalState): any;
+    applyValueOnRejectSuggestions(text: string, state: InternalState): any;
+    selectFocusedItem(text: string, state: InternalState): any;
+    handleItemClick(index: number, event: any): void;
+    handleFocus(event: any): void;
+    handleBlur(event: any): void;
+    onInputKeyDown(event: any): void;
+    inputOnChange(event: any): void;
+    clearButtonClick(event: any): void;
+    getFocusedIndex(): number;
+    suggestValue(value?: string): void;
+    setValidity(): void;
+    compareValues(value: any, item: any): boolean;
+    triggerOnChange(item: any, state: InternalState): void;
+    applyState(state: InternalState): void;
+    calculateMedia(entries: ResizeObserverEntry[]): void;
+    repositionPopup(): void;
+    onScroll(event: any): void;
+    getInputText(text: any, selectedItemText: any): string;
+    getSelectedItemText(): string | undefined;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    changemodel: (value: any) => true;
+    'update:modelValue': (value: any) => true;
+    filterchange: (event: ComboBoxFilterChangeEvent) => true;
+    pagechange: (event: ComboBoxPageChangeEvent) => true;
+    change: (event: ComboBoxChangeEvent) => true;
+    focus: (event: ComboBoxFocusEvent) => true;
+    blur: (event: ComboBoxBlurEvent) => true;
+    open: (event: ComboBoxOpenEvent) => true;
+    close: (event: ComboBoxCloseEvent) => true;
+    scroll: (event: Event) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    id: PropType<string>;
+    dataItemKey: {
+        type: PropType<string>;
+    };
+    defaultValue: {
+        type: PropType<any>;
+        default: any;
+    };
+    name: StringConstructor;
+    modelValue: {
+        type: PropType<any>;
+        default: any;
+    };
+    value: {
+        type: PropType<any>;
+        default: any;
+    };
+    label: {
+        type: PropType<string>;
+    };
+    placeholder: PropType<string>;
+    required: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    valid: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    validationMessage: {
+        type: PropType<string>;
+        default: any;
+    };
+    validityStyles: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    iconClassName: PropType<string>;
+    opened: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    disabled: PropType<boolean>;
+    dir: {
+        type: PropType<string>;
+        default: any;
+    };
+    tabIndex: {
+        type: PropType<number>;
+        default: number;
+    };
+    accessKey: PropType<string>;
+    dataItems: PropType<any[]>;
+    textField: PropType<string>;
+    className: PropType<string>;
+    loading: PropType<boolean>;
+    popupSettings: {
+        type: PropType<import('./../common/settings').DropDownsPopupSettings>;
+        default: () => {
+            animate: boolean;
+            height: string;
+            anchor: string;
+        };
+    };
+    itemRender: PropType<any>;
+    groupHeaderItemRender: PropType<any>;
+    groupStickyHeaderItemRender: PropType<any>;
+    listNoDataRender: PropType<any>;
+    focusedItemIndex: PropType<(data: any, inputText: string, textField?: string) => number>;
+    header: PropType<any>;
+    footer: PropType<any>;
+    filterable: PropType<boolean>;
+    filter: {
+        type: PropType<string>;
+        default: any;
+    };
+    virtual: {
+        type: PropType<import('./../common/settings').VirtualizationSettings>;
+        default: any;
+    };
+    suggest: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    allowCustom: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    clearButton: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    ariaLabel: {
+        type: PropType<string>;
+        default: any;
+    };
+    ariaLabelledBy: PropType<string>;
+    ariaDescribedBy: PropType<string>;
+    valueField: PropType<string>;
+    valuePrimitive: PropType<boolean>;
+    rounded: {
+        type: PropType<"small" | "medium" | "large" | "full" | "none">;
+        validator: (value: string) => boolean;
+    };
+    fillMode: {
+        type: PropType<"flat" | "solid" | "outline">;
+        validator: (value: string) => boolean;
+    };
+    size: {
+        type: PropType<"small" | "medium" | "large">;
+        validator: (value: string) => boolean;
+    };
+    groupField: {
+        type: PropType<string>;
+    };
+    adaptive: {
+        type: PropType<boolean>;
+        default: any;
+    };
+    adaptiveTitle: {
+        type: PropType<string>;
+        default: any;
+    };
+    onFilterchange: PropType<(event: ComboBoxFilterChangeEvent) => void>;
+    inputAttributes: PropType<Object>;
+}>> & Readonly<{
+    onBlur?: (event: ComboBoxBlurEvent) => any;
+    onChange?: (event: ComboBoxChangeEvent) => any;
+    onClose?: (event: ComboBoxCloseEvent) => any;
+    onFocus?: (event: ComboBoxFocusEvent) => any;
+    onScroll?: (event: Event) => any;
+    onOpen?: (event: ComboBoxOpenEvent) => any;
+    onChangemodel?: (value: any) => any;
+    "onUpdate:modelValue"?: (value: any) => any;
+    onPagechange?: (event: ComboBoxPageChangeEvent) => any;
+    onFilterchange?: (event: ComboBoxFilterChangeEvent) => any;
+}>, {
+    filter: string;
+    required: boolean;
+    value: any;
+    ariaLabel: string;
+    tabIndex: number;
+    virtual: import('./../common/settings').VirtualizationSettings;
+    adaptive: boolean;
+    clearButton: boolean;
+    dir: string;
+    defaultValue: any;
+    opened: boolean;
+    popupSettings: import('./../common/settings').DropDownsPopupSettings;
+    modelValue: any;
+    valid: boolean;
+    validationMessage: string;
+    validityStyles: boolean;
+    adaptiveTitle: string;
+    suggest: boolean;
+    allowCustom: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export { ComboBox };

package/ComboBox/ComboBoxProps.d.ts

@@ -0,0 +1,286 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { FilterChangeEvent, ChangeEvent, OpenEvent, CloseEvent, FocusEvent, BlurEvent, PageChangeEvent } from './../common/events';
+import { FormComponentProps } from '@progress/kendo-vue-common';
+import { VirtualizationSettings, DropDownsPopupSettings } from '../common/settings';
+import { SVGIcon } from '@progress/kendo-svg-icons';
+/**
+ * Represents the object of the `FilterChange` ComboBox event.
+ */
+export interface ComboBoxFilterChangeEvent extends FilterChangeEvent {
+}
+/**
+ * Represents the object of the `change` ComboBox event.
+ */
+export interface ComboBoxChangeEvent extends ChangeEvent {
+}
+/**
+ * Represents the object of the `open` ComboBox event.
+ */
+export interface ComboBoxOpenEvent extends OpenEvent {
+}
+/**
+ * Represents the object of the `close` ComboBox event.
+ */
+export interface ComboBoxCloseEvent extends CloseEvent {
+}
+/**
+ * Represents the object of the `focus` ComboBox event.
+ */
+export interface ComboBoxFocusEvent extends FocusEvent {
+}
+/**
+ * Represents the object of the `blur` ComboBox event.
+ */
+export interface ComboBoxBlurEvent extends BlurEvent {
+}
+/**
+ * Represents the object of the `PageChange` ComboBox event.
+ */
+export interface ComboBoxPageChangeEvent extends PageChangeEvent {
+}
+/**
+ * Represents the props of the [Kendo UI for Vue ComboBox component]({% slug overview_combobox %}).
+ */
+export interface ComboBoxProps extends FormComponentProps {
+    /**
+     * Sets the dataItems of the ComboBox ([more information and examples]({% slug binding_combobox %})).
+     */
+    dataItems?: any[];
+    /**
+     * Sets the opened and closed state of the ComboBox.
+     */
+    opened?: boolean;
+    /**
+     * Sets the value of the ComboBox ([more information and examples]({% slug binding_combobox %})). It can either be of the primitive (string, numbers) or of the complex (objects) type.
+     */
+    value?: any;
+    /**
+     * Sets the default value of the ComboBox. Similar to the native `select` HTML element.
+     */
+    defaultValue?: any;
+    /**
+     * Defines the name for an existing arrow icon.
+     */
+    icon?: string;
+    /**
+     * Defines the svg icon in a Kendo UI for Vue theme.
+     */
+    svgIcon?: SVGIcon;
+    /**
+     * Sets CSS classes to the expand `icon` DOM element.
+     */
+    iconClassName?: string;
+    /**
+     * If `clearButton` is set to `true`, the ComboBox renders a button on hovering over the component. Clicking this button resets the value of the ComboBox to `undefined` and triggers the `change` event.
+     */
+    clearButton?: boolean;
+    /**
+     * The hint that is displayed when the ComboBox is empty.
+     */
+    placeholder?: string;
+    /**
+     * Enables the auto-completion of the text based on the first data item ([see example]({% slug suggestions_combobox %})).
+     */
+    suggest?: boolean;
+    /**
+     * Specifies whether the ComboBox allows user-defined values that are not present in the dataset ([see example]({% slug custom_values_combobox %})). Defaults to `false`.
+     */
+    allowCustom?: boolean;
+    /**
+     * Sets the disabled state of the ComboBox.
+     */
+    disabled?: boolean;
+    /**
+     * Sets additional classes to the DropDownList.
+     */
+    className?: string;
+    /**
+     * @hidden
+     */
+    modelValue?: any;
+    /**
+     * Represents the `dir` HTML attribute.
+     */
+    dir?: string;
+    /**
+     * Enables the filtering functionality of the ComboBox ([more information and examples]({% slug filtering_combobox %})).
+     */
+    filterable?: boolean;
+    /**
+     * Sets the value of ComboBox input. Useful for making the ComboBox input a controlled component.
+     */
+    filter?: string | null;
+    /**
+     * Sets the loading state of the ComboBox ([see example]({% slug filtering_combobox %}#toc-basic-configuration)).
+     */
+    loading?: boolean;
+    /**
+     * Specifies the `tabIndex` of the ComboBox.
+     */
+    tabIndex?: number;
+    /**
+     * Specifies the `accessKey` of the ComboBox.
+     */
+    accessKey?: string;
+    /**
+     * Sets the data item field that represents the item text. If the data contains only primitive values, do not define it.
+     */
+    textField?: string;
+    /**
+     * Sets the data item field that represents the item value.
+     */
+    valueField?: string;
+    /**
+     * Specifies the type of the selected value. If set to true, the selected value has to be of a primitive value.
+     */
+    valuePrimitive?: boolean;
+    /**
+     * Sets the key for comparing the data items of the ComboBox. If `dataItemKey` is not set, the ComboBox compares the items by reference ([see example]({% slug binding_combobox %}#toc-datasets-of-objects)).
+     */
+    dataItemKey?: string;
+    /**
+     * Renders a floating label for the ComboBox.
+     */
+    label?: string;
+    /**
+     * Configures the popup of the ComboBox.
+     */
+    popupSettings?: DropDownsPopupSettings;
+    /**
+     * Configures the virtual scrolling of the ComboBox ([more information and examples]({% slug virtualization_combobox %})).
+     */
+    virtual?: VirtualizationSettings;
+    /**
+     * Specifies the id of the component.
+     */
+    id?: string;
+    /**
+     * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
+     * For example these elements could contain error or hint message.
+     */
+    ariaDescribedBy?: string;
+    /**
+     * Identifies the element(s) which will label the component.
+     */
+    ariaLabelledBy?: string;
+    /**
+     * Defines the [aria-label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) attribute of the component.
+     */
+    ariaLabel?: string;
+    /**
+     * If set, the ComboBox will use it to get the focused item index.
+     *
+     * Default functionality returns the first item which starts with the input text.
+     */
+    focusedItemIndex?: (data: any, inputText: string, textField?: string) => number;
+    /**
+     * Fires each time the popup of the ComboBox is about to open.
+     */
+    onOpen?: (event: ComboBoxOpenEvent) => void;
+    /**
+     * Fires each time the popup of the ComboBox is about to close.
+     */
+    onClose?: (event: ComboBoxCloseEvent) => void;
+    /**
+     * Fires each time the user focuses the ComboBox.
+     */
+    onFocus?: (event: ComboBoxFocusEvent) => void;
+    /**
+     * Fires each time the ComboBox gets blurred.
+     */
+    onBlur?: (event: ComboBoxBlurEvent) => void;
+    /**
+     * Fires each time the value of the ComboBox is about to change ([see examples]({% slug binding_combobox %})).
+     */
+    onChange?: (event: ComboBoxChangeEvent) => void;
+    /**
+     * Fires each time the user types in the filter input ([see examples]({% slug filtering_combobox %}#toc-basic-configuration)). You can filter the source based on the passed filtration value.
+     */
+    onFilterchange?: (event: ComboBoxFilterChangeEvent) => void;
+    /**
+     * Fires when both the virtual scrolling of the ComboBox is enabled and the component requires data for another page ([more information and examples]({% slug virtualization_combobox %})).
+     */
+    onPagechange?: (event: ComboBoxPageChangeEvent) => void;
+    /**
+     * Fires when a ComboBox list item is about to be rendered ([see example]({% slug customrendering_combobox %}#toc-items)). Used to override the default appearance of the list items.
+     */
+    itemRender?: any;
+    /**
+     * Fires when the element which indicates no data in the popup is about to be rendered. Used to override the default appearance of the element.
+     */
+    listNoDataRender?: any;
+    /**
+     * Sets the header component of the ComboBox ([see example]({% slug customrendering_combobox %}#toc-headers-and-footers)).
+     */
+    header?: any;
+    /**
+     * Sets the footer component of the ComboBox ([see example]({% slug customrendering_combobox %}#toc-headers-and-footers)).
+     */
+    footer?: any;
+    /**
+     * Configures the `size` of the ComboBox.
+     *
+     * The available options are:
+     * - small
+     * - medium
+     * - large
+     *
+     * @default undefined
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Configures the `roundness` of the ComboBox.
+     *
+     * The available options are:
+     * - none
+     * - small
+     * - medium
+     * - large
+     * - full
+     *
+     * @default undefined
+     */
+    rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
+    /**
+     * Configures the `fillMode` of the ComboBox.
+     *
+     * The available options are:
+     * - solid
+     * - outline
+     * - flat
+     *
+     * @default undefined
+     */
+    fillMode?: 'solid' | 'outline' | 'flat';
+    /**
+     * Sets the data item field that represents the start of a group. Applicable to objects data.
+     */
+    groupField?: string;
+    /**
+     * Fires when a ComboBox group header item is about to be rendered. Used to override the default appearance of the group's headers.
+     */
+    groupHeaderItemRender?: any;
+    /**
+     * Fires when a ComboBox sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.
+     */
+    groupStickyHeaderItemRender?: any;
+    /**
+     * Provides different rendering of the popup element based on the screen dimensions ([see example]({% slug adaptive_rendering_combobox %})).
+     */
+    adaptive?: boolean;
+    /**
+     * Specifies the text that is rendered as title in the adaptive popup ([see example]({% slug adaptive_rendering_combobox %})).
+     */
+    adaptiveTitle?: string;
+    /**
+     * Sets the built-in HTML attributes of the inner focusable input element.
+     * Attributes which are essential for certain component functionalities cannot be changed.
+     */
+    inputAttributes?: Object;
+}