@empathyco/x-components
Version:
Empathy X Components
116 lines (51 loc) • 1.82 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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[ExtraParamsLoadedFromUrl](./x-components.urlxevents.extraparamsloadedfromurl.md)
</td><td>
</td><td>
Dictionary<unknown>
</td><td>
Url loaded. Payload: The extra params form URL in form of Dictionary with `unknown` values.
</td></tr>
<tr><td>
[ParamsLoadedFromUrl](./x-components.urlxevents.paramsloadedfromurl.md)
</td><td>
</td><td>
[UrlParams](./x-components.urlparams.md)
</td><td>
Url loaded. Payload: The new [UrlParams](./x-components.urlparams.md) params.
</td></tr>
<tr><td>
[PushableUrlStateUpdated](./x-components.urlxevents.pushableurlstateupdated.md)
</td><td>
</td><td>
[UrlParams](./x-components.urlparams.md)
</td><td>
Url state changed with a change to add new entry to browser URL History State. Payload: The new URL params.
</td></tr>
<tr><td>
[ReplaceableUrlStateUpdated](./x-components.urlxevents.replaceableurlstateupdated.md)
</td><td>
</td><td>
[UrlParams](./x-components.urlparams.md)
</td><td>
Url state changed with a change to replace the current entry to browser URL History State. Payload: The new URL params.
</td></tr>
</tbody></table>