@empathyco/x-components 3.0.0-alpha.28 → 3.0.0-alpha.31

package/docs/API-reference/api/x-components.defaultsessionservice.storageservice.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; [DefaultSessionService](./x-components.defaultsessionservice.md) &gt; [storageService](./x-components.defaultsessionservice.storageservice.md)
+
+## DefaultSessionService.storageService property
+
+<b>Signature:</b>
+
+```typescript
+protected storageService: StorageService;
+```

package/docs/API-reference/api/x-components.defaultsessionservice.ttlms.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; [DefaultSessionService](./x-components.defaultsessionservice.md) &gt; [ttlMs](./x-components.defaultsessionservice.ttlms.md)
+
+## DefaultSessionService.ttlMs property
+
+<b>Signature:</b>
+
+```typescript
+protected ttlMs: number;
+```

package/docs/API-reference/api/x-components.featurelocation.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; [FeatureLocation](./x-components.featurelocation.md)
+
+## FeatureLocation type
+
+Indicates where the feature is placed.
+
+<b>Signature:</b>
+
+```typescript
+export declare type FeatureLocation = 'external' | 'no_query' | 'no_results' | 'predictive_layer' | 'results' | 'pdp' | 'url_history' | 'url_history_pdp';
+```
+
+## Example 1
+
+A `next_query` [QueryFeature](./x-components.queryfeature.md) may be located in the `predictive_layer`<!-- -->, or in the `results` grid.
+
+## Example 2
+
+A `recommendations` [ResultFeature](./x-components.resultfeature.md) may be located in `no_results`<!-- -->, `no_query`<!-- -->, or `predictive_layer`<!-- -->.
+

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

@@ -19,4 +19,5 @@ export default class IdentifierResults extends Vue
 |  --- | --- | --- | --- |
 |  [animation](./x-components.identifierresults.animation.md) |  | Vue | Animation component that will be used to animate the identifier results. |
 |  [identifierResults](./x-components.identifierresults.identifierresults.md) |  | Result\[\] | The module's list of identifier results. |
+|  [resultClickExtraEvents](./x-components.identifierresults.resultclickextraevents.md) |  | [PropsWithType](./x-components.propswithtype.md)<!-- -->&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, Result&gt;\[\] | The additional events to be emitted by the mandatory [BaseResultLink](./x-components.baseresultlink.md) component. |
 

package/docs/API-reference/api/x-components.identifierresults.resultclickextraevents.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; [IdentifierResults](./x-components.identifierresults.md) &gt; [resultClickExtraEvents](./x-components.identifierresults.resultclickextraevents.md)
+
+## IdentifierResults.resultClickExtraEvents property
+
+The additional events to be emitted by the mandatory [BaseResultLink](./x-components.baseresultlink.md) component.
+
+<b>Signature:</b>
+
+```typescript
+protected resultClickExtraEvents: PropsWithType<XEventsTypes, Result>[];
+```

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

@@ -19,6 +19,6 @@ export interface IdentifierResultsActions
 |  [cancelFetchAndSaveIdentifierResults()](./x-components.identifierresultsactions.cancelfetchandsaveidentifierresults.md) | Cancels / interrupt [IdentifierResultsActions.fetchAndSaveIdentifierResults()](./x-components.identifierresultsactions.fetchandsaveidentifierresults.md) synchronous promise. |
 |  [fetchAndSaveIdentifierResults(request)](./x-components.identifierresultsactions.fetchandsaveidentifierresults.md) | Requests a new set of identifier results and stores them in the module. |
 |  [fetchIdentifierResults(request)](./x-components.identifierresultsactions.fetchidentifierresults.md) | Requests a new set of identifier results for the module query, and returns them. |
+|  [saveOrigin(originInit)](./x-components.identifierresultsactions.saveorigin.md) | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
 |  [saveQuery(query)](./x-components.identifierresultsactions.savequery.md) | Stores the query in the module if it matches the regex. |
-|  [setUrlParams(urlParams)](./x-components.identifierresultsactions.seturlparams.md) | Checks if the url has a query on it and then updates the state with that value. |
 

package/docs/API-reference/api/x-components.identifierresultsactions.saveorigin.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; [IdentifierResultsActions](./x-components.identifierresultsactions.md) &gt; [saveOrigin](./x-components.identifierresultsactions.saveorigin.md)
+
+## IdentifierResultsActions.saveOrigin() method
+
+Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
+
+<b>Signature:</b>
+
+```typescript
+saveOrigin(originInit: QueryOriginInit): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  originInit | [QueryOriginInit](./x-components.queryorigininit.md) | The object to create the origin with. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -18,5 +18,7 @@ export interface IdentifierResultsMutations extends StatusMutations
 |  Method | Description |
 |  --- | --- |
 |  [setIdentifierResults(identifierResults)](./x-components.identifierresultsmutations.setidentifierresults.md) | Sets the identifier results of the module. |
+|  [setOrigin(origin)](./x-components.identifierresultsmutations.setorigin.md) | Sets the origin of the module. |
+|  [setParams(params)](./x-components.identifierresultsmutations.setparams.md) | Sets the extra params of the module. |
 |  [setQuery(newQuery)](./x-components.identifierresultsmutations.setquery.md) | Sets the query of the module, which is used to retrieve the identifier-results. |
 

package/docs/API-reference/api/x-components.identifierresultsmutations.setorigin.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; [IdentifierResultsMutations](./x-components.identifierresultsmutations.md) &gt; [setOrigin](./x-components.identifierresultsmutations.setorigin.md)
+
+## IdentifierResultsMutations.setOrigin() method
+
+Sets the origin of the module.
+
+<b>Signature:</b>
+
+```typescript
+setOrigin(origin: QueryOrigin | undefined | null): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  origin | [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null | The new origin. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.identifierresultsmutations.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; [IdentifierResultsMutations](./x-components.identifierresultsmutations.md) &gt; [setParams](./x-components.identifierresultsmutations.setparams.md)
+
+## IdentifierResultsMutations.setParams() method
+
+Sets the extra params of the module.
+
+<b>Signature:</b>
+
+```typescript
+setParams(params: Dictionary<unknown>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | [Dictionary](./x-components.dictionary.md)<!-- -->&lt;unknown&gt; | The new extra params. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -19,5 +19,7 @@ export interface IdentifierResultsState extends StatusState
 |  --- | --- | --- |
 |  [config](./x-components.identifierresultsstate.config.md) | [IdentifierResultsConfig](./x-components.identifierresultsconfig.md) | The configuration of the identifier results module. |
 |  [identifierResults](./x-components.identifierresultsstate.identifierresults.md) | Result\[\] | The list of the identifier results, related to the <code>query</code> property of the state. |
+|  [origin](./x-components.identifierresultsstate.origin.md) | [QueryOrigin](./x-components.queryorigin.md) \| null | The origin property of the request. |
+|  [params](./x-components.identifierresultsstate.params.md) | [Dictionary](./x-components.dictionary.md)<!-- -->&lt;unknown&gt; | The extra params property of the state. |
 |  [query](./x-components.identifierresultsstate.query.md) | string | The internal query of the module. Used to request the identifier results. |
 

package/docs/API-reference/api/x-components.identifierresultsstate.origin.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; [IdentifierResultsState](./x-components.identifierresultsstate.md) &gt; [origin](./x-components.identifierresultsstate.origin.md)
+
+## IdentifierResultsState.origin property
+
+The origin property of the request.
+
+<b>Signature:</b>
+
+```typescript
+origin: QueryOrigin | null;
+```

package/docs/API-reference/api/x-components.identifierresultsstate.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; [IdentifierResultsState](./x-components.identifierresultsstate.md) &gt; [params](./x-components.identifierresultsstate.params.md)
+
+## IdentifierResultsState.params property
+
+The extra params property of the state.
+
+<b>Signature:</b>
+
+```typescript
+params: Dictionary<unknown>;
+```

package/docs/API-reference/api/x-components.locationprovider.location.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; [LocationProvider](./x-components.locationprovider.md) &gt; [location](./x-components.locationprovider.location.md)
+
+## LocationProvider.location property
+
+The [FeatureLocation](./x-components.featurelocation.md) to provide.
+
+<b>Signature:</b>
+
+```typescript
+protected location: FeatureLocation;
+```

package/docs/API-reference/api/x-components.locationprovider.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; [LocationProvider](./x-components.locationprovider.md)
+
+## LocationProvider class
+
+Location Provider component. This component injects the location with value passed as prop.
+
+<b>Signature:</b>
+
+```typescript
+export default class LocationProvider extends NoElement 
+```
+<b>Extends:</b> NoElement
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [location](./x-components.locationprovider.location.md) |  | [FeatureLocation](./x-components.featurelocation.md) | The [FeatureLocation](./x-components.featurelocation.md) to provide. |
+

package/docs/API-reference/api/x-components.mainscroll.margin.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; [MainScroll](./x-components.mainscroll.md) &gt; [margin](./x-components.mainscroll.margin.md)
+
+## MainScroll.margin property
+
+Adjusts the size of the scroll container bounds.
+
+<b>Signature:</b>
+
+```typescript
+margin: string;
+```

package/docs/API-reference/api/x-components.mainscroll.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; [MainScroll](./x-components.mainscroll.md)
+
+## MainScroll class
+
+Extends the scroll making it able to sync the first visible element, and allowing the children position to be restored.
+
+Each child element that wants to have this support must be wrapped in a [MainScrollItem](./x-components.mainscrollitem.md) component.
+
+<b>Signature:</b>
+
+```typescript
+export default class MainScroll extends NoElement 
+```
+<b>Extends:</b> NoElement
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [margin](./x-components.mainscroll.margin.md) |  | string | Adjusts the size of the scroll container bounds. |
+|  [restoreScrollTimeoutMs](./x-components.mainscroll.restorescrolltimeoutms.md) |  | number | Timeout in milliseconds to abort trying to restore the scroll position to the target element. |
+|  [threshold](./x-components.mainscroll.threshold.md) |  | number | Intersection percentage to consider an element visible. |
+|  [useWindow](./x-components.mainscroll.usewindow.md) |  | boolean | If <code>true</code>, sets this scroll instance to the main of the application. Being the main scroll implies that features like restoring the scroll when the query changes, or storing the scroll position in the URL will be enabled for this container. |
+|  [visibleElementsObserver](./x-components.mainscroll.visibleelementsobserver.md) |  | [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md) \| null | Creates an <code>IntersectionObserver</code> to detect the first visible elements. Children of this component should register themselves if they want to be observed. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [mounted()](./x-components.mainscroll.mounted.md) |  | Initialise the observer after mounting the component. |
+

package/docs/API-reference/api/{x-components.basemainscroll.mounted.md → x-components.mainscroll.mounted.md}

@@ -1,8 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseMainScroll](./x-components.basemainscroll.md) &gt; [mounted](./x-components.basemainscroll.mounted.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [MainScroll](./x-components.mainscroll.md) &gt; [mounted](./x-components.mainscroll.mounted.md)
 
-## BaseMainScroll.mounted() method
+## MainScroll.mounted() method
+
+Initialise the observer after mounting the component.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.mainscroll.restorescrolltimeoutms.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; [MainScroll](./x-components.mainscroll.md) &gt; [restoreScrollTimeoutMs](./x-components.mainscroll.restorescrolltimeoutms.md)
+
+## MainScroll.restoreScrollTimeoutMs property
+
+Timeout in milliseconds to abort trying to restore the scroll position to the target element.
+
+<b>Signature:</b>
+
+```typescript
+restoreScrollTimeoutMs: number;
+```

package/docs/API-reference/api/x-components.mainscroll.threshold.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; [MainScroll](./x-components.mainscroll.md) &gt; [threshold](./x-components.mainscroll.threshold.md)
+
+## MainScroll.threshold property
+
+Intersection percentage to consider an element visible.
+
+<b>Signature:</b>
+
+```typescript
+threshold: number;
+```

package/docs/API-reference/api/x-components.mainscroll.usewindow.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; [MainScroll](./x-components.mainscroll.md) &gt; [useWindow](./x-components.mainscroll.usewindow.md)
+
+## MainScroll.useWindow property
+
+If `true`<!-- -->, sets this scroll instance to the main of the application. Being the main scroll implies that features like restoring the scroll when the query changes, or storing the scroll position in the URL will be enabled for this container.
+
+<b>Signature:</b>
+
+```typescript
+useWindow: boolean;
+```

package/docs/API-reference/api/x-components.mainscroll.visibleelementsobserver.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; [MainScroll](./x-components.mainscroll.md) &gt; [visibleElementsObserver](./x-components.mainscroll.visibleelementsobserver.md)
+
+## MainScroll.visibleElementsObserver property
+
+Creates an `IntersectionObserver` to detect the first visible elements. Children of this component should register themselves if they want to be observed.
+
+<b>Signature:</b>
+
+```typescript
+get visibleElementsObserver(): ScrollVisibilityObserver | null;
+```

package/docs/API-reference/api/x-components.mainscrollitem._el.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; [MainScrollItem](./x-components.mainscrollitem.md) &gt; [$el](./x-components.mainscrollitem._el.md)
+
+## MainScrollItem.$el property
+
+Rendered HTML node.
+
+<b>Signature:</b>
+
+```typescript
+$el: HTMLElement;
+```

package/docs/API-reference/api/x-components.mainscrollitem.item.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; [MainScrollItem](./x-components.mainscrollitem.md) &gt; [item](./x-components.mainscrollitem.item.md)
+
+## MainScrollItem.item property
+
+The item data. Used to set the scroll identifier.
+
+<b>Signature:</b>
+
+```typescript
+item: Identifiable;
+```

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

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [MainScrollItem](./x-components.mainscrollitem.md)
+
+## MainScrollItem class
+
+Wrapper for elements contained in the [MainScroll](./x-components.mainscroll.md) that should store/restore its position.
+
+<b>Signature:</b>
+
+```typescript
+export default class MainScrollItem extends Vue 
+```
+<b>Extends:</b> Vue
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [$el](./x-components.mainscrollitem._el.md) |  | HTMLElement | Rendered HTML node. |
+|  [item](./x-components.mainscrollitem.item.md) |  | Identifiable | The item data. Used to set the scroll identifier. |
+|  [tag](./x-components.mainscrollitem.tag.md) |  | string \| typeof Vue | The tag to render. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [observeItem(newObserver, oldObserver)](./x-components.mainscrollitem.observeitem.md) |  | Initialises the element visibility observation, stopping the previous one if it has. |
+

package/docs/API-reference/api/x-components.mainscrollitem.observeitem.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [MainScrollItem](./x-components.mainscrollitem.md) &gt; [observeItem](./x-components.mainscrollitem.observeitem.md)
+
+## MainScrollItem.observeItem() method
+
+Initialises the element visibility observation, stopping the previous one if it has.
+
+<b>Signature:</b>
+
+```typescript
+observeItem(newObserver: ScrollVisibilityObserver | null, oldObserver: ScrollVisibilityObserver | null): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  newObserver | [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md) \| null | The new observer for the HTML element. |
+|  oldObserver | [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md) \| null | The old observer for the HTML element. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.mainscrollitem.tag.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; [MainScrollItem](./x-components.mainscrollitem.md) &gt; [tag](./x-components.mainscrollitem.tag.md)
+
+## MainScrollItem.tag property
+
+The tag to render.
+
+<b>Signature:</b>
+
+```typescript
+tag: string | typeof Vue;
+```