@empathyco/x-components
Version:
Empathy X Components
192 lines (83 loc) • 2.71 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [TaggingXEvents](./x-components.taggingxevents.md)
## TaggingXEvents interface
Dictionary of the events of Tagging 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 TaggingXEvents
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[ConsentChanged](./x-components.taggingxevents.consentchanged.md)
</td><td>
</td><td>
boolean
</td><td>
Consent has changed. Payload: The new consent value.
</td></tr>
<tr><td>
[ConsentProvided](./x-components.taggingxevents.consentprovided.md)
</td><td>
</td><td>
boolean
</td><td>
Consent has been provided. Payload: The new consent value.
</td></tr>
<tr><td>
[PDPIsLoaded](./x-components.taggingxevents.pdpisloaded.md)
</td><td>
</td><td>
string
</td><td>
A product description page has been loaded. Payload: the id of the product.
</td></tr>
<tr><td>
[ResultURLTrackingEnabled](./x-components.taggingxevents.resulturltrackingenabled.md)
</td><td>
</td><td>
string
</td><td>
StorageKey has been configured to use the [result](./x-types.result.md) url. Payload: The new storageKey.
</td></tr>
<tr><td>
[SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md)
</td><td>
</td><td>
TaggingRequest
</td><td>
Query tagging info has changed. Payload: The new query tagging info.
</td></tr>
<tr><td>
[TaggingConfigProvided](./x-components.taggingxevents.taggingconfigprovided.md)
</td><td>
</td><td>
[TaggingConfig](./x-components.taggingconfig.md)
</td><td>
The configuration for the tagging has been provided. Payload: The tagging configuration.
</td></tr>
<tr><td>
[TrackableElementDisplayed](./x-components.taggingxevents.trackableelementdisplayed.md)
</td><td>
</td><td>
Taggable
</td><td>
Display trackable element has appeared in the viewport. Payload: The display tagging info.
</td></tr>
<tr><td>
[UserClickedPDPAddToCart](./x-components.taggingxevents.userclickedpdpaddtocart.md)
</td><td>
</td><td>
string \| undefined
</td><td>
The user has clicked on the add to cart button from PDP. Payload: The id of the [result](./x-types.result.md) that the user clicked.
</td></tr>
</tbody></table>