@empathyco/x-components 6.0.0-alpha.3 → 6.0.0-alpha.30

package/docs/API-reference/api/x-components.recommendations.md

@@ -11,7 +11,7 @@ It renders a list of recommendations from the [RecommendationsState.recommendati
 ```typescript
 _default: import("vue").DefineComponent<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
     maxItemsToRender: NumberConstructor;
@@ -19,11 +19,11 @@ _default: import("vue").DefineComponent<{
     recommendations: ComputedRef<Result[]>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
     maxItemsToRender: NumberConstructor;
 }>>, {
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
 }, {}>
 ```

package/docs/API-reference/api/x-components.recommendationsmutations.md

@@ -11,7 +11,7 @@ Recommendations store mutations.
 ```typescript
 export interface RecommendationsMutations extends StatusMutations, ConfigMutations<RecommendationsState> 
 ```
-**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, ConfigMutations&lt;[RecommendationsState](./x-components.recommendationsstate.md)<!-- -->&gt;
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[RecommendationsState](./x-components.recommendationsstate.md)<!-- -->&gt;
 
 ## Methods
 

package/docs/API-reference/api/x-components.relatedprompt.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPrompt](./x-components.relatedprompt.md)
+
+## RelatedPrompt variable
+
+This component shows a suggested related prompt.
+
+It provides a slot to customize the related prompt button information.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    relatedPrompt: {
+        type: PropType<RelatedPrompt>;
+        required: true;
+    };
+    isPromptVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isSelected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    index: {
+        type: NumberConstructor;
+        required: true;
+    };
+}, {
+    toggleSuggestion: (index: number) => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    relatedPrompt: {
+        type: PropType<RelatedPrompt>;
+        required: true;
+    };
+    isPromptVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isSelected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    index: {
+        type: NumberConstructor;
+        required: true;
+    };
+}>>, {
+    isPromptVisible: boolean;
+    isSelected: boolean;
+}, {}>
+```

package/docs/API-reference/api/x-components.relatedpromptrequest.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [relatedPromptRequest](./x-components.relatedpromptrequest.md)
+
+## relatedPromptRequest variable
+
+Default implementation for the [RelatedPromptsGetters.request](./x-components.relatedpromptsgetters.request.md) getter.
+
+**Signature:**
+
+```typescript
+request: RelatedPromptsXStoreModule['getters']['request']
+```

package/docs/API-reference/api/x-components.relatedpromptsactioncontext.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActionContext](./x-components.relatedpromptsactioncontext.md)
+
+## RelatedPromptsActionContext type
+
+Alias type for actions context of the [RelatedPromptsXStoreModule](./x-components.relatedpromptsxstoremodule.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export type RelatedPromptsActionContext = XActionContext<RelatedPromptsState, RelatedPromptsGetters, RelatedPromptsMutations, RelatedPromptsActions>;
+```
+**References:** [XActionContext](./x-components.xactioncontext.md)<!-- -->, [RelatedPromptsState](./x-components.relatedpromptsstate.md)<!-- -->, [RelatedPromptsGetters](./x-components.relatedpromptsgetters.md)<!-- -->, [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md)<!-- -->, [RelatedPromptsActions](./x-components.relatedpromptsactions.md)
+

package/docs/API-reference/api/x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActions](./x-components.relatedpromptsactions.md) &gt; [cancelFetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md)
+
+## RelatedPromptsActions.cancelFetchAndSaveRelatedPrompts() method
+
+Cancels / interrupt [RelatedPromptsActions.fetchAndSaveRelatedPrompts()](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) synchronous promise.
+
+**Signature:**
+
+```typescript
+cancelFetchAndSaveRelatedPrompts(): void;
+```
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsactions.fetchandsaverelatedprompts.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActions](./x-components.relatedpromptsactions.md) &gt; [fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md)
+
+## RelatedPromptsActions.fetchAndSaveRelatedPrompts() method
+
+Requests a new set of related prompts and stores them in the module.
+
+**Signature:**
+
+```typescript
+fetchAndSaveRelatedPrompts(request: RelatedPromptsRequest | null): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | RelatedPromptsRequest \| null | The related prompts request. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsactions.fetchrelatedprompts.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActions](./x-components.relatedpromptsactions.md) &gt; [fetchRelatedPrompts](./x-components.relatedpromptsactions.fetchrelatedprompts.md)
+
+## RelatedPromptsActions.fetchRelatedPrompts() method
+
+Requests a new set of related prompts for the module query, and returns them.
+
+**Signature:**
+
+```typescript
+fetchRelatedPrompts(request: RelatedPromptsRequest | null): RelatedPrompt[] | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | RelatedPromptsRequest \| null | The related prompts request. |
+
+**Returns:**
+
+RelatedPrompt\[\] \| null
+

package/docs/API-reference/api/x-components.relatedpromptsactions.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActions](./x-components.relatedpromptsactions.md)
+
+## RelatedPromptsActions interface
+
+Related prompts module actions.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsActions 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [cancelFetchAndSaveRelatedPrompts()](./x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md) | Cancels / interrupt [RelatedPromptsActions.fetchAndSaveRelatedPrompts()](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) synchronous promise. |
+|  [fetchAndSaveRelatedPrompts(request)](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) | Requests a new set of related prompts and stores them in the module. |
+|  [fetchRelatedPrompts(request)](./x-components.relatedpromptsactions.fetchrelatedprompts.md) | Requests a new set of related prompts for the module query, and returns them. |
+

package/docs/API-reference/api/x-components.relatedpromptsgetters.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsGetters](./x-components.relatedpromptsgetters.md)
+
+## RelatedPromptsGetters interface
+
+Related prompts module getters.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsGetters 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [request](./x-components.relatedpromptsgetters.request.md) |  | RelatedPromptsRequest \| null | Request object to retrieve the related prompts using the search adapter, or null if there is no valid data to conform a valid request. |
+

package/docs/API-reference/api/x-components.relatedpromptsgetters.request.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsGetters](./x-components.relatedpromptsgetters.md) &gt; [request](./x-components.relatedpromptsgetters.request.md)
+
+## RelatedPromptsGetters.request property
+
+Request object to retrieve the related prompts using the search adapter, or null if there is no valid data to conform a valid request.
+
+**Signature:**
+
+```typescript
+request: RelatedPromptsRequest | null;
+```

package/docs/API-reference/api/x-components.relatedpromptslist.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsList](./x-components.relatedpromptslist.md)
+
+## RelatedPromptsList variable
+
+Component that inserts groups of related prompts in different positions of the injected search items list, based on the provided configuration.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    animation: {
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: string;
+    };
+    offset: {
+        type: NumberConstructor;
+        default: number;
+    };
+    frequency: {
+        type: NumberConstructor;
+        default: number;
+    };
+    maxRelatedPromptsPerGroup: {
+        type: NumberConstructor;
+        default: number;
+    };
+    maxGroups: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    showOnlyAfterOffset: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    animation: {
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: string;
+    };
+    offset: {
+        type: NumberConstructor;
+        default: number;
+    };
+    frequency: {
+        type: NumberConstructor;
+        default: number;
+    };
+    maxRelatedPromptsPerGroup: {
+        type: NumberConstructor;
+        default: number;
+    };
+    maxGroups: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    showOnlyAfterOffset: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    animation: string | Function | Record<string, any>;
+    offset: number;
+    frequency: number;
+    maxRelatedPromptsPerGroup: number;
+    maxGroups: number;
+    showOnlyAfterOffset: boolean;
+}, {}>
+```

package/docs/API-reference/api/x-components.relatedpromptsmutations.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md)
+
+## RelatedPromptsMutations interface
+
+Related prompts module mutations.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsMutations extends StatusMutations, QueryMutations 
+```
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [resetRelatedPromptsState()](./x-components.relatedpromptsmutations.resetrelatedpromptsstate.md) | Resets the related prompts state. |
+|  [resetSelectedPrompt()](./x-components.relatedpromptsmutations.resetselectedprompt.md) | Resets the selected related prompt number. |
+|  [setParams(params)](./x-components.relatedpromptsmutations.setparams.md) | Sets the extra params of the module. |
+|  [setRelatedPromptsProducts(products)](./x-components.relatedpromptsmutations.setrelatedpromptsproducts.md) | Sets the related prompts of the module. |
+|  [setSelectedPrompt(index)](./x-components.relatedpromptsmutations.setselectedprompt.md) | Sets the selected related prompt. |
+|  [setSelectedQuery(index)](./x-components.relatedpromptsmutations.setselectedquery.md) | Sets the selected next query. |
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.resetrelatedpromptsstate.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [resetRelatedPromptsState](./x-components.relatedpromptsmutations.resetrelatedpromptsstate.md)
+
+## RelatedPromptsMutations.resetRelatedPromptsState() method
+
+Resets the related prompts state.
+
+**Signature:**
+
+```typescript
+resetRelatedPromptsState(): void;
+```
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.resetselectedprompt.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [resetSelectedPrompt](./x-components.relatedpromptsmutations.resetselectedprompt.md)
+
+## RelatedPromptsMutations.resetSelectedPrompt() method
+
+Resets the selected related prompt number.
+
+**Signature:**
+
+```typescript
+resetSelectedPrompt(): void;
+```
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.setparams.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setParams](./x-components.relatedpromptsmutations.setparams.md)
+
+## RelatedPromptsMutations.setParams() method
+
+Sets the extra params of the module.
+
+**Signature:**
+
+```typescript
+setParams(params: Dictionary<unknown>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | Dictionary&lt;unknown&gt; | The new extra params. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.setrelatedpromptsproducts.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setRelatedPromptsProducts](./x-components.relatedpromptsmutations.setrelatedpromptsproducts.md)
+
+## RelatedPromptsMutations.setRelatedPromptsProducts() method
+
+Sets the related prompts of the module.
+
+**Signature:**
+
+```typescript
+setRelatedPromptsProducts(products: RelatedPrompt[]): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  products | RelatedPrompt\[\] | The new related prompts to save to the state. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedprompt.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setSelectedPrompt](./x-components.relatedpromptsmutations.setselectedprompt.md)
+
+## RelatedPromptsMutations.setSelectedPrompt() method
+
+Sets the selected related prompt.
+
+**Signature:**
+
+```typescript
+setSelectedPrompt(index: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  index | number | The new selected related prompt. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedquery.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setSelectedQuery](./x-components.relatedpromptsmutations.setselectedquery.md)
+
+## RelatedPromptsMutations.setSelectedQuery() method
+
+Sets the selected next query.
+
+**Signature:**
+
+```typescript
+setSelectedQuery(index: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  index | number | The new selected next query. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.relatedpromptsstate.md

@@ -0,0 +1,24 @@
+<!-- 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
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [params](./x-components.relatedpromptsstate.params.md) |  | Dictionary&lt;unknown&gt; | The extra params property of the state. |
+|  [relatedPrompts](./x-components.relatedpromptsstate.relatedprompts.md) |  | RelatedPrompt\[\] | The list of the related-prompts, related to the <code>query</code> property of the state. |
+|  [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md) |  | number | The index of the selected related-prompt. |
+|  [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md) |  | number | The index of the selected next query. |
+

package/docs/API-reference/api/x-components.relatedpromptsstate.params.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [params](./x-components.relatedpromptsstate.params.md)
+
+## RelatedPromptsState.params property
+
+The extra params property of the state.
+
+**Signature:**
+
+```typescript
+params: Dictionary<unknown>;
+```

package/docs/API-reference/api/x-components.relatedpromptsstate.relatedprompts.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [relatedPrompts](./x-components.relatedpromptsstate.relatedprompts.md)
+
+## RelatedPromptsState.relatedPrompts property
+
+The list of the related-prompts, related to the `query` property of the state.
+
+**Signature:**
+
+```typescript
+relatedPrompts: RelatedPrompt[];
+```

package/docs/API-reference/api/x-components.relatedpromptsstate.selectedprompt.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md)
+
+## RelatedPromptsState.selectedPrompt property
+
+The index of the selected related-prompt.
+
+**Signature:**
+
+```typescript
+selectedPrompt: number;
+```

package/docs/API-reference/api/x-components.relatedpromptsstate.selectedquery.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md)
+
+## RelatedPromptsState.selectedQuery property
+
+The index of the selected next query.
+
+**Signature:**
+
+```typescript
+selectedQuery: number;
+```

package/docs/API-reference/api/x-components.relatedpromptstaglist.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsTagList](./x-components.relatedpromptstaglist.md)
+
+## RelatedPromptsTagList variable
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    buttonClass: StringConstructor;
+}, {
+    arePromptsVisible: import("vue").Ref<boolean>;
+    hidePrompt: (index: number) => boolean;
+    isSelected: (index: number) => boolean;
+    relatedPrompts: import("vue").ComputedRef<any>;
+    selectedPrompt: import("vue").ComputedRef<any>;
+    slidingPanelContent: import("vue").Ref<Element | undefined>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    buttonClass: StringConstructor;
+}>>, {}, {}>
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.md

@@ -0,0 +1,22 @@
+<!-- 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. |
+|  [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. |
+

package/docs/API-reference/api/x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md)
+
+## RelatedPromptsXEvents.RelatedPromptsRequestUpdated property
+
+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.
+
+**Signature:**
+
+```typescript
+RelatedPromptsRequestUpdated: RelatedPromptsRequest | null;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedprompt.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md)
+
+## RelatedPromptsXEvents.UserSelectedARelatedPrompt property
+
+The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection.
+
+**Signature:**
+
+```typescript
+UserSelectedARelatedPrompt: number;
+```