igniteui-webcomponents 7.1.0 → 7.1.2

package/components/combo/combo.d.ts

@@ -1,11 +1,10 @@
 import { type IComboResourceStrings } from 'igniteui-i18n-core';
-import { LitElement, type TemplateResult } from 'lit';
-import type { Constructor } from '../common/mixins/constructor.js';
-import { DataController } from './controllers/data.js';
-import { ComboNavigationController } from './controllers/navigation.js';
-import { SelectionController } from './controllers/selection.js';
+import { type PropertyValues, type TemplateResult } from 'lit';
+import { IgcBaseComboBoxComponent } from '../common/mixins/combo-box.js';
+import type { AbstractConstructor } from '../common/mixins/constructor.js';
+import type { Validator } from '../common/validators.js';
 import type { ComboItemTemplate, ComboRenderFunction, ComboValue, FilteringOptions, GroupingDirection, IgcComboComponentEventMap, Item, Keys } from './types.js';
-declare const IgcComboComponent_base: Constructor<import("../common/mixins/forms/types.js").FormRequiredInterface & import("../common/mixins/forms/types.js").FormAssociatedElementInterface> & Constructor<import("../common/mixins/event-emitter.js").EventEmitterInterface<IgcComboComponentEventMap>> & Constructor<LitElement>;
+declare const IgcComboComponent_base: import("../common/mixins/constructor.js").Constructor<import("../common/mixins/forms/types.js").FormRequiredInterface & import("../common/mixins/forms/types.js").FormAssociatedElementInterface> & import("../common/mixins/constructor.js").Constructor<import("../common/mixins/event-emitter.js").EventEmitterInterface<IgcComboComponentEventMap>> & AbstractConstructor<IgcBaseComboBoxComponent>;
 /**
  * The Combo component is similar to the Select component in that it provides a list of options from which the user can make a selection.
  * In contrast to the Select component, the Combo component displays all options in a virtualized list of items,
@@ -60,37 +59,41 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
     static readonly tagName = "igc-combo";
     static styles: import("lit").CSSResult[];
     static register(): void;
-    protected get __validators(): import("../common/validators.js").Validator<IgcComboComponent<any>>[];
+    protected get __validators(): Validator<IgcComboComponent<T>>[];
+    private readonly _slots;
+    protected readonly _rootClickController: import("../common/controllers/root-click.js").RootClickController;
+    protected readonly _i18nController: import("../common/i18n/i18n-controller.js").I18nController<IComboResourceStrings>;
+    protected readonly _formValue: import("../common/mixins/forms/form-value.js").FormValue<ComboValue<T>[]>;
     /** The primary input of the combo component. */
-    private _inputRef;
+    private readonly _inputRef;
     /** The search input of the combo component. */
-    private _searchRef;
+    private readonly _searchRef;
     /** The combo virtualized dropdown list. */
-    private _listRef;
-    private readonly _rootClickController;
-    protected readonly _i18nController: import("../common/i18n/i18n-controller.js").I18nController<IComboResourceStrings>;
-    protected readonly _formValue: import("../common/mixins/forms/form-value.js").FormValue<ComboValue<T>[]>;
+    private readonly _listRef;
+    private readonly _state;
+    private readonly _navigation;
     private _data;
     private _valueKey?;
     private _displayKey?;
-    private _groupKey?;
+    private _placeholderSearch?;
     private _disableFiltering;
     private _singleSelect;
-    private _groupSorting;
+    private _selected;
     private _filteringOptions;
-    private _activeDescendant;
+    private set _activeIndex(value);
+    private get _activeIndex();
+    private set _searchTerm(value);
+    private get _searchTerm();
+    private _activeDescendant?;
     private _displayValue;
-    protected _state: DataController<T>;
-    protected _selection: SelectionController<T>;
-    protected _navigation: ComboNavigationController<T>;
-    protected inputSuffix: HTMLElement[];
-    protected inputPrefix: HTMLElement[];
+    private get _mainAriaLabel();
     /** The data source used to generate the list of options. */
     set data(value: T[]);
     get data(): T[];
     /**
      * The outlined attribute of the control.
      * @attr outlined
+     * @default false
      */
     outlined: boolean;
     /**
@@ -108,6 +111,7 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
     /**
      * Focuses the list of options when the menu opens.
      * @attr autofocus-list
+     * @default false
      */
     autofocusList: boolean;
     /**
@@ -120,24 +124,18 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
      * The label attribute of the control.
      * @attr label
      */
-    label: string;
+    label?: string;
     /**
      * The placeholder attribute of the control.
      * @attr placeholder
      */
-    placeholder: string;
+    placeholder?: string;
     /**
      * The placeholder attribute of the search input.
      * @attr placeholder-search
      */
-    set placeholderSearch(value: string);
+    set placeholderSearch(value: string | undefined);
     get placeholderSearch(): string;
-    private _placeholderSearch;
-    /**
-     * Sets the open state of the component.
-     * @attr open
-     */
-    open: boolean;
     /**
      * The resource strings for localization.
      */
@@ -159,16 +157,14 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
      * The key in the data source used to group items in the list.
      * @attr group-key
      */
-    set groupKey(value: Keys<T> | undefined);
-    get groupKey(): Keys<T> | undefined;
+    groupKey?: Keys<T> | string;
     /**
      * Sorts the items in each group by ascending or descending order.
      * @attr group-sorting
-     * @default asc
+     * @default "asc"
      * @type {"asc" | "desc" | "none"}
      */
-    set groupSorting(value: GroupingDirection);
-    get groupSorting(): GroupingDirection;
+    groupSorting: GroupingDirection;
     /**
      * An object that configures the filtering of the combo.
      * @attr filtering-options
@@ -182,6 +178,7 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
     /**
      * Enables the case sensitive search icon in the filtering input.
      * @attr case-sensitive-icon
+     * @default false
      */
     caseSensitiveIcon: boolean;
     /**
@@ -239,28 +236,67 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
      * represented by the value key, when provided.
      */
     get value(): ComboValue<T>[];
-    protected _updateSelection(): void;
-    protected toggleDirectiveChange(): void;
+    /**
+     * Returns the current selection as an array of objects as provided in the `data` source.
+     */
+    get selection(): T[];
     constructor();
-    protected firstUpdated(): Promise<void>;
+    protected willUpdate(props: PropertyValues<this>): void;
     protected _restoreDefaultValue(): void;
     protected _setDefaultValue(current: string | null): void;
-    protected _setFormValue(): void;
-    protected resetSearchTerm(): void;
-    protected updateValue(initial?: boolean): void;
+    protected _show(emitEvent?: boolean): Promise<boolean>;
+    protected _hide(emitEvent?: boolean): Promise<boolean>;
+    /**
+     * Resolves user-provided items (value keys or object references)
+     * to actual objects from the data source in a single pass.
+     */
+    private _resolveItems;
+    /**
+     * Gets the value representation of a data record
+     * (its value-key property, or the record itself).
+     */
+    private _resolveItemValue;
+    /**
+     * Maps data items to their value representations using the given key.
+     * When key is undefined, returns the items themselves.
+     */
+    private _getValues;
+    private _emitSelectionChange;
+    private _selectItems;
+    private _deselectItems;
+    /**
+     * Syncs the internal `_selected` set from the current `_formValue`.
+     * This is a one-way sync: source of truth (_formValue) → view (_selected).
+     */
+    private _syncSelectionFromValue;
+    /**
+     * Finds an item in the data array by its value (or value key).
+     * Returns undefined if the item is not found.
+     */
+    private _findItemByValue;
+    protected _syncValueFromSelection(initial?: boolean): void;
+    private _toggleSelection;
+    private _selectByIndex;
+    private _clearSelection;
+    private _clearSingleSelection;
+    protected _handleMainInput({ detail, }: CustomEvent<string>): Promise<void>;
+    protected _handleFocusIn(): void;
+    protected _handleBlur(): void;
+    protected _handleSearchInput({ detail }: CustomEvent<string>): void;
+    private _handleClosing;
+    private _itemClickHandler;
+    private _handleClearIconClick;
+    private _handleCaseSensitivity;
     /** Sets focus on the component. */
     focus(options?: FocusOptions): void;
     /** Removes focus from the component. */
     blur(): void;
-    /**
-     * Returns the current selection as an array of objects as provided in the `data` source.
-     */
-    get selection(): T[];
     /**
      * Selects option(s) in the list by either reference or valueKey.
      * If not argument is provided all items will be selected.
-     * @param { Item<T> | Items<T> } items - One or more items to be selected. Multiple items should be passed as an array.
+     * @param { Item<T> | Item<T>[] } items - One or more items to be selected. Multiple items should be passed as an array.
      * When valueKey is specified, the corresponding value should be used in place of the item reference.
+     *
      * @example
      * ```typescript
      * const combo<IgcComboComponent<T>> = document.querySelector('igc-combo');
@@ -282,8 +318,9 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
     /**
      * Deselects option(s) in the list by either reference or valueKey.
      * If not argument is provided all items will be deselected.
-     * @param { Item<T> | Items<T> } items - One or more items to be deselected. Multiple items should be passed as an array.
+     * @param { Item<T> | Item<T>[] } items - One or more items to be deselected. Multiple items should be passed as an array.
      * When valueKey is specified, the corresponding value should be used in place of the item reference.
+     *
      * @example
      * ```typescript
      * const combo<IgcComboComponent<T>> = document.querySelector('igc-combo');
@@ -302,40 +339,14 @@ export default class IgcComboComponent<T extends object = any> extends IgcComboC
      * ```
      */
     deselect(items?: Item<T> | Item<T>[]): void;
-    protected handleMainInput({ detail }: CustomEvent<string>): Promise<void>;
-    protected _handleFocusIn(): void;
-    protected _handleBlur(): void;
-    protected handleSearchInput({ detail }: CustomEvent<string>): void;
-    protected handleOpening(): boolean;
-    protected handleClosing(): boolean;
-    protected _show(emitEvent?: boolean): Promise<boolean>;
-    /** Shows the list of options. */
-    show(): Promise<boolean>;
-    protected _hide(emitEvent?: boolean): Promise<boolean>;
-    /** Hides the list of options. */
-    hide(): Promise<boolean>;
-    protected _toggle(emit?: boolean): Promise<boolean>;
-    /** Toggles the list of options. */
-    toggle(): Promise<boolean>;
-    private _getActiveDescendantId;
-    protected itemRenderer: ComboRenderFunction<T>;
-    protected itemClickHandler(event: PointerEvent): void;
-    protected toggleSelect(index: number): void;
-    protected selectByIndex(index: number): void;
-    /** @hidden @internal */
-    clearSelection(): void;
-    protected clearSingleSelection(): void;
-    protected handleClearIconClick(e: PointerEvent): void;
-    protected toggleCaseSensitivity(): void;
-    protected getMainAriaLabel(): string;
-    private _stopPropagation;
-    private renderToggleIcon;
-    private renderClearIcon;
-    private renderMainInput;
-    private renderSearchInput;
-    private renderEmptyTemplate;
-    private renderList;
-    private renderHelperText;
+    protected _itemRenderer: ComboRenderFunction<T>;
+    private _renderToggleIcon;
+    private _renderClearIcon;
+    private _renderMainInput;
+    private _renderSearchInput;
+    private _renderEmptyTemplate;
+    private _renderList;
+    private _renderHelperText;
     protected render(): TemplateResult<1>;
 }
 declare global {