coveo-search-ui/src/ui/Combobox/ICombobox.ts

Coveo JavaScript Search Framework

import { IAriaLive } from '../AriaLive/AriaLive';

export interface IComboboxValue {
  value: any;
  element: HTMLElement;
}

export interface IComboboxOptions {
  label: string;
  requestValues: (terms: string) => Promise<any>;
  createValuesFromResponse: (response: any) => IComboboxValue[];
  onSelectValue: (value: IComboboxValue) => void;
  ariaLive: IAriaLive;
  placeholderText?: string;
  wrapperClassName?: string;
  clearOnBlur?: boolean;
  scrollable?: {
    maxDropdownHeight: number;
    requestMoreValues: () => Promise<any>;
    areMoreValuesAvailable: () => boolean;
  };
  highlightValueClassName?: string;
}

export interface ICombobox {
  options: IComboboxOptions;
  element: HTMLElement;
  id: string;
  values: IComboboxValues;
  clearAll(): void;
  onInputChange(value: string): void;
  onInputBlur(): void;
  updateAccessibilityAttributes(attributes: IComboboxAccessibilityAttributes): void;
  updateAriaLive(): void;
  onScrollEndReached(): void;
}

export interface IComboboxValues {
  element: HTMLElement;
  mouseIsOverValue: boolean;
  isRenderingNewValues: boolean;
  numberOfValues: number;
  hasValues(): boolean;
  renderFromResponse(response: any): void;
  clearValues(): void;
  selectActiveValue(): void;
  resetScroll(): void;
  focusNextValue(): void;
  focusPreviousValue(): void;
  focusFirstValue(): void;
  focusLastValue(): void;
  saveFocusedValue(): void;
  restoreFocusedValue(): void;
}

export interface IComboboxAccessibilityAttributes {
  activeDescendant: string;
  expanded: boolean;
}