@empathyco/x-components 6.0.0-alpha.5 → 6.0.0-alpha.50

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,73 @@
+<!-- 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
+
+This component shows the list of `RelatedPrompts` components.
+
+If the default slot is reimplemented in the consumer, `onSelect` function will be necessary to handle the selection of the related prompt and to trigger the stagger-fade-slide animation.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<{
+    buttonClass: StringConstructor;
+    showButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    scrollContainerClass: StringConstructor;
+    tagClass: StringConstructor;
+    tagColors: PropType<string[]>;
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, {
+    isSelected: (index: number) => boolean;
+    onSelect: (selectedIndex: number) => void;
+    onBeforeEnter: (el: Element) => void;
+    onEnter: (el: Element, done: () => void) => void;
+    onLeave: (el: Element, done: () => void) => void;
+    selectedPromptIndex: import("vue").ComputedRef<any>;
+    visibleRelatedPrompts: import("vue").ComputedRef<{
+        index: number;
+        relatedPromptNextQueries?: import("@empathyco/x-types").RelatedPromptNextQuery[] | undefined;
+        nextQueries: string[];
+        suggestionText: string;
+        type: string;
+        toolingDisplayTagging?: import("@empathyco/x-types").TaggingRequest | undefined;
+        tagging?: {
+            toolingDisplayTagging?: import("@empathyco/x-types").TaggingRequest | undefined;
+            toolingDisplayClickTagging?: import("@empathyco/x-types").TaggingRequest | undefined;
+            nextQueriesTagging?: import("@empathyco/x-types").RelatedPromptNextQuery[] | undefined;
+        } | undefined;
+        modelName: "RelatedPrompt";
+    }[]>;
+    listItems: import("vue").Ref<HTMLElement[]>;
+    isAnimating: import("vue").Ref<boolean>;
+    x: import("../../../composables").UseAliasAPI & {
+        on: <Event_1 extends keyof import("../../..").XEventsTypes, Metadata extends boolean>(event: Event_1, withMetadata: Metadata) => {
+            subscribe: (callback: (payload: Metadata extends true ? import("@empathyco/x-bus").SubjectPayload<import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>, import("../../..").WireMetadata> : import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>) => void) => void;
+        };
+        emit: <Event_2 extends keyof import("../../..").XEventsTypes>(event: Event_2, payload?: import("../../..").XEventPayload<Event_2> | undefined, metadata?: Omit<import("../../..").WireMetadata, "moduleName">) => Promise<import("@empathyco/x-bus").EmittedData<import("../../..").XEventsTypes, Event_2, import("../../..").WireMetadata>>;
+    };
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    buttonClass: StringConstructor;
+    showButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    scrollContainerClass: StringConstructor;
+    tagClass: StringConstructor;
+    tagColors: PropType<string[]>;
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>>, {
+    showButtons: boolean;
+    animationDurationInMs: number;
+}, {}>
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.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; [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. |
+|  [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. |
+

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.userclickedarelatedpromptadd2cart.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; [UserClickedARelatedPromptAdd2Cart](./x-components.relatedpromptsxevents.userclickedarelatedpromptadd2cart.md)
+
+## RelatedPromptsXEvents.UserClickedARelatedPromptAdd2Cart property
+
+The user has clicked one add to cart from a prompt. Payload: The result that the user clicked.
+
+**Signature:**
+
+```typescript
+UserClickedARelatedPromptAdd2Cart: Result;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userclickedarelatedpromptresult.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; [UserClickedARelatedPromptResult](./x-components.relatedpromptsxevents.userclickedarelatedpromptresult.md)
+
+## RelatedPromptsXEvents.UserClickedARelatedPromptResult property
+
+The user has clicked one prompt. Payload: The result that the user clicked.
+
+**Signature:**
+
+```typescript
+UserClickedARelatedPromptResult: Result;
+```

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;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedpromptquery.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; [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md)
+
+## RelatedPromptsXEvents.UserSelectedARelatedPromptQuery property
+
+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.
+
+**Signature:**
+
+```typescript
+UserSelectedARelatedPromptQuery: number;
+```

package/docs/API-reference/api/x-components.relatedpromptsxmodule.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; [relatedPromptsXModule](./x-components.relatedpromptsxmodule.md)
+
+## relatedPromptsXModule variable
+
+Related Prompts [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `related-prompts` entry point.
+
+**Signature:**
+
+```typescript
+relatedPromptsXModule: RelatedPromptsXModule
+```

package/docs/API-reference/api/x-components.relatedpromptsxstoremodule.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; [RelatedPromptsXStoreModule](./x-components.relatedpromptsxstoremodule.md)
+
+## RelatedPromptsXStoreModule type
+
+Related prompts store module.
+
+**Signature:**
+
+```typescript
+export type RelatedPromptsXStoreModule = XStoreModule<RelatedPromptsState, RelatedPromptsGetters, RelatedPromptsMutations, RelatedPromptsActions>;
+```
+**References:** [XStoreModule](./x-components.xstoremodule.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.relatedtags.md

@@ -11,7 +11,7 @@ This component renders a set of \[`RelatedTag`<!-- -->\](./x-components.related-
 ```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;
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
     relatedTags: ComputedRef<RelatedTagModel[]>;
 }, 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;
@@ -34,7 +34,7 @@ _default: import("vue").DefineComponent<{
     };
     itemClass: StringConstructor;
 }>>, {
-    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>;
     highlightCurated: boolean;
 }, {}>
 ```

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

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

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

@@ -11,7 +11,7 @@ RelatedTags store state.
 ```typescript
 export interface RelatedTagsState 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.resultslist.md

@@ -15,19 +15,19 @@ It also provides the slot result to customize the item, which is within the defa
 ```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, "UserReachedResultsListEnd"[], "UserReachedResultsListEnd", 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;
     };
 }>> & {
     onUserReachedResultsListEnd?: ((...args: any[]) => any) | undefined;
 }, {
-    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.scrolltotop.md

@@ -11,8 +11,8 @@ The `ScrollToTop` component is a button that the user can click to make a contai
 ```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<{}>>, {}, {}>>;
-        default: () => 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: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     thresholdPx: NumberConstructor;
     scrollId: {
@@ -24,8 +24,8 @@ _default: import("vue").DefineComponent<{
     isVisible: import("vue").ComputedRef<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<{}>>, {}, {}>>;
-        default: () => 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: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     thresholdPx: NumberConstructor;
     scrollId: {
@@ -33,7 +33,7 @@ _default: import("vue").DefineComponent<{
         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>;
     scrollId: string;
 }, {}>
 ```

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

@@ -11,7 +11,7 @@ SearchBox store mutations.
 ```typescript
 export interface SearchBoxMutations extends QueryMutations 
 ```
-**Extends:** QueryMutations
+**Extends:** [QueryMutations](./x-components.querymutations.md)
 
 ## Methods
 

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

@@ -11,7 +11,7 @@ SearchBox store state.
 ```typescript
 export interface SearchBoxState extends QueryState 
 ```
-**Extends:** QueryState
+**Extends:** [QueryState](./x-components.querystate.md)
 
 ## Properties
 

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

@@ -16,5 +16,6 @@ export interface SearchConfig
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [pageMode](./x-components.searchconfig.pagemode.md) |  | PageMode |  |
 |  [pageSize](./x-components.searchconfig.pagesize.md) |  | number | Maximum number of results to request. |
 

package/docs/API-reference/api/x-components.searchconfig.pagemode.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchConfig](./x-components.searchconfig.md) &gt; [pageMode](./x-components.searchconfig.pagemode.md)
+
+## SearchConfig.pageMode property
+
+**Signature:**
+
+```typescript
+pageMode: PageMode;
+```

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

@@ -15,7 +15,7 @@ _default: import("vue").DefineComponent<{
         required: true;
     };
     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: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     animationIntervalMs: {
@@ -32,7 +32,7 @@ _default: import("vue").DefineComponent<{
         required: true;
     };
     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: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     animationIntervalMs: {
@@ -41,7 +41,7 @@ _default: import("vue").DefineComponent<{
     };
     animateOnlyOnHover: BooleanConstructor;
 }>>, {
-    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>;
     animationIntervalMs: number;
     animateOnlyOnHover: boolean;
 }, {}>

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

@@ -11,7 +11,7 @@ Search store mutations.
 ```typescript
 export interface SearchMutations extends StatusMutations, QueryMutations, ConfigMutations<SearchState> 
 ```
-**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations, ConfigMutations&lt;[SearchState](./x-components.searchstate.md)<!-- -->&gt;
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[SearchState](./x-components.searchstate.md)<!-- -->&gt;
 
 ## Methods
 
@@ -38,6 +38,7 @@ export interface SearchMutations extends StatusMutations, QueryMutations, Config
 |  [setSelectedFilters(selectedFilters)](./x-components.searchmutations.setselectedfilters.md) | Sets the selected filters of the module. |
 |  [setSort(sort)](./x-components.searchmutations.setsort.md) | Sets the selected sort option of the module. |
 |  [setSpellcheck(spellcheckedQuery)](./x-components.searchmutations.setspellcheck.md) | Sets the spellcheckedQuery of the module. |
+|  [setStats(stats)](./x-components.searchmutations.setstats.md) | Sets the stats of the module. |
 |  [setTotalResults(totalResults)](./x-components.searchmutations.settotalresults.md) | Sets the total results of the module. |
 |  [updateResult(result)](./x-components.searchmutations.updateresult.md) | Updates a result with new fields. |
 

package/docs/API-reference/api/x-components.searchmutations.setstats.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; [SearchMutations](./x-components.searchmutations.md) &gt; [setStats](./x-components.searchmutations.setstats.md)
+
+## SearchMutations.setStats() method
+
+Sets the stats of the module.
+
+**Signature:**
+
+```typescript
+setStats(stats: Stats): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stats | Stats | The new stats to save to the state. |
+
+**Returns:**
+
+void
+

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

@@ -11,7 +11,7 @@ Search store state.
 ```typescript
 export interface SearchState extends StatusState, QueryState 
 ```
-**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
+**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
 
 ## Properties
 
@@ -36,5 +36,6 @@ export interface SearchState extends StatusState, QueryState
 |  [selectedFilters](./x-components.searchstate.selectedfilters.md) |  | Dictionary&lt;Filter\[\]&gt; | The dictionary of selected filters, used to perform the search request. The key is the facet id, and the value the list of filters for that facet. |
 |  [sort](./x-components.searchstate.sort.md) |  | Sort | The way of ordering the results. |
 |  [spellcheckedQuery](./x-components.searchstate.spellcheckedquery.md) |  | string | The spellcheckedQuery property of the state. |
+|  [stats](./x-components.searchstate.stats.md) |  | Stats | The stats of the results. |
 |  [totalResults](./x-components.searchstate.totalresults.md) |  | number | The total number of results, related to the <code>query</code> property of the state. |
 

package/docs/API-reference/api/x-components.searchstate.stats.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; [SearchState](./x-components.searchstate.md) &gt; [stats](./x-components.searchstate.stats.md)
+
+## SearchState.stats property
+
+The stats of the results.
+
+**Signature:**
+
+```typescript
+stats: Stats;
+```

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

@@ -34,4 +34,5 @@ export interface SearchXEvents
 |  [UserClickedASort](./x-components.searchxevents.userclickedasort.md) |  | Sort | The user has clicked one of the sorts. Payload: The sort option that the user has selected. |
 |  [UserClickedPartialQuery](./x-components.searchxevents.userclickedpartialquery.md) |  | string | Partial query has been set. Payload: The new query string. |
 |  [UserReachedResultsListEnd](./x-components.searchxevents.userreachedresultslistend.md) |  | void | The user reached the limit of the scrollable content in a results list. |
+|  [UserSelectedAPage](./x-components.searchxevents.userselectedapage.md) |  | number | The user has selected a page. |
 

package/docs/API-reference/api/x-components.searchxevents.userselectedapage.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; [SearchXEvents](./x-components.searchxevents.md) &gt; [UserSelectedAPage](./x-components.searchxevents.userselectedapage.md)
+
+## SearchXEvents.UserSelectedAPage property
+
+The user has selected a page.
+
+**Signature:**
+
+```typescript
+UserSelectedAPage: number;
+```

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

@@ -17,7 +17,7 @@ _default: import("vue").DefineComponent<{
     facetsIds: PropType<(string | number)[]>;
     alwaysVisible: 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;
     };
 }, {
@@ -28,11 +28,11 @@ _default: import("vue").DefineComponent<{
     facetsIds: PropType<(string | number)[]>;
     alwaysVisible: 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;
     };
 }>>, {
     alwaysVisible: 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.semanticqueriesmutations.md

@@ -11,7 +11,7 @@ SemanticQueries store mutations.
 ```typescript
 export interface SemanticQueriesMutations extends QueryMutations, ConfigMutations<SemanticQueriesState> 
 ```
-**Extends:** QueryMutations, ConfigMutations&lt;[SemanticQueriesState](./x-components.semanticqueriesstate.md)<!-- -->&gt;
+**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[SemanticQueriesState](./x-components.semanticqueriesstate.md)<!-- -->&gt;
 
 ## Methods
 

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

@@ -11,7 +11,7 @@ SemanticQueries store state.
 ```typescript
 export interface SemanticQueriesState extends QueryState 
 ```
-**Extends:** QueryState
+**Extends:** [QueryState](./x-components.querystate.md)
 
 ## Properties