@empathyco/x-components/docs/API-reference/api/x-components.relatedpromptsstate.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsState](./x-components.relatedpromptsstate.md)

## RelatedPromptsState interface

Related prompts module state.

**Signature:**

```typescript
export interface RelatedPromptsState extends StatusState, QueryState 
```
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[params](./x-components.relatedpromptsstate.params.md)


</td><td>


</td><td>

Dictionary&lt;unknown&gt;


</td><td>

The extra params property of the state.


</td></tr>
<tr><td>

[relatedPrompts](./x-components.relatedpromptsstate.relatedprompts.md)


</td><td>


</td><td>

RelatedPrompt\[\]


</td><td>

The list of the related-prompts, related to the `query` property of the state.


</td></tr>
<tr><td>

[relatedTags](./x-components.relatedpromptsstate.relatedtags.md)


</td><td>


</td><td>

RelatedTag\[\]


</td><td>

The list of the related tags, related to the `query` property of the state.


</td></tr>
<tr><td>

[selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md)


</td><td>


</td><td>

number


</td><td>

The index of the selected related-prompt.


</td></tr>
<tr><td>

[selectedQuery](./x-components.relatedpromptsstate.selectedquery.md)


</td><td>


</td><td>

number


</td><td>

The index of the selected next query.


</td></tr>
</tbody></table>