@empathyco/x-components 3.0.0-alpha.27 → 3.0.0-alpha.30

package/docs/API-reference/api/x-components.scrollmutations.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; [ScrollMutations](./x-components.scrollmutations.md)
+
+## ScrollMutations interface
+
+Scroll store mutations.
+
+<b>Signature:</b>
+
+```typescript
+export interface ScrollMutations 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [setPendingScrollTo(pendingScrollTo)](./x-components.scrollmutations.setpendingscrollto.md) | Sets the identifier of the element that is pending to be scrolled into the view. |
+|  [setScrollComponentState(partialState)](./x-components.scrollmutations.setscrollcomponentstate.md) | Sets the scroll position of a certain panel. |
+

package/docs/API-reference/api/x-components.scrollmutations.setpendingscrollto.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; [ScrollMutations](./x-components.scrollmutations.md) &gt; [setPendingScrollTo](./x-components.scrollmutations.setpendingscrollto.md)
+
+## ScrollMutations.setPendingScrollTo() method
+
+Sets the identifier of the element that is pending to be scrolled into the view.
+
+<b>Signature:</b>
+
+```typescript
+setPendingScrollTo(pendingScrollTo: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  pendingScrollTo | string | The identifier of the element that should be scrolled into view whenever it is loaded. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.scrollmutations.setscrollcomponentstate.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; [ScrollMutations](./x-components.scrollmutations.md) &gt; [setScrollComponentState](./x-components.scrollmutations.setscrollcomponentstate.md)
+
+## ScrollMutations.setScrollComponentState() method
+
+Sets the scroll position of a certain panel.
+
+<b>Signature:</b>
+
+```typescript
+setScrollComponentState(partialState: ScrollStatePayload): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  partialState | [ScrollStatePayload](./x-components.scrollstatepayload.md) | An object with the fields to modify. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.scrollstate.data.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; [ScrollState](./x-components.scrollstate.md) &gt; [data](./x-components.scrollstate.data.md)
+
+## ScrollState.data property
+
+State data of the scroll components.
+
+<b>Signature:</b>
+
+```typescript
+data: Dictionary<ScrollComponentState>;
+```

package/docs/API-reference/api/x-components.scrollstate.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; [ScrollState](./x-components.scrollstate.md)
+
+## ScrollState interface
+
+Scroll store state.
+
+<b>Signature:</b>
+
+```typescript
+export interface ScrollState 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [data](./x-components.scrollstate.data.md) | [Dictionary](./x-components.dictionary.md)<!-- -->&lt;[ScrollComponentState](./x-components.scrollcomponentstate.md)<!-- -->&gt; | State data of the scroll components. |
+|  [pendingScrollTo](./x-components.scrollstate.pendingscrollto.md) | string | The <code>[data-scroll]</code> value of the pending to restore scroll. |
+

package/docs/API-reference/api/x-components.scrollstate.pendingscrollto.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; [ScrollState](./x-components.scrollstate.md) &gt; [pendingScrollTo](./x-components.scrollstate.pendingscrollto.md)
+
+## ScrollState.pendingScrollTo property
+
+The `[data-scroll]` value of the pending to restore scroll.
+
+<b>Signature:</b>
+
+```typescript
+pendingScrollTo: string;
+```

package/docs/API-reference/api/x-components.scrollstatepayload.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; [ScrollStatePayload](./x-components.scrollstatepayload.md)
+
+## ScrollStatePayload interface
+
+Payload object containing the identifier of the scroll and its position.
+
+<b>Signature:</b>
+
+```typescript
+export interface ScrollStatePayload extends Identifiable<string> 
+```
+<b>Extends:</b> Identifiable&lt;string&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [newState](./x-components.scrollstatepayload.newstate.md) | Partial&lt;[ScrollComponentState](./x-components.scrollcomponentstate.md)<!-- -->&gt; | A partial [ScrollComponentState](./x-components.scrollcomponentstate.md) update to perform to the targeted panel. |
+

package/docs/API-reference/api/x-components.scrollstatepayload.newstate.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; [ScrollStatePayload](./x-components.scrollstatepayload.md) &gt; [newState](./x-components.scrollstatepayload.newstate.md)
+
+## ScrollStatePayload.newState property
+
+A partial [ScrollComponentState](./x-components.scrollcomponentstate.md) update to perform to the targeted panel.
+
+<b>Signature:</b>
+
+```typescript
+newState: Partial<ScrollComponentState>;
+```

package/docs/API-reference/api/{x-components.basescrolltotop.animation.md → x-components.scrolltotop.animation.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseScrollToTop](./x-components.basescrolltotop.md) &gt; [animation](./x-components.basescrolltotop.animation.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollToTop](./x-components.scrolltotop.md) &gt; [animation](./x-components.scrolltotop.animation.md)
 
-## BaseScrollToTop.animation property
+## ScrollToTop.animation property
 
 Animation to use for showing/hiding the button.
 

package/docs/API-reference/api/x-components.scrolltotop.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; [ScrollToTop](./x-components.scrolltotop.md)
+
+## ScrollToTop class
+
+The `ScrollToTop` component is a button that the user can click to make a container scroll up to its initial position.
+
+<b>Signature:</b>
+
+```typescript
+export default class ScrollToTop extends Vue 
+```
+<b>Extends:</b> Vue
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [animation](./x-components.scrolltotop.animation.md) |  | Vue \| string | Animation to use for showing/hiding the button. |
+|  [scrollId](./x-components.scrolltotop.scrollid.md) |  | string | Id of the target scroll component. |
+|  [thresholdPx?](./x-components.scrolltotop.thresholdpx.md) |  | number | <i>(Optional)</i> Threshold in pixels from the top to show the button. |
+

package/docs/API-reference/api/{x-components.basescrolltotop.scrollid.md → x-components.scrolltotop.scrollid.md}

@@ -1,13 +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; [BaseScrollToTop](./x-components.basescrolltotop.md) &gt; [scrollId](./x-components.basescrolltotop.scrollid.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollToTop](./x-components.scrolltotop.md) &gt; [scrollId](./x-components.scrolltotop.scrollid.md)
 
-## BaseScrollToTop.scrollId property
+## ScrollToTop.scrollId property
 
 Id of the target scroll component.
 
 <b>Signature:</b>
 
 ```typescript
-scrollId?: string;
+scrollId: string;
 ```

package/docs/API-reference/api/{x-components.basescrolltotop.thresholdpx.md → x-components.scrolltotop.thresholdpx.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseScrollToTop](./x-components.basescrolltotop.md) &gt; [thresholdPx](./x-components.basescrolltotop.thresholdpx.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollToTop](./x-components.scrolltotop.md) &gt; [thresholdPx](./x-components.scrolltotop.thresholdpx.md)
 
-## BaseScrollToTop.thresholdPx property
+## ScrollToTop.thresholdPx property
 
 Threshold in pixels from the top to show the button.
 

package/docs/API-reference/api/x-components.scrollvisibilityobserver.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; [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md)
+
+## ScrollVisibilityObserver interface
+
+Methods to initialise and cease visibility observing.
+
+<b>Signature:</b>
+
+```typescript
+export interface ScrollVisibilityObserver 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [observe(element)](./x-components.scrollvisibilityobserver.observe.md) | Starts observing the provided element. |
+|  [unobserve(element)](./x-components.scrollvisibilityobserver.unobserve.md) | Stops observing the provided element. |
+

package/docs/API-reference/api/x-components.scrollvisibilityobserver.observe.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; [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md) &gt; [observe](./x-components.scrollvisibilityobserver.observe.md)
+
+## ScrollVisibilityObserver.observe() method
+
+Starts observing the provided element.
+
+<b>Signature:</b>
+
+```typescript
+observe(element: HTMLElement): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  element | HTMLElement | The element to observe if it has entered in the view. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.scrollvisibilityobserver.unobserve.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; [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md) &gt; [unobserve](./x-components.scrollvisibilityobserver.unobserve.md)
+
+## ScrollVisibilityObserver.unobserve() method
+
+Stops observing the provided element.
+
+<b>Signature:</b>
+
+```typescript
+unobserve(element: HTMLElement): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  element | HTMLElement | The element to stop observing if it has entered in the view. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.scrollxevents.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; [ScrollXEvents](./x-components.scrollxevents.md)
+
+## ScrollXEvents interface
+
+Dictionary of the events of Scroll XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.
+
+<b>Signature:</b>
+
+```typescript
+export interface ScrollXEvents 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ScrollRestoreFailed](./x-components.scrollxevents.scrollrestorefailed.md) | void | The scroll position has failed to be restored. \* Payload: none. |
+|  [ScrollRestoreSucceeded](./x-components.scrollxevents.scrollrestoresucceeded.md) | void | The scroll position has been restored successfully. \* Payload: none. |
+|  [UserAlmostReachedScrollEnd](./x-components.scrollxevents.useralmostreachedscrollend.md) | boolean | The user has almost reached the scroll end. \* Payload: True if the user has almost reached the scroll end, false if it is no longer close to the end. |
+|  [UserChangedScrollDirection](./x-components.scrollxevents.userchangedscrolldirection.md) | [ScrollDirection](./x-components.scrolldirection.md) | The user has changed the direction of scroll. \* Payload: The new [ScrollDirection](./x-components.scrolldirection.md) when user changes scroll direction. |
+|  [UserReachedScrollEnd](./x-components.scrollxevents.userreachedscrollend.md) | boolean | The user has reached the scroll end. \* Payload: True if the user has reached the ending position of the scroll. False if he is no longer in that position. |
+|  [UserReachedScrollStart](./x-components.scrollxevents.userreachedscrollstart.md) | boolean | The user has reached the scroll start. \* Payload: True if the user has reached the starting position of the scroll. False if he is no longer in that position. |
+|  [UserScrolled](./x-components.scrollxevents.userscrolled.md) | number | The user has scrolled. \* Payload: The new position of scroll. |
+|  [UserScrolledToElement](./x-components.scrollxevents.userscrolledtoelement.md) | string | The user has scrolled to an element with the given id. \* Payload: The scroll identifier of the element. |
+

package/docs/API-reference/api/x-components.scrollxevents.scrollrestorefailed.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [ScrollRestoreFailed](./x-components.scrollxevents.scrollrestorefailed.md)
+
+## ScrollXEvents.ScrollRestoreFailed property
+
+The scroll position has failed to be restored. \* Payload: none.
+
+<b>Signature:</b>
+
+```typescript
+ScrollRestoreFailed: void;
+```

package/docs/API-reference/api/x-components.scrollxevents.scrollrestoresucceeded.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [ScrollRestoreSucceeded](./x-components.scrollxevents.scrollrestoresucceeded.md)
+
+## ScrollXEvents.ScrollRestoreSucceeded property
+
+The scroll position has been restored successfully. \* Payload: none.
+
+<b>Signature:</b>
+
+```typescript
+ScrollRestoreSucceeded: void;
+```

package/docs/API-reference/api/x-components.scrollxevents.useralmostreachedscrollend.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserAlmostReachedScrollEnd](./x-components.scrollxevents.useralmostreachedscrollend.md)
+
+## ScrollXEvents.UserAlmostReachedScrollEnd property
+
+The user has almost reached the scroll end. \* Payload: True if the user has almost reached the scroll end, false if it is no longer close to the end.
+
+<b>Signature:</b>
+
+```typescript
+UserAlmostReachedScrollEnd: boolean;
+```

package/docs/API-reference/api/{x-components.xeventstypes.userchangedscrolldirection.md → x-components.scrollxevents.userchangedscrolldirection.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XEventsTypes](./x-components.xeventstypes.md) &gt; [UserChangedScrollDirection](./x-components.xeventstypes.userchangedscrolldirection.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserChangedScrollDirection](./x-components.scrollxevents.userchangedscrolldirection.md)
 
-## XEventsTypes.UserChangedScrollDirection property
+## ScrollXEvents.UserChangedScrollDirection property
 
 The user has changed the direction of scroll. \* Payload: The new [ScrollDirection](./x-components.scrolldirection.md) when user changes scroll direction.
 

package/docs/API-reference/api/x-components.scrollxevents.userreachedscrollend.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserReachedScrollEnd](./x-components.scrollxevents.userreachedscrollend.md)
+
+## ScrollXEvents.UserReachedScrollEnd property
+
+The user has reached the scroll end. \* Payload: True if the user has reached the ending position of the scroll. False if he is no longer in that position.
+
+<b>Signature:</b>
+
+```typescript
+UserReachedScrollEnd: boolean;
+```

package/docs/API-reference/api/x-components.scrollxevents.userreachedscrollstart.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserReachedScrollStart](./x-components.scrollxevents.userreachedscrollstart.md)
+
+## ScrollXEvents.UserReachedScrollStart property
+
+The user has reached the scroll start. \* Payload: True if the user has reached the starting position of the scroll. False if he is no longer in that position.
+
+<b>Signature:</b>
+
+```typescript
+UserReachedScrollStart: boolean;
+```

package/docs/API-reference/api/{x-components.xeventstypes.userscrolled.md → x-components.scrollxevents.userscrolled.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XEventsTypes](./x-components.xeventstypes.md) &gt; [UserScrolled](./x-components.xeventstypes.userscrolled.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserScrolled](./x-components.scrollxevents.userscrolled.md)
 
-## XEventsTypes.UserScrolled property
+## ScrollXEvents.UserScrolled property
 
 The user has scrolled. \* Payload: The new position of scroll.
 

package/docs/API-reference/api/x-components.scrollxevents.userscrolledtoelement.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; [ScrollXEvents](./x-components.scrollxevents.md) &gt; [UserScrolledToElement](./x-components.scrollxevents.userscrolledtoelement.md)
+
+## ScrollXEvents.UserScrolledToElement property
+
+The user has scrolled to an element with the given id. \* Payload: The scroll identifier of the element.
+
+<b>Signature:</b>
+
+```typescript
+UserScrolledToElement: string;
+```

package/docs/API-reference/api/x-components.scrollxmodule.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; [scrollXModule](./x-components.scrollxmodule.md)
+
+## scrollXModule variable
+
+Scroll [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `empathize` entry point.
+
+<b>Signature:</b>
+
+```typescript
+scrollXModule: ScrollXModule
+```

package/docs/API-reference/api/x-components.scrollxstoremodule.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; [ScrollXStoreModule](./x-components.scrollxstoremodule.md)
+
+## ScrollXStoreModule type
+
+Scroll type safe store module.
+
+<b>Signature:</b>
+
+```typescript
+export declare type ScrollXStoreModule = XStoreModule<ScrollState, ScrollGetters, ScrollMutations, ScrollActions>;
+```
+<b>References:</b> [XStoreModule](./x-components.xstoremodule.md)<!-- -->, [ScrollState](./x-components.scrollstate.md)<!-- -->, [ScrollGetters](./x-components.scrollgetters.md)<!-- -->, [ScrollMutations](./x-components.scrollmutations.md)<!-- -->, [ScrollActions](./x-components.scrollactions.md)
+

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

@@ -20,5 +20,6 @@ export interface SearchActions
 |  [fetchAndSaveSearchResponse(request)](./x-components.searchactions.fetchandsavesearchresponse.md) | Fetches a new search response and stores them in the module state. |
 |  [fetchSearchResponse(request)](./x-components.searchactions.fetchsearchresponse.md) | Fetches the search response and returns them. |
 |  [increasePageAppendingResults()](./x-components.searchactions.increasepageappendingresults.md) | Checks if there are more pages of results to load. If there are, then increases the page number in state and set to <code>true</code> the [SearchState.isAppendResults](./x-components.searchstate.isappendresults.md) flag. |
+|  [saveOrigin(originInit)](./x-components.searchactions.saveorigin.md) | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
 |  [setUrlParams(urlParams)](./x-components.searchactions.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.searchactions.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; [SearchActions](./x-components.searchactions.md) &gt; [saveOrigin](./x-components.searchactions.saveorigin.md)
+
+## SearchActions.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.searchbutton.events.md → x-components.searchbutton.emitevents.md}

@@ -1,11 +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; [SearchButton](./x-components.searchbutton.md) &gt; [events](./x-components.searchbutton.events.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchButton](./x-components.searchbutton.md) &gt; [emitEvents](./x-components.searchbutton.emitevents.md)
 
-## SearchButton.events property
+## SearchButton.emitEvents() method
+
+Emits events when the button is clicked.
 
 <b>Signature:</b>
 
 ```typescript
-protected get events(): Partial<XEventsTypes>;
+protected emitEvents(): void;
 ```
+<b>Returns:</b>
+
+void
+

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

@@ -22,7 +22,12 @@ If query is not empty, it emits [XEventsTypes.UserAcceptedAQuery](./x-components
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [dynamicClasses](./x-components.searchbutton.dynamicclasses.md) |  | [VueCSSClasses](./x-components.vuecssclasses.md) |  |
-|  [events](./x-components.searchbutton.events.md) |  | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; |  |
 |  [isQueryEmpty](./x-components.searchbutton.isqueryempty.md) |  | boolean |  |
 |  [query](./x-components.searchbutton.query.md) |  | string |  |
 
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [emitEvents()](./x-components.searchbutton.emitevents.md) |  | Emits events when the button is clicked. |
+

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

@@ -28,6 +28,7 @@ export interface SearchMutations extends StatusMutations
 |  [setPartialResults(partialResults)](./x-components.searchmutations.setpartialresults.md) | Sets the partial results of the module. |
 |  [setPromoteds(promoteds)](./x-components.searchmutations.setpromoteds.md) | Sets the promoteds of the module. |
 |  [setQuery(newQuery)](./x-components.searchmutations.setquery.md) | Sets the query of the module, which is used to retrieve the results. |
+|  [setQueryTagging(queryTagging)](./x-components.searchmutations.setquerytagging.md) | Sets the query tagging of the module, which is used to track the query. |
 |  [setRedirections(redirections)](./x-components.searchmutations.setredirections.md) | Sets the redirection of the module. |
 |  [setRelatedTags(relatedTags)](./x-components.searchmutations.setrelatedtags.md) | Sets the related tags of the module. |
 |  [setResults(results)](./x-components.searchmutations.setresults.md) | Sets the results of the module. |

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

@@ -9,14 +9,14 @@ Sets the origin of the module.
 <b>Signature:</b>
 
 ```typescript
-setOrigin(origin: QueryOrigin | undefined): void;
+setOrigin(origin: QueryOrigin | undefined | null): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  origin | [QueryOrigin](./x-components.queryorigin.md) \| undefined | The new origin. |
+|  origin | [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null | The new origin. |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.searchmutations.setquerytagging.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; [setQueryTagging](./x-components.searchmutations.setquerytagging.md)
+
+## SearchMutations.setQueryTagging() method
+
+Sets the query tagging of the module, which is used to track the query.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTagging(queryTagging: TaggingInfo): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  queryTagging | TaggingInfo | The new query tagging object to save to the state. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -27,6 +27,7 @@ export interface SearchState extends StatusState
 |  [partialResults](./x-components.searchstate.partialresults.md) | PartialResult\[\] | The list of the partial results, related to the <code>query</code> property of the state. |
 |  [promoteds](./x-components.searchstate.promoteds.md) | Promoted\[\] | The list of the promoted, related to the <code>query</code> property of the state. |
 |  [query](./x-components.searchstate.query.md) | string | The internal query of the module. Used to request the search results. |
+|  [queryTagging](./x-components.searchstate.querytagging.md) | TaggingInfo | The query tagging used to track the search events. |
 |  [redirections](./x-components.searchstate.redirections.md) | Redirection\[\] | The redirections associated to the <code>query</code>. |
 |  [relatedTags](./x-components.searchstate.relatedtags.md) | RelatedTag\[\] | The list of the related tags, related to the <code>query</code> property of the state. |
 |  [results](./x-components.searchstate.results.md) | Result\[\] | The list of the results, related to the <code>query</code> property of the state. |

package/docs/API-reference/api/x-components.searchstate.querytagging.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; [queryTagging](./x-components.searchstate.querytagging.md)
+
+## SearchState.queryTagging property
+
+The query tagging used to track the search events.
+
+<b>Signature:</b>
+
+```typescript
+queryTagging: TaggingInfo;
+```

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

@@ -20,9 +20,12 @@ export interface SearchXEvents
 |  [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. |
+|  [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. |
 |  [SpellcheckChanged](./x-components.searchxevents.spellcheckchanged.md) | string | Spellcheck has been changed. \* Payload: The new spellcheckedQuery string. |
+|  [UserClickedAbortARedirection](./x-components.searchxevents.userclickedabortaredirection.md) | void | The user has aborted a redirection. |
+|  [UserClickedARedirection](./x-components.searchxevents.userclickedaredirection.md) | Redirection | The user has clicked a redirection. \* Payload: The clicked redirection. |
 |  [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. |