@empathyco/x-components/types/x-modules/query-suggestions/events.types.d.ts

Empathy X Components

import type { QuerySuggestionsRequest, Suggestion } from '@empathyco/x-types';
/**
 * Dictionary of the events of QuerySuggestions XModule, where each key is the event name, and the
 * value is the event payload type or `void` if it has no payload.
 *
 * @public
 */
export interface QuerySuggestionsXEvents {
    /**
     * Query suggestions have been changed.
     * Payload: The new {@link @empathyco/x-types#Suggestion | query suggestions}.
     */
    QuerySuggestionsChanged: Suggestion[];
    /**
     * Any property of the query-suggestions request has changed.
     * Payload: The new query suggestions request or `null` if there is not enough data in the state
     * to conform a valid request.
     */
    QuerySuggestionsRequestUpdated: QuerySuggestionsRequest | null;
    /**
     * User selected a query suggestion
     * Payload: The {@link @empathyco/x-types#Suggestion | query suggestion} that the user
     * selected.
     */
    UserSelectedAQuerySuggestion: Suggestion;
}
//# sourceMappingURL=events.types.d.ts.map