@empathyco/x-components 6.0.0-alpha.6 → 6.0.0-alpha.61

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

@@ -0,0 +1,80 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [PageSelector](./x-components.pageselector.md)
+
+## PageSelector variable
+
+Component that renders a pagination control with buttons for navigating between pages. It displays the current page, allows selecting other pages, and emits events when a page is selected.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    buttonClasses: {
+        type: PropType<(string | Dictionary<boolean>)[]>;
+        default: () => never[];
+    };
+    currentPage: {
+        type: NumberConstructor;
+        required: true;
+    };
+    hiddenPage: {
+        type: StringConstructor;
+        default: string;
+    };
+    itemClasses: {
+        type: PropType<(isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[]>;
+        default: () => never[];
+    };
+    range: {
+        type: NumberConstructor;
+        default: number;
+    };
+    scrollTarget: {
+        type: StringConstructor;
+        default: string;
+    };
+    totalPages: {
+        type: NumberConstructor;
+        required: true;
+    };
+}, {
+    visiblePages: import("vue").ComputedRef<PageItem[]>;
+    selectPage: (page: number | string) => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    buttonClasses: {
+        type: PropType<(string | Dictionary<boolean>)[]>;
+        default: () => never[];
+    };
+    currentPage: {
+        type: NumberConstructor;
+        required: true;
+    };
+    hiddenPage: {
+        type: StringConstructor;
+        default: string;
+    };
+    itemClasses: {
+        type: PropType<(isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[]>;
+        default: () => never[];
+    };
+    range: {
+        type: NumberConstructor;
+        default: number;
+    };
+    scrollTarget: {
+        type: StringConstructor;
+        default: string;
+    };
+    totalPages: {
+        type: NumberConstructor;
+        required: true;
+    };
+}>>, {
+    buttonClasses: (string | Dictionary<boolean>)[];
+    hiddenPage: string;
+    itemClasses: (isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[];
+    range: number;
+    scrollTarget: string;
+}, {}>
+```

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

@@ -11,7 +11,7 @@ It renders a list of partial results from [SearchState.partialResults](./x-compo
 ```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: {
@@ -22,7 +22,7 @@ _default: import("vue").DefineComponent<{
     partialResults: ComputedRef<PartialResult[]>;
 }, 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: {
@@ -30,7 +30,7 @@ _default: import("vue").DefineComponent<{
         default: number;
     };
 }>>, {
-    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>;
     maxItemsToRender: number;
 }, {}>
 ```

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

@@ -11,7 +11,7 @@ Popular searches module mutations.
 ```typescript
 export interface PopularSearchesMutations extends StatusMutations, ConfigMutations<PopularSearchesState> 
 ```
-**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, ConfigMutations&lt;[PopularSearchesState](./x-components.popularsearchesstate.md)<!-- -->&gt;
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[PopularSearchesState](./x-components.popularsearchesstate.md)<!-- -->&gt;
 
 ## Methods
 

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

@@ -15,17 +15,17 @@ It also provides the parent slots to customize the items.
 ```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;
     };
 }, () => 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: 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;
     };
 }>>, {
-    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.queriespreviewmutations.md

@@ -11,7 +11,7 @@ QueriesPreview store mutations.
 ```typescript
 export interface QueriesPreviewMutations extends ConfigMutations<QueriesPreviewState> 
 ```
-**Extends:** ConfigMutations&lt;[QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->&gt;
+**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->&gt;
 
 ## Methods
 

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

@@ -9,5 +9,5 @@ The name of the tool that generated the query.
 **Signature:**
 
 ```typescript
-export type QueryFeature = 'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics';
+export type QueryFeature = 'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics' | 'related_prompts';
 ```

package/docs/API-reference/api/x-components.querymutations.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; [QueryMutations](./x-components.querymutations.md)
+
+## QueryMutations interface
+
+The [QueryState](./x-components.querystate.md) mutations.
+
+**Signature:**
+
+```typescript
+export interface QueryMutations 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [setQuery(query)](./x-components.querymutations.setquery.md) | Sets the query. |
+

package/docs/API-reference/api/x-components.querymutations.setquery.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; [QueryMutations](./x-components.querymutations.md) &gt; [setQuery](./x-components.querymutations.setquery.md)
+
+## QueryMutations.setQuery() method
+
+Sets the query.
+
+**Signature:**
+
+```typescript
+setQuery(query: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  query | string | The new query. |
+
+**Returns:**
+
+void
+

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

@@ -26,7 +26,7 @@ _default: import("vue").DefineComponent<{
     };
     persistInCache: BooleanConstructor;
     animation: {
-        type: 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;
     };
 }, {
@@ -50,12 +50,12 @@ _default: import("vue").DefineComponent<{
     };
     persistInCache: BooleanConstructor;
     animation: {
-        type: 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;
     };
 }>>, {
     debounceTimeMs: number;
     persistInCache: boolean;
-    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.querystate.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; [QueryState](./x-components.querystate.md)
+
+## QueryState interface
+
+Query state type, containing a property to hold the current query of the module.
+
+**Signature:**
+
+```typescript
+export interface QueryState 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [query](./x-components.querystate.query.md) |  | string | The query of the module. Different modules may have queries that differ in value or time. |
+

package/docs/API-reference/api/x-components.querystate.query.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; [QueryState](./x-components.querystate.md) &gt; [query](./x-components.querystate.query.md)
+
+## QueryState.query property
+
+The query of the module. Different modules may have queries that differ in value or time.
+
+**Signature:**
+
+```typescript
+query: string;
+```

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

@@ -11,7 +11,7 @@ QuerySuggestions store mutations.
 ```typescript
 export interface QuerySuggestionsMutations extends StatusMutations, QueryMutations, ConfigMutations<QuerySuggestionsState> 
 ```
-**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations, ConfigMutations&lt;[QuerySuggestionsState](./x-components.querysuggestionsstate.md)<!-- -->&gt;
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[QuerySuggestionsState](./x-components.querysuggestionsstate.md)<!-- -->&gt;
 
 ## Methods
 

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

@@ -11,7 +11,7 @@ QuerySuggestions store state.
 ```typescript
 export interface QuerySuggestionsState extends StatusState, QueryState 
 ```
-**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
+**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
 
 ## Properties
 

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,33 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    relatedPrompt: {
+        type: PropType<RelatedPrompt>;
+        required: true;
+    };
+    selected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    relatedPrompt: {
+        type: PropType<RelatedPrompt>;
+        required: true;
+    };
+    selected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    selected: boolean;
+}, {}>
+```

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,23 @@
+<!-- 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. |
+|  [setUrlParams(urlParams)](./x-components.relatedpromptsactions.seturlparams.md) | Checks if the URL has params on it and then updates the state with these values. |
+

package/docs/API-reference/api/x-components.relatedpromptsactions.seturlparams.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; [setUrlParams](./x-components.relatedpromptsactions.seturlparams.md)
+
+## RelatedPromptsActions.setUrlParams() method
+
+Checks if the URL has params on it and then updates the state with these values.
+
+**Signature:**
+
+```typescript
+setUrlParams(urlParams: UrlParams): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  urlParams | [UrlParams](./x-components.urlparams.md) | List of params from the url. |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,21 @@
+<!-- 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 |
+|  --- | --- | --- | --- |
+|  [query](./x-components.relatedpromptsgetters.query.md) |  | string | The combination of the query and the selected related tags. |
+|  [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.query.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; [query](./x-components.relatedpromptsgetters.query.md)
+
+## RelatedPromptsGetters.query property
+
+The combination of the query and the selected related tags.
+
+**Signature:**
+
+```typescript
+query: string;
+```

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,27 @@
+<!-- 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. |
+|  [setRelatedPromptsRelatedTags(relatedTags)](./x-components.relatedpromptsmutations.setrelatedpromptsrelatedtags.md) | Sets the related tags 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. |
+