@empathyco/x-components/types/x-modules/next-queries/events.types.d.ts

Empathy X Components

import type { NextQueriesRequest, NextQuery } from '@empathyco/x-types';
/**
 * Dictionary of the events of NextQueries 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 NextQueriesXEvents {
    /**
     * Next Queries have been changed.
     * Payload: The new {@link @empathyco/x-types#NextQuery | next queries}.
     */
    NextQueriesChanged: NextQuery[];
    /**
     * The current next queries have been displayed to the user.
     * Payload: The displayed next queries.
     */
    NextQueriesDisplayed: NextQuery[];
    /**
     * Any property of the next-queries request has changed
     * Payload: The new next-queries request or `null` if there is not enough data in the state
     * to conform a valid request.
     */
    NextQueriesRequestUpdated: NextQueriesRequest | null;
    /**
     * The user has selected a next-query
     * Payload: The next query that has been selected by the user.
     */
    UserSelectedANextQuery: NextQuery;
    /**
     * The component to show a next query preview has been mounted.
     * Payload: The next query to preview.
     */
    NextQueryPreviewMountedHook: string;
}
//# sourceMappingURL=events.types.d.ts.map