igniteui-webcomponents/components/combo/types.d.ts

Ignite UI for Web Components is a complete library of UI components, giving you the ability to build modern web applications using encapsulation and the concept of reusable components in a dependency-free approach.

import type { RenderItemFunction } from '@lit-labs/virtualizer/virtualize.js';
import type { ReactiveControllerHost, TemplateResult } from 'lit';
import type IgcComboComponent from './combo.js';
export type Keys<T> = keyof T;
export type Values<T> = T[keyof T];
export type Item<T extends object> = T | Values<T>;
export type ComboRecord<T extends object> = {
    value: T;
    header: boolean;
    dataIndex: number;
};
export type ComboHost<T extends object> = ReactiveControllerHost & IgcComboComponent<T>;
export type GroupingDirection = 'asc' | 'desc' | 'none';
export type ComboChangeType = 'selection' | 'deselection' | 'addition';
export type ComboRenderFunction<T extends object> = RenderItemFunction<ComboRecord<T>>;
export type ComboValue<T> = T | Values<T>;
export interface FilteringOptions<T extends object> {
    filterKey: Keys<T> | undefined;
    caseSensitive?: boolean;
    matchDiacritics?: boolean;
}
export interface GroupingOptions<T extends object> {
    groupKey?: Keys<T>;
    valueKey?: Keys<T>;
    displayKey?: Keys<T>;
    direction: GroupingDirection;
}
export interface IgcComboChangeEventArgs<T extends object = any> {
    newValue: ComboValue<T>[];
    items: T[];
    type: ComboChangeType;
}
export interface IgcComboComponentEventMap {
    igcChange: CustomEvent<IgcComboChangeEventArgs>;
    focus: FocusEvent;
    blur: FocusEvent;
    igcOpening: CustomEvent<void>;
    igcOpened: CustomEvent<void>;
    igcClosing: CustomEvent<void>;
    igcClosed: CustomEvent<void>;
}
export type ComboItemTemplate<T extends object> = (props: ComboTemplateProps<T>) => TemplateResult;
export interface ComboTemplateProps<T extends object> {
    item: T;
}