@empathyco/x-components
Version:
Empathy X Components
24 lines (15 loc) • 1.48 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UrlXEvents](./x-components.urlxevents.md)
## UrlXEvents interface
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.
**Signature:**
```typescript
export interface UrlXEvents
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [ExtraParamsLoadedFromUrl](./x-components.urlxevents.extraparamsloadedfromurl.md) | | Dictionary<unknown> | Url loaded. Payload: The extra params form URL in form of Dictionary with <code>unknown</code> values. |
| [ParamsLoadedFromUrl](./x-components.urlxevents.paramsloadedfromurl.md) | | [UrlParams](./x-components.urlparams.md) | Url loaded. Payload: The new [UrlParams](./x-components.urlparams.md) params. |
| [PushableUrlStateUpdated](./x-components.urlxevents.pushableurlstateupdated.md) | | [UrlParams](./x-components.urlparams.md) | Url state changed with a change to add new entry to browser URL History State. Payload: The new URL params. |
| [ReplaceableUrlStateUpdated](./x-components.urlxevents.replaceableurlstateupdated.md) | | [UrlParams](./x-components.urlparams.md) | Url state changed with a change to replace the current entry to browser URL History State. Payload: The new URL params. |