@empathyco/x-components
Version:
Empathy X Components
211 lines (91 loc) • 3.33 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)
## RelatedPromptsXEvents interface
Dictionary of the events of RelatedPrompts 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 RelatedPromptsXEvents
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md)
</td><td>
</td><td>
RelatedPromptsRequest \| null
</td><td>
Any property of the related-prompts request has changed Payload: The new related-prompts request or `null` if there is not enough data in the state to conform a valid request.
</td></tr>
<tr><td>
[RelatedPromptsResponseChanged](./x-components.relatedpromptsxevents.relatedpromptsresponsechanged.md)
</td><td>
</td><td>
RelatedPrompt\[\]
</td><td>
The response list of related prompts has changed. Payload: The new related-prompts list.
</td></tr>
<tr><td>
[RelatedPromptsUnmounted](./x-components.relatedpromptsxevents.relatedpromptsunmounted.md)
</td><td>
</td><td>
void
</td><td>
The related prompts has been unmounted.
</td></tr>
<tr><td>
[ReloadRelatedPromptsRequested](./x-components.relatedpromptsxevents.reloadrelatedpromptsrequested.md)
</td><td>
</td><td>
void
</td><td>
Reload the current related prompts that have been requested.
</td></tr>
<tr><td>
[SelectedRelatedPromptChanged](./x-components.relatedpromptsxevents.selectedrelatedpromptchanged.md)
</td><td>
</td><td>
number
</td><td>
Selected Related Prompt has been changed. Payload: Selected Related Prompt index. -1 is deselected.
</td></tr>
<tr><td>
[UserClickedARelatedPromptAdd2Cart](./x-components.relatedpromptsxevents.userclickedarelatedpromptadd2cart.md)
</td><td>
</td><td>
Result
</td><td>
The user has clicked one add to cart from a prompt. Payload: The result that the user clicked.
</td></tr>
<tr><td>
[UserClickedARelatedPromptResult](./x-components.relatedpromptsxevents.userclickedarelatedpromptresult.md)
</td><td>
</td><td>
Result
</td><td>
The user has clicked one prompt. Payload: The result that the user clicked.
</td></tr>
<tr><td>
[UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md)
</td><td>
</td><td>
number
</td><td>
The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection.
</td></tr>
<tr><td>
[UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md)
</td><td>
</td><td>
number
</td><td>
The selected next query of the selected prompt has changed. Payload: The index of the next query in the NextQueries list or -1 to remove selection.
</td></tr>
</tbody></table>