@empathyco/x-components 3.0.0-alpha.36 → 3.0.0-alpha.40

package/docs/API-reference/api/x-components.searchactions.resetstate.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; [SearchActions](./x-components.searchactions.md) &gt; [resetState](./x-components.searchactions.resetstate.md)
+
+## SearchActions.resetState() method
+
+Batches state resets in a single action after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update.
+
+<b>Signature:</b>
+
+```typescript
+resetState(watchedRequest: WatchedInternalSearchRequest): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  watchedRequest | [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) | The watched internal search request object. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -16,5 +16,5 @@ export interface SearchGetters
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [request](./x-components.searchgetters.request.md) | SearchRequest \| null | The adapter request object for retrieving the results, or null if there is not valid data to create a request. |
+|  [request](./x-components.searchgetters.request.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) \| null | The adapter request object for retrieving the results, or null if there is not valid data to create a request. |
 

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

@@ -9,5 +9,5 @@ The adapter request object for retrieving the results, or null if there is not v
 <b>Signature:</b>
 
 ```typescript
-request: SearchRequest | null;
+request: InternalSearchRequest | null;
 ```

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

@@ -19,7 +19,8 @@ export interface SearchXEvents
 |  [FacetsChanged](./x-components.searchxevents.facetschanged.md) | Facet\[\] | The facets have changed. \* Payload: The [facets](./x-types.facet.md) array. |
 |  [PageChanged](./x-components.searchxevents.pagechanged.md) | number | Page has been changed. \* Payload: The new page number. |
 |  [ResultsChanged](./x-components.searchxevents.resultschanged.md) | Result\[\] | Results have been changed. \* Payload: The new [results](./x-types.result.md)<!-- -->. |
-|  [SearchRequestChanged](./x-components.searchxevents.searchrequestchanged.md) | SearchRequest \| null | Any property of the search request has changed. \* Payload: The new search request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [SearchRequestChanged](./x-components.searchxevents.searchrequestchanged.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) \| null | Any property of the search request has changed. \* Payload: The new search request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [SearchRequestUpdated](./x-components.searchxevents.searchrequestupdated.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) | Any property of the search request has been updated. \* Payload: The new internal request object. |
 |  [SearchTaggingChanged](./x-components.searchxevents.searchtaggingchanged.md) | TaggingInfo | Query tagging has been changed. \* Payload: The new query tagging object. |
 |  [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) | Sort | A new selected sort has been provided. \* Payload: The sort option that has been provided. |
 |  [SortChanged](./x-components.searchxevents.sortchanged.md) | string | Sort has been changed. \* Payload: The new sort string. |

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

@@ -9,5 +9,5 @@ Any property of the search request has changed. \* Payload: The new search reque
 <b>Signature:</b>
 
 ```typescript
-SearchRequestChanged: SearchRequest | null;
+SearchRequestChanged: InternalSearchRequest | null;
 ```

package/docs/API-reference/api/x-components.searchxevents.searchrequestupdated.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; [SearchRequestUpdated](./x-components.searchxevents.searchrequestupdated.md)
+
+## SearchXEvents.SearchRequestUpdated property
+
+Any property of the search request has been updated. \* Payload: The new internal request object.
+
+<b>Signature:</b>
+
+```typescript
+SearchRequestUpdated: InternalSearchRequest;
+```

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

@@ -9,5 +9,5 @@ Sets the search state `pageSize`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setPageSize: import("../..").Wire<number>
+setPageSize: import("../../wiring/wiring.types").Wire<number>
 ```

package/docs/API-reference/api/x-components.setquerytagginginfo.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; [setQueryTaggingInfo](./x-components.setquerytagginginfo.md)
+
+## setQueryTaggingInfo variable
+
+Sets the tagging state of the query tagging info using a debounce which ends if the user accepts a query.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingInfo: Wire<TaggingInfo>
+```

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

@@ -9,5 +9,5 @@ Sets the search state `relatedTags`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setRelatedTags: import("../..").Wire<import("@empathyco/x-types").RelatedTag[]>
+setRelatedTags: import("../../wiring/wiring.types").Wire<import("@empathyco/x-types").RelatedTag[]>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `params`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchExtraParams: import("../..").Wire<import("../..").Dictionary<unknown>>
+setSearchExtraParams: import("../../wiring/wiring.types").Wire<import("../..").Dictionary<unknown>>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `page`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchPage: import("../..").Wire<number>
+setSearchPage: import("../../wiring/wiring.types").Wire<number>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `query`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchQuery: import("../..").Wire<string>
+setSearchQuery: import("../../wiring/wiring.types").Wire<string>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `selectedFilters`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSelectedFilters: import("../..").Wire<import("@empathyco/x-types").Filter[]>
+setSelectedFilters: import("../../wiring/wiring.types").Wire<import("@empathyco/x-types").Filter[]>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `sort`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSort: import("../..").Wire<string>
+setSort: import("../../wiring/wiring.types").Wire<string>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `query`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setUrlParams: import("../..").Wire<import("../..").UrlParams>
+setUrlParams: import("../../wiring/wiring.types").Wire<import("../..").UrlParams>
 ```

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

@@ -4,7 +4,7 @@
 
 ## SlidingPanel class
 
-Horizontal slide panel component. The content that is provided to this component would be navigable horizontally using two navigational buttons.
+This component allows for any other component or element inside it to be horizontally navigable. It also implements customizable buttons as well as other minor customizations to its general behavior.
 
 <b>Signature:</b>
 
@@ -17,17 +17,7 @@ export default class SlidingPanel extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [$refs](./x-components.slidingpanel._refs.md) |  | { scrollContainer: HTMLElement; } | HTMLElement referencing the scroll of the component. |
-|  [isScrollAtEnd](./x-components.slidingpanel.isscrollatend.md) |  | boolean | Indicates if the scroll is at the end of the sliding panel. |
-|  [isScrollAtStart](./x-components.slidingpanel.isscrollatstart.md) |  | boolean | Indicates if the scroll is at the start of the sliding panel. |
+|  [resetOnContentChange](./x-components.slidingpanel.resetoncontentchange.md) |  | boolean | When true, whenever the DOM content in the sliding panel slot changes, it will reset the scroll position to 0. |
 |  [scrollFactor](./x-components.slidingpanel.scrollfactor.md) |  | number | Scroll factor that will dictate how much the scroll moves when pressing a navigation button. |
-|  [scrollObserver](./x-components.slidingpanel.scrollobserver.md) |  | MutationObserver | MutationObserver that watches for changes inside the wrapping div to update the scroll position. |
 |  [showButtons](./x-components.slidingpanel.showbuttons.md) |  | boolean | Would make the navigation buttons visible when they're needed or always hide them. |
 
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [beforeDestroy()](./x-components.slidingpanel.beforedestroy.md) |  |  |
-|  [mounted()](./x-components.slidingpanel.mounted.md) |  |  |
-

package/docs/API-reference/api/x-components.slidingpanel.resetoncontentchange.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; [SlidingPanel](./x-components.slidingpanel.md) &gt; [resetOnContentChange](./x-components.slidingpanel.resetoncontentchange.md)
+
+## SlidingPanel.resetOnContentChange property
+
+When true, whenever the DOM content in the sliding panel slot changes, it will reset the scroll position to 0.
+
+<b>Signature:</b>
+
+```typescript
+resetOnContentChange: boolean;
+```

package/docs/API-reference/api/x-components.slidingpanel.scrollfactor.md

@@ -9,5 +9,5 @@ Scroll factor that will dictate how much the scroll moves when pressing a naviga
 <b>Signature:</b>
 
 ```typescript
-protected scrollFactor: number;
+scrollFactor: number;
 ```

package/docs/API-reference/api/x-components.slidingpanel.showbuttons.md

@@ -9,5 +9,5 @@ Would make the navigation buttons visible when they're needed or always hide the
 <b>Signature:</b>
 
 ```typescript
-protected showButtons: boolean;
+showButtons: boolean;
 ```

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

@@ -18,5 +18,6 @@ export interface TaggingMutations
 |  --- | --- |
 |  [setConsent(consent)](./x-components.taggingmutations.setconsent.md) | Sets the [TaggingState.consent](./x-components.taggingstate.consent.md) property. |
 |  [setQueryTaggingDebounce(queryTaggingDebounceMs)](./x-components.taggingmutations.setquerytaggingdebounce.md) | Sets the [TaggingConfig.queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md) property. |
+|  [setQueryTaggingInfo(queryTaggingInfo)](./x-components.taggingmutations.setquerytagginginfo.md) | Sets the [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) property. |
 |  [setSessionDuration(sessionTTLMs)](./x-components.taggingmutations.setsessionduration.md) | Sets the [TaggingConfig.sessionTTLMs](./x-components.taggingconfig.sessionttlms.md) property. |
 

package/docs/API-reference/api/x-components.taggingmutations.setquerytagginginfo.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; [TaggingMutations](./x-components.taggingmutations.md) &gt; [setQueryTaggingInfo](./x-components.taggingmutations.setquerytagginginfo.md)
+
+## TaggingMutations.setQueryTaggingInfo() method
+
+Sets the [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) property.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingInfo(queryTaggingInfo: TaggingInfo): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  queryTaggingInfo | TaggingInfo | The new [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md)<!-- -->. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -18,4 +18,5 @@ export interface TaggingState
 |  --- | --- | --- |
 |  [config](./x-components.taggingstate.config.md) | [TaggingConfig](./x-components.taggingconfig.md) | Configuration for the <code>Tagging</code> module. |
 |  [consent](./x-components.taggingstate.consent.md) | boolean \| null | The current consent for tracking. |
+|  [queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) | TaggingInfo \| null | Tagging info for last accepted query. |
 

package/docs/API-reference/api/x-components.taggingstate.querytagginginfo.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; [TaggingState](./x-components.taggingstate.md) &gt; [queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md)
+
+## TaggingState.queryTaggingInfo property
+
+Tagging info for last accepted query.
+
+<b>Signature:</b>
+
+```typescript
+queryTaggingInfo: TaggingInfo | null;
+```

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

@@ -19,5 +19,6 @@ export interface TaggingXEvents
 |  [ConsentChanged](./x-components.taggingxevents.consentchanged.md) | boolean | Consent has changed. \* Payload: The new consent value. |
 |  [ConsentProvided](./x-components.taggingxevents.consentprovided.md) | boolean | Consent has been provided. \* Payload: The new consent value. |
 |  [QueryTaggingDebounceProvided](./x-components.taggingxevents.querytaggingdebounceprovided.md) | number | Query tagging debounce has been provided. \* Payload: The new query tagging debounce value. |
+|  [SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md) | TaggingInfo | Query tagging info has changed. \* Payload: The new query tagging info. |
 |  [SessionDurationProvided](./x-components.taggingxevents.sessiondurationprovided.md) | number | Session duration has been provided. \* Payload: The new session duration value. |
 

package/docs/API-reference/api/x-components.taggingxevents.searchtaggingreceived.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; [TaggingXEvents](./x-components.taggingxevents.md) &gt; [SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md)
+
+## TaggingXEvents.SearchTaggingReceived property
+
+Query tagging info has changed. \* Payload: The new query tagging info.
+
+<b>Signature:</b>
+
+```typescript
+SearchTaggingReceived: TaggingInfo;
+```

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

@@ -4,10 +4,10 @@
 
 ## trackQueryWire variable
 
-Tracks the tagging of the query using a debounce which ends if the user accepts a query.
+Tracks the tagging of the query.
 
 <b>Signature:</b>
 
 ```typescript
-trackQueryWire: Wire<import("@empathyco/x-types").TaggingInfo | import("@empathyco/x-types").TaggingInfo[]>
+trackQueryWire: Wire<TaggingInfo | TaggingInfo[]>
 ```

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md)
+
+## WatchedInternalSearchRequest interface
+
+A representation of a watched [InternalSearchRequest](./x-components.internalsearchrequest.md) object, wrapping its new and old values.
+
+<b>Signature:</b>
+
+```typescript
+export interface WatchedInternalSearchRequest 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [newRequest](./x-components.watchedinternalsearchrequest.newrequest.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) |  |
+|  [oldRequest](./x-components.watchedinternalsearchrequest.oldrequest.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) |  |
+

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.newrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) &gt; [newRequest](./x-components.watchedinternalsearchrequest.newrequest.md)
+
+## WatchedInternalSearchRequest.newRequest property
+
+<b>Signature:</b>
+
+```typescript
+newRequest: InternalSearchRequest;
+```

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.oldrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) &gt; [oldRequest](./x-components.watchedinternalsearchrequest.oldrequest.md)
+
+## WatchedInternalSearchRequest.oldRequest property
+
+<b>Signature:</b>
+
+```typescript
+oldRequest: InternalSearchRequest;
+```

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

@@ -20,5 +20,6 @@ export interface WireMetadata
 |  [id?](./x-components.wiremetadata.id.md) | string | <i>(Optional)</i> The id of the component origin. |
 |  [location?](./x-components.wiremetadata.location.md) | [FeatureLocation](./x-components.featurelocation.md) | <i>(Optional)</i> The [FeatureLocation](./x-components.featurelocation.md) from where the event has been emitted. |
 |  [moduleName](./x-components.wiremetadata.modulename.md) | [XModuleName](./x-components.xmodulename.md) \| null | The [XModule](./x-components.xmodule.md) name that emitted the event or <code>null</code> if it has been emitted from an unknown module. |
+|  [oldValue?](./x-components.wiremetadata.oldvalue.md) | unknown | <i>(Optional)</i> The old value of a watched selector triggering an emitter. |
 |  [target?](./x-components.wiremetadata.target.md) | HTMLElement | <i>(Optional)</i> The DOM element that triggered the event emission. |
 

package/docs/API-reference/api/x-components.wiremetadata.oldvalue.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; [WireMetadata](./x-components.wiremetadata.md) &gt; [oldValue](./x-components.wiremetadata.oldvalue.md)
+
+## WireMetadata.oldValue property
+
+The old value of a watched selector triggering an emitter.
+
+<b>Signature:</b>
+
+```typescript
+oldValue?: unknown;
+```

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

@@ -32,6 +32,7 @@ export interface XComponentAliasAPI
 |  [relatedTags](./x-components.xcomponentaliasapi.relatedtags.md) | ReadonlyArray<RelatedTag> | The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) related tags (Both selected and deselected). |
 |  [selectedFilters](./x-components.xcomponentaliasapi.selectedfilters.md) | Filter\[\] | The [FacetsXModule](./x-components.facetsxmodule.md) selected filters. |
 |  [selectedRelatedTags](./x-components.xcomponentaliasapi.selectedrelatedtags.md) | ReadonlyArray<RelatedTag> | The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) selected related tags. |
+|  [selectedSort](./x-components.xcomponentaliasapi.selectedsort.md) | string | The [SearchXModule](./x-components.searchxmodule.md) selected sort. |
 |  [spellcheckedQuery](./x-components.xcomponentaliasapi.spellcheckedquery.md) | string \| null | The [SearchXModule](./x-components.searchxmodule.md) spellchecked query. |
 |  [status](./x-components.xcomponentaliasapi.status.md) | [XComponentAliasStatusAPI](./x-components.xcomponentaliasstatusapi.md) | The status value of the different modules. |
 |  [totalResults](./x-components.xcomponentaliasapi.totalresults.md) | number | The [SearchXModule](./x-components.searchxmodule.md) total results. |

package/docs/API-reference/api/x-components.xcomponentaliasapi.selectedsort.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; [XComponentAliasAPI](./x-components.xcomponentaliasapi.md) &gt; [selectedSort](./x-components.xcomponentaliasapi.selectedsort.md)
+
+## XComponentAliasAPI.selectedSort property
+
+The [SearchXModule](./x-components.searchxmodule.md) selected sort.
+
+<b>Signature:</b>
+
+```typescript
+readonly selectedSort: string;
+```

package/docs/API-reference/api/x-types.nextquery.iscurated.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [NextQuery](./x-types.nextquery.md) &gt; [isCurated](./x-types.nextquery.iscurated.md)
+
+## NextQuery.isCurated property
+
+If it's a curated next query.
+
+<b>Signature:</b>
+
+```typescript
+isCurated?: boolean;
+```

package/docs/API-reference/api/x-types.nextquery.md

@@ -13,3 +13,9 @@ export interface NextQuery extends NamedModel<'NextQuery'>, Required<Previewable
 ```
 <b>Extends:</b> [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'NextQuery'&gt;, Required&lt;[Previewable](./x-types.previewable.md)<!-- -->&gt;
 
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [isCurated?](./x-types.nextquery.iscurated.md) | boolean | <i>(Optional)</i> If it's a curated next query. |
+

package/docs/API-reference/components/common/scroll/x-components.base-scroll.md

@@ -11,12 +11,13 @@ knowing when the user scrolls, the direction of scroll and if user reaches the s
 
 ## Props
 
-| Name                                 | Description                                                                                                                                                                                                                     | Type                 | Default           |
-| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------- |
-| <code>distanceToBottom</code>        | Distance to the end of the scroll that when reached will emit the<br />`scroll:about-to-end` event.                                                                                                                             | <code>number</code>  | <code>100</code>  |
-| <code>firstElementThresholdPx</code> | Positive vertical distance to still consider that the an element is the first one visible.<br />For example, if set to 100, after scrolling 100 pixels, the first rendered element<br />will still be considered the first one. | <code>number</code>  | <code>100</code>  |
-| <code>throttleMs</code>              | Time duration to ignore the subsequent scroll events after an emission.<br />Higher values will decrease events precision but can prevent performance issues.                                                                   | <code>number</code>  | <code>100</code>  |
-| <code>resetOnChange</code>           | If true (default), sets the scroll position to the top when certain events are emitted.                                                                                                                                         | <code>boolean</code> | <code>true</code> |
+| Name                                 | Description                                                                                                                                                                                                                     | Type                 | Default                                                                                                                                                                            |
+| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <code>distanceToBottom</code>        | Distance to the end of the scroll that when reached will emit the<br />`scroll:about-to-end` event.                                                                                                                             | <code>number</code>  | <code>100</code>                                                                                                                                                                   |
+| <code>firstElementThresholdPx</code> | Positive vertical distance to still consider that the an element is the first one visible.<br />For example, if set to 100, after scrolling 100 pixels, the first rendered element<br />will still be considered the first one. | <code>number</code>  | <code>100</code>                                                                                                                                                                   |
+| <code>throttleMs</code>              | Time duration to ignore the subsequent scroll events after an emission.<br />Higher values will decrease events precision but can prevent performance issues.                                                                   | <code>number</code>  | <code>100</code>                                                                                                                                                                   |
+| <code>resetOnChange</code>           | If true (default), sets the scroll position to the top when certain events are emitted.                                                                                                                                         | <code>boolean</code> | <code>true</code>                                                                                                                                                                  |
+| <code>resetOn</code>                 | List of events that should reset the scroll when emitted.                                                                                                                                                                       | <code>XEvent</code>  | <code>() => [<br /> 'SearchBoxQueryChanged',<br /> 'SortChanged',<br /> 'SelectedFiltersChanged',<br /> 'SelectedRelatedTagsChanged',<br /> 'UserChangedExtraParams'<br />]</code> |
 
 ## Events
 
@@ -36,10 +37,10 @@ knowing when the user scrolls, the direction of scroll and if user reaches the s
 
 ## Example
 
-The BaseScroll is a component that manage the states of scroll of a specified element. The component
-does the necessary calculations for knowing the direction of scroll, if the scroll has reached to
-start or to end, and is about to reaching to end. The components emits the next events depending of
-movement that realize the user:
+The `BaseScroll` is a component that manages the state of scroll of a specified element. The
+component does the necessary calculations for knowing the direction of scroll, if the scroll has
+reached to start or to end, and is about to reaching to end. The components emits the next events
+depending of movement that realize the user:
 
 ```vue
 <template>
@@ -49,8 +50,8 @@ movement that realize the user:
     @scroll:at-start="scrollAtStart"
     @scroll:almost-at-end="scrollAlmostAtEnd"
     @scroll:at-end="scrollAtEnd"
-    throttleMs="1000"
-    distanceToBottom="200"
+    :throttleMs="1000"
+    :distanceToBottom="200"
   >
     <template>
       <div class="content-scroll">
@@ -96,15 +97,7 @@ Set to false the reset scroll on query change feature which is true by default.
 
 ```vue
 <template>
-  <BaseScroll
-    @scroll="scroll"
-    @scroll:direction-change="scrollDirectionChange"
-    @scroll:at-start="scrollAtStart"
-    @scroll:almost-at-end="scrollAlmostAtEnd"
-    @scroll:at-end="scrollAtEnd"
-    throttleMs="1000"
-    distanceToBottom="200"
-  >
+  <BaseScroll @scroll="scroll" :resetOnChange="false">
     <template>
       <div class="content-scroll">
         <span>content1</span>
@@ -125,18 +118,44 @@ export default {
   methods: {
     scroll(position) {
       console.log("scroll", position);
-    },
-    scrollDirectionChange(direction) {
-      console.log("scroll:direction-change", direction);
-    },
-    scrollAtStart() {
-      console.log("scroll:at-start");
-    },
-    scrollAlmostAtEnd(distance) {
-      console.log("scroll:almost-at-end", distance);
-    },
-    scrollAtEnd() {
-      console.log("scroll:at-end");
+    }
+  }
+};
+</script>
+```
+
+### Reset scroll
+
+You can configure which events reset the scroll position using the `resetOn` prop.
+
+```vue
+<template>
+  <BaseScroll @scroll="scroll" :resetOn="resetScrollEvents">
+    <template>
+      <div class="content-scroll">
+        <span>content1</span>
+        <span>content1</span>
+      </div>
+    </template>
+  </BaseScroll>
+</template>
+
+<script>
+import { BaseScroll } from "@empathyco/x-components";
+
+export default {
+  name: "ScrollTest",
+  components: {
+    BaseScroll
+  },
+  data() {
+    return {
+      resetScrollEvents: ["UserAcceptedAQuery"]
+    };
+  },
+  methods: {
+    scroll(position) {
+      console.log("scroll", position);
     }
   }
 };