<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [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

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md) |  | RelatedPromptsRequest \| null | Any property of the related-prompts request has changed Payload: The new related-prompts request or <code>null</code> if there is not enough data in the state to conform a valid request. |
|  [SelectedRelatedPromptChanged](./x-components.relatedpromptsxevents.selectedrelatedpromptchanged.md) |  | number | Selected Related Prompt has been changed. Payload: Selected Related Prompt index. -1 is deselected. |
|  [UserClickedARelatedPromptAdd2Cart](./x-components.relatedpromptsxevents.userclickedarelatedpromptadd2cart.md) |  | Result | The user has clicked one add to cart from a prompt. Payload: The result that the user clicked. |
|  [UserClickedARelatedPromptResult](./x-components.relatedpromptsxevents.userclickedarelatedpromptresult.md) |  | Result | The user has clicked one prompt. Payload: The result that the user clicked. |
|  [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md) |  | number | The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection. |
|  [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md) |  | number | 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. |

