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

Empathy X Components

import type { Dictionary } from '@empathyco/x-utils';
import type { UrlParams } from '../../types/url-params';
/**
 * Dictionary of the events of URL 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 UrlXEvents {
    /**
     * Url loaded.
     * Payload: The new {@link UrlParams} params.
     */
    ParamsLoadedFromUrl: UrlParams;
    /**
     * Url loaded.
     * Payload: The extra params form URL in form of Dictionary with `unknown` values.
     */
    ExtraParamsLoadedFromUrl: Dictionary<unknown>;
    /**
     * Url state changed with a change to add new entry to browser URL History State.
     * Payload: The new URL params.
     */
    PushableUrlStateUpdated: UrlParams;
    /**
     * Url state changed with a change to replace the current entry to browser URL History State.
     * Payload: The new URL params.
     */
    ReplaceableUrlStateUpdated: UrlParams;
}
//# sourceMappingURL=events.types.d.ts.map