@empathyco/x-components 3.0.0-alpha.403 → 3.0.0-alpha.405

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0-alpha.405](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.404...@empathyco/x-components@3.0.0-alpha.405) (2023-08-25)
+
+**Note:** Version bump only for package @empathyco/x-components
+
+
+
+
+
+## [3.0.0-alpha.404](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.403...@empathyco/x-components@3.0.0-alpha.404) (2023-08-23)
+
+
+### Documentation
+
+* remove jsdoc [@links](https://github.com/links) from generated documentation (#1261) ([9082fb2](https://github.com/empathyco/x/commit/9082fb2a9d2be89252cc58931d8b3035849a3123))
+
+
+
 ## [3.0.0-alpha.403](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.402...@empathyco/x-components@3.0.0-alpha.403) (2023-08-21)
 
 **Note:** Version bump only for package @empathyco/x-components

package/docs/API-reference/api/x-components.basecolumnpickerdropdown.emitevent.md

@@ -4,7 +4,7 @@
 
 ## BaseColumnPickerDropdown.emitEvent() method
 
-Emits a [UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) and [ColumnsNumberProvided](./x-components.xeventstypes.columnsnumberprovided.md) events.
+Emits a [XEventsTypes.UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) and [XEventsTypes.ColumnsNumberProvided](./x-components.xeventstypes.columnsnumberprovided.md) events.
 
 **Signature:**
 

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

@@ -4,9 +4,9 @@
 
 ## BaseColumnPickerDropdown class
 
-Column picker dropdown component renders [dropdown](./x-components.basedropdown.md) component which options are the different columns you can set for a grid.
+Column picker dropdown component renders [BaseDropdown](./x-components.basedropdown.md) component which options are the different columns you can set for a grid.
 
-It emits [UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) on dropdown input.
+It emits [XEventsTypes.UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) on dropdown input.
 
 **Signature:**
 
@@ -29,5 +29,5 @@ It extends [ColumnPickerMixin](./x-components.columnpickermixin.md)<!-- -->.
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [emitEvent(column)](./x-components.basecolumnpickerdropdown.emitevent.md) |  | Emits a [UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) and [ColumnsNumberProvided](./x-components.xeventstypes.columnsnumberprovided.md) events. |
+|  [emitEvent(column)](./x-components.basecolumnpickerdropdown.emitevent.md) |  | Emits a [XEventsTypes.UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) and [XEventsTypes.ColumnsNumberProvided](./x-components.xeventstypes.columnsnumberprovided.md) events. |
 

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

@@ -4,7 +4,7 @@
 
 ## BaseEventButton class
 
-Component to be reused that renders a `<button>` with the logic of emitting events to the bus on click. The events are passed as an object to prop [events](./x-components.xeventstypes.md)<!-- -->. The keys are the event name and the values are the payload of each event. All events are emitted with its respective payload. If any event doesn't need payload a `undefined` must be passed as value.
+Component to be reused that renders a `<button>` with the logic of emitting events to the bus on click. The events are passed as an object to prop [XEventsTypes](./x-components.xeventstypes.md)<!-- -->. The keys are the event name and the values are the payload of each event. All events are emitted with its respective payload. If any event doesn't need payload a `undefined` must be passed as value.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.baseeventsmodal.eventstoclosemodal.md

@@ -4,7 +4,7 @@
 
 ## BaseEventsModal.eventsToCloseModal property
 
-Array of [xEvents](./x-components.xevent.md) to listen to close the modal.
+Array of [XEvent](./x-components.xevent.md) to listen to close the modal.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.baseeventsmodal.eventstoopenmodal.md

@@ -4,7 +4,7 @@
 
 ## BaseEventsModal.eventsToOpenModal property
 
-Array of [xEvents](./x-components.xevent.md) to listen to open the modal.
+Array of [XEvent](./x-components.xevent.md) to listen to open the modal.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## BaseEventsModal class
 
-Component containing a modal that emits a [XEventsTypes.UserClickedCloseEventsModal](./x-components.xeventstypes.userclickedcloseeventsmodal.md) when clicking outside the content rendered in the default slot and can receive, through the eventsToCloseModal prop, a list of [xEvents](./x-components.xevent.md) to listen to in order to close also the modal, eventsToOpenModal prop, another list of [xEvents](./x-components.xevent.md) to customize the events to listen to open the modal and a prop, displayOverlay, to display an overlay over the rest of the html. The default slot offers the possibility to customize the modal content.
+Component containing a modal that emits a [XEventsTypes.UserClickedCloseEventsModal](./x-components.xeventstypes.userclickedcloseeventsmodal.md) when clicking outside the content rendered in the default slot and can receive, through the eventsToCloseModal prop, a list of [XEvent](./x-components.xevent.md) to listen to in order to close also the modal, eventsToOpenModal prop, another list of [XEvent](./x-components.xevent.md) to customize the events to listen to open the modal and a prop, displayOverlay, to display an overlay over the rest of the html. The default slot offers the possibility to customize the modal content.
 
 **Signature:**
 
@@ -19,8 +19,8 @@ export default class BaseEventsModal extends Vue
 |  --- | --- | --- | --- |
 |  [animation?](./x-components.baseeventsmodal.animation.md) |  | Vue \| string | _(Optional)_ Animation to use for opening/closing the modal. |
 |  [bodyClickEvent](./x-components.baseeventsmodal.bodyclickevent.md) |  | [XEvent](./x-components.xevent.md) | Event to emit when any part of the website out of the modal has been clicked. |
-|  [eventsToCloseModal](./x-components.baseeventsmodal.eventstoclosemodal.md) |  | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [xEvents](./x-components.xevent.md) to listen to close the modal. |
-|  [eventsToOpenModal](./x-components.baseeventsmodal.eventstoopenmodal.md) |  | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [xEvents](./x-components.xevent.md) to listen to open the modal. |
+|  [eventsToCloseModal](./x-components.baseeventsmodal.eventstoclosemodal.md) |  | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [XEvent](./x-components.xevent.md) to listen to close the modal. |
+|  [eventsToOpenModal](./x-components.baseeventsmodal.eventstoopenmodal.md) |  | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [XEvent](./x-components.xevent.md) to listen to open the modal. |
 |  [isOpen](./x-components.baseeventsmodal.isopen.md) | <code>protected</code> | boolean | Whether the modal is open or not. |
 |  [openerElement?](./x-components.baseeventsmodal.openerelement.md) | <code>protected</code> | HTMLElement | _(Optional)_ The element that opened the modal. |
 

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

@@ -23,9 +23,9 @@ The component can be customized through props: an array of navigationHijacker ob
 |  --- | --- | --- | --- |
 |  [elementToFocus](./x-components.basekeyboardnavigation.elementtofocus.md) | <code>protected</code> | HTMLElement \| undefined | The element to focus. |
 |  [eventsForDirectionLimit](./x-components.basekeyboardnavigation.eventsfordirectionlimit.md) | <code>protected</code> | Partial&lt;[EventsForDirectionLimit](./x-components.eventsfordirectionlimit.md)<!-- -->&gt; | An [EventsForDirectionLimit](./x-components.eventsfordirectionlimit.md) to emit when the user is already at the furthest element in a direction and tries to keep going on the same direction. |
-|  [navigationHijacker](./x-components.basekeyboardnavigation.navigationhijacker.md) | <code>protected</code> | [TakeNavigationControl](./x-components.takenavigationcontrol.md)<!-- -->\[\] | An array of [navigation hijacker](./x-components.takenavigationcontrol.md) objects defining when to take control of the keyboard navigation. |
+|  [navigationHijacker](./x-components.basekeyboardnavigation.navigationhijacker.md) | <code>protected</code> | [TakeNavigationControl](./x-components.takenavigationcontrol.md)<!-- -->\[\] | An array of [TakeNavigationControl](./x-components.takenavigationcontrol.md) objects defining when to take control of the keyboard navigation. |
 |  [navigationHijackerEvents](./x-components.basekeyboardnavigation.navigationhijackerevents.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [XEventsOf](./x-components.xeventsof.md)<!-- -->&lt;[ArrowKey](./x-components.arrowkey.md)<!-- -->&gt;\[\] | Get the navigation hijacker events. |
-|  [navigationService](./x-components.basekeyboardnavigation.navigationservice.md) | <code>protected</code> | [SpatialNavigation](./x-components.spatialnavigation.md) | The [navigation service](./x-components.spatialnavigation.md) to use. |
+|  [navigationService](./x-components.basekeyboardnavigation.navigationservice.md) | <code>protected</code> | [SpatialNavigation](./x-components.spatialnavigation.md) | The [SpatialNavigation](./x-components.spatialnavigation.md) service to use. |
 
 ## Methods
 

package/docs/API-reference/api/x-components.basekeyboardnavigation.navigationhijacker.md

@@ -4,7 +4,7 @@
 
 ## BaseKeyboardNavigation.navigationHijacker property
 
-An array of [navigation hijacker](./x-components.takenavigationcontrol.md) objects defining when to take control of the keyboard navigation.
+An array of [TakeNavigationControl](./x-components.takenavigationcontrol.md) objects defining when to take control of the keyboard navigation.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.basekeyboardnavigation.navigationservice.md

@@ -4,7 +4,7 @@
 
 ## BaseKeyboardNavigation.navigationService property
 
-The [navigation service](./x-components.spatialnavigation.md) to use.
+The [SpatialNavigation](./x-components.spatialnavigation.md) service to use.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## BaseResultCurrentPrice variable
 
-Component that renders the [result](./x-types.result.md) current price that may or may not be on sale.
+Component that renders the [Result](./x-types.result.md) current price that may or may not be on sale.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## BaseResultPreviousPrice variable
 
-Component that renders the [result](./x-types.result.md) previous price.
+Component that renders the [Result](./x-types.result.md) previous price.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## BaseSuggestion variable
 
-Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvents](./x-components.xevent.md) that will be emitted on click with a given feature.
+Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvent](./x-components.xevent.md) that will be emitted on click with a given feature.
 
 The default slot receives the suggestion and the matched query has props.
 

package/docs/API-reference/api/x-components.empathize.eventstocloseempathize.md

@@ -4,7 +4,7 @@
 
 ## Empathize.eventsToCloseEmpathize property
 
-Array of [xEvents](./x-components.xevent.md) to close the empathize.
+Array of [XEvent](./x-components.xevent.md) to close the empathize.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.empathize.eventstoopenempathize.md

@@ -4,7 +4,7 @@
 
 ## Empathize.eventsToOpenEmpathize property
 
-Array of [xEvents](./x-components.xevent.md) to open the empathize.
+Array of [XEvent](./x-components.xevent.md) to open the empathize.
 
 **Signature:**
 

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

@@ -19,12 +19,12 @@ export default class Empathize extends Vue
 |  --- | --- | --- | --- |
 |  [$refs](./x-components.empathize._refs.md) |  | { noContent?: HTMLSpanElement; empathize: HTMLDivElement; } |  |
 |  [animation](./x-components.empathize.animation.md) | <code>protected</code> | Vue | Animation component that will be used to animate the empathize. |
-|  [eventsToCloseEmpathize](./x-components.empathize.eventstocloseempathize.md) | <code>protected</code> | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [xEvents](./x-components.xevent.md) to close the empathize. |
-|  [eventsToOpenEmpathize](./x-components.empathize.eventstoopenempathize.md) | <code>protected</code> | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [xEvents](./x-components.xevent.md) to open the empathize. |
+|  [eventsToCloseEmpathize](./x-components.empathize.eventstocloseempathize.md) | <code>protected</code> | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [XEvent](./x-components.xevent.md) to close the empathize. |
+|  [eventsToOpenEmpathize](./x-components.empathize.eventstoopenempathize.md) | <code>protected</code> | [XEvent](./x-components.xevent.md)<!-- -->\[\] | Array of [XEvent](./x-components.xevent.md) to open the empathize. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [updated()](./x-components.empathize.updated.md) |  | The Vue lifecycle hook [updated](https://vuex.vuejs.org/guide/state.html) is called after a data change causes the virtual DOM to be re-rendered and patched. Using it to detect if the default slot content has been replaced. |
+|  [updated()](./x-components.empathize.updated.md) |  | The Vue lifecycle hook \[https://vuex.vuejs.org/guide/state.html\](updated) is called after a data change causes the virtual DOM to be re-rendered and patched. Using it to detect if the default slot content has been replaced. |
 

package/docs/API-reference/api/x-components.empathize.updated.md

@@ -4,7 +4,7 @@
 
 ## Empathize.updated() method
 
-The Vue lifecycle hook [updated](https://vuex.vuejs.org/guide/state.html) is called after a data change causes the virtual DOM to be re-rendered and patched. Using it to detect if the default slot content has been replaced.
+The Vue lifecycle hook \[https://vuex.vuejs.org/guide/state.html\](updated) is called after a data change causes the virtual DOM to be re-rendered and patched. Using it to detect if the default slot content has been replaced.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## IdentifierResult class
 
-This component renders an identifier result value and highlights its matching part with the query from the state. Receives as prop the [result data](./x-types.result.md)<!-- -->.
+This component renders an identifier result value and highlights its matching part with the query from the state. Receives as prop the [Result](./x-types.result.md) data.
 
 **Signature:**
 
@@ -20,5 +20,5 @@ export default class IdentifierResult extends Vue
 |  [highlightedQueryHTML](./x-components.identifierresult.highlightedqueryhtml.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | Highlights the matching part of the identifier result with the query from the state. |
 |  [identifierHighlightRegexp](./x-components.identifierresult.identifierhighlightregexp.md) |  | RegExp | The RegExp with the current query from the state adding the separatorChars after each matching character. |
 |  [query](./x-components.identifierresult.query.md) |  | string | Query from the module state. |
-|  [result](./x-components.identifierresult.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
+|  [result](./x-components.identifierresult.result.md) | <code>protected</code> | Result | (Required) The [Result](./x-types.result.md) information. |
 

package/docs/API-reference/api/x-components.identifierresult.result.md

@@ -4,7 +4,7 @@
 
 ## IdentifierResult.result property
 
-(Required) The [result](./x-types.result.md) information.
+(Required) The [Result](./x-types.result.md) information.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## IdentifierResults class
 
-Paints the list of identifier results stored in the state. Each identifier result should be represented by a [identifier result component](./x-components.identifierresult.md) besides any other component.
+Paints the list of identifier results stored in the state. Each identifier result should be represented by a [IdentifierResult](./x-components.identifierresult.md) component besides any other component.
 
 **Signature:**
 

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

@@ -15,11 +15,11 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [AnimateWidth](./x-components.animatewidth.md) | Renders a transition wrapping an element passed in the default slot and animating its width. |
 |  [Banner](./x-components.banner.md) | <p>. A banner result is just an item that has been inserted into the search results to advertise something. Usually it is the first item in the grid or it can be placed in the middle of them and fill the whole row where appears. The banner may be clickable or non-clickable depending on whether it has an associated URL or not. It contains an image and, optionally, a title. In case the image does not load due to an error the banner will not be rendered.</p><p>Additionally, this component exposes the following props to modify the classes of the elements: <code>titleClass</code>.</p> |
 |  [BannersList](./x-components.bannerslist.md) | <p>It renders a [ItemsList](./x-components.itemslist.md) list of banners from [SearchState.banners](./x-components.searchstate.banners.md) by default using the <code>ItemsInjectionMixin</code>.</p><p>The component provides a default slot which wraps the whole component with the <code>banners</code> plus the <code>searchInjectedItems</code> which also contains the injected list items from the ancestor.</p><p>It also provides the parent slots to customize the items.</p> |
-|  [BaseColumnPickerDropdown](./x-components.basecolumnpickerdropdown.md) | <p>Column picker dropdown component renders [dropdown](./x-components.basedropdown.md) component which options are the different columns you can set for a grid.</p><p>It emits [UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) on dropdown input.</p> |
+|  [BaseColumnPickerDropdown](./x-components.basecolumnpickerdropdown.md) | <p>Column picker dropdown component renders [BaseDropdown](./x-components.basedropdown.md) component which options are the different columns you can set for a grid.</p><p>It emits [XEventsTypes.UserClickedColumnPicker](./x-components.xeventstypes.userclickedcolumnpicker.md) on dropdown input.</p> |
 |  [BaseColumnPickerList](./x-components.basecolumnpickerlist.md) | <p>Column picker list component renders a list of buttons to choose the columns number.</p><p>Additionally, this component exposes the following props to modify the classes of the elements: <code>buttonClass</code>.</p> |
 |  [BaseDropdown](./x-components.basedropdown.md) | Dropdown component that mimics a Select element behavior, but with the option to customize the toggle button and each item contents. |
-|  [BaseEventButton](./x-components.baseeventbutton.md) | Component to be reused that renders a <code>&lt;button&gt;</code> with the logic of emitting events to the bus on click. The events are passed as an object to prop [events](./x-components.xeventstypes.md)<!-- -->. The keys are the event name and the values are the payload of each event. All events are emitted with its respective payload. If any event doesn't need payload a <code>undefined</code> must be passed as value. |
-|  [BaseEventsModal](./x-components.baseeventsmodal.md) | Component containing a modal that emits a [XEventsTypes.UserClickedCloseEventsModal](./x-components.xeventstypes.userclickedcloseeventsmodal.md) when clicking outside the content rendered in the default slot and can receive, through the eventsToCloseModal prop, a list of [xEvents](./x-components.xevent.md) to listen to in order to close also the modal, eventsToOpenModal prop, another list of [xEvents](./x-components.xevent.md) to customize the events to listen to open the modal and a prop, displayOverlay, to display an overlay over the rest of the html. The default slot offers the possibility to customize the modal content. |
+|  [BaseEventButton](./x-components.baseeventbutton.md) | Component to be reused that renders a <code>&lt;button&gt;</code> with the logic of emitting events to the bus on click. The events are passed as an object to prop [XEventsTypes](./x-components.xeventstypes.md)<!-- -->. The keys are the event name and the values are the payload of each event. All events are emitted with its respective payload. If any event doesn't need payload a <code>undefined</code> must be passed as value. |
+|  [BaseEventsModal](./x-components.baseeventsmodal.md) | Component containing a modal that emits a [XEventsTypes.UserClickedCloseEventsModal](./x-components.xeventstypes.userclickedcloseeventsmodal.md) when clicking outside the content rendered in the default slot and can receive, through the eventsToCloseModal prop, a list of [XEvent](./x-components.xevent.md) to listen to in order to close also the modal, eventsToOpenModal prop, another list of [XEvent](./x-components.xevent.md) to customize the events to listen to open the modal and a prop, displayOverlay, to display an overlay over the rest of the html. The default slot offers the possibility to customize the modal content. |
 |  [BaseGrid](./x-components.basegrid.md) | Grid component that is able to render different items based on their modelName value. In order to achieve this, it exposes a scopedSlot for each different modelName. In case the items used do not have modelName property, the default slot is used instead. It has a required property: the <code>items</code> to render; and an optional one: the number <code>columns</code> the grid is divided in. If the number of columns is not specified, the grid automatically fills the rows with as many columns as it can fit. |
 |  [BaseHeaderTogglePanel](./x-components.baseheadertogglepanel.md) | Toggle panel which uses the base toggle panel, adds a header and manage the open / close state of the panel. |
 |  [BaseIdModal](./x-components.baseidmodal.md) | Component containing a modal expecting a required prop, named <code>modalId</code>. It reacts to <code>UserClickedOpenModal</code>, <code>UserClickedCloseModal</code> and <code>UserClickedOutOfModal</code> events, when their payload matches the component's 'modalId' prop, to handle its open/close state. The default slot offers the possibility to customise the modal content. |
@@ -67,8 +67,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [HistoryQueriesGetter](./x-components.historyqueriesgetter.md) | Class implementation for the [HistoryQueriesGetters.historyQueries](./x-components.historyqueriesgetters.historyqueries.md) getter. |
 |  [HistoryQueriesSwitch](./x-components.historyqueriesswitch.md) | History Queries Switch is a component to enable or disable the history queries. This component emits events depending on the <code>isEnabled</code> value. |
 |  [HistoryQuery](./x-components.historyquery.md) | This component renders a history query suggestion combining two buttons: one for selecting this suggestion as the search query, and another one to remove this query suggestion from the history queries. |
-|  [IdentifierResult](./x-components.identifierresult.md) | This component renders an identifier result value and highlights its matching part with the query from the state. Receives as prop the [result data](./x-types.result.md)<!-- -->. |
-|  [IdentifierResults](./x-components.identifierresults.md) | Paints the list of identifier results stored in the state. Each identifier result should be represented by a [identifier result component](./x-components.identifierresult.md) besides any other component. |
+|  [IdentifierResult](./x-components.identifierresult.md) | This component renders an identifier result value and highlights its matching part with the query from the state. Receives as prop the [Result](./x-types.result.md) data. |
+|  [IdentifierResults](./x-components.identifierresults.md) | Paints the list of identifier results stored in the state. Each identifier result should be represented by a [IdentifierResult](./x-components.identifierresult.md) component besides any other component. |
 |  [ItemsList](./x-components.itemslist.md) | It renders a list of [ListItem](./x-components.listitem.md) providing a slot for each <code>slotName</code> which depends on the <code>modelName</code>of the item. |
 |  [ItemsListInjectionMixin](./x-components.itemslistinjectionmixin.md) | Mixin to facilitate providing and injecting a list of list items. Injected list is available at <code>injectedListItems</code>, and the provided list should be stored in <code>items</code>. |
 |  [LocationProvider](./x-components.locationprovider.md) | Location Provider component. This component injects the location with value passed as prop. |
@@ -93,13 +93,13 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [QuerySuggestion](./x-components.querysuggestion.md) | This component renders a suggestion for a query. A query suggestion is a recommended query based on previous search queries. It contains the query itself and a set of filters associated. For example, if you're searching for \_shirt\_, a query suggestion could be \_long sleeve shirt\_. |
 |  [QuerySuggestions](./x-components.querysuggestions.md) | This component renders a list of possible search queries to select from as a query is entered in the input field. By default, this is a list of \[<code>QuerySuggestion</code>\](./x-components.query-suggestion.md) components. |
 |  [QuerySuggestionsGetter](./x-components.querysuggestionsgetter.md) | Class implementation for the [QuerySuggestionsGetter.querySuggestions()](./x-components.querysuggestionsgetter.querysuggestions.md) getter. |
-|  [Recommendations](./x-components.recommendations.md) | It renders a list of recommendations from the [Recommendations](./x-components.recommendationsstate.recommendations.md) state by default. The component provides the slot layout which wraps the whole component with the recommendations bounded. It also provides the default slot to customize the item, which is within the layout slot, with the recommendation bounded. Each recommendation should be represented by a [result link component](./x-components.baseresultlink.md) besides any other component. |
+|  [Recommendations](./x-components.recommendations.md) | It renders a list of recommendations from the [RecommendationsState.recommendations](./x-components.recommendationsstate.recommendations.md) state by default. The component provides the slot layout which wraps the whole component with the recommendations bounded. It also provides the default slot to customize the item, which is within the layout slot, with the recommendation bounded. Each recommendation should be represented by a [BaseResultLink](./x-components.baseresultlink.md) component besides any other component. |
 |  [Redirection](./x-components.redirection.md) | A redirection is a component that sends the user to a link in the website. It is helpful when there are queries like <code>help</code>, <code>shipping costs</code>, <code>my account</code>, where a link to a section in the website will be more helpful than the set of results returned. |
 |  [RelatedTag](./x-components.relatedtag.md) | This component renders a related tag for a query. A related tag is a descriptive keyword related to the current query to fine-tune the search. For example, if you are searching for \*lego\*, a related tag could be \*city\*, refining the search with \*lego city\*. |
 |  [RelatedTags](./x-components.relatedtags.md) | This component renders a set of \[<code>RelatedTag</code>\](./x-components.related-tag) components by default to select from after a query is performed to fine-tune search. For example, if you are searching for \*lego\*, different related tags could be \*city\*, \*friends\*, or \*harry potter\*, refining the search with \*lego city\*, \*lego friends\*, or \*lego harry potter\*. |
 |  [RemoveHistoryQuery](./x-components.removehistoryquery.md) | Button that when it is pressed emits the [HistoryQueriesXEvents.UserPressedRemoveHistoryQuery](./x-components.historyqueriesxevents.userpressedremovehistoryquery.md) event, expressing the user intention to remove a query in the history. |
 |  [RenderlessExtraParams](./x-components.renderlessextraparams.md) | It emits a [ExtraParamsXEvents.UserChangedExtraParams](./x-components.extraparamsxevents.userchangedextraparams.md) when the <code>updateValue</code> is called. |
-|  [RenderlessFilter](./x-components.renderlessfilter.md) | Renders default slot content. It binds to the default slot a [BooleanFilter](./x-types.booleanfilter.md)<!-- -->, the [XEvents](./x-components.xevent.md) that will be emitted when clicking the content, the css classes and if the content should be disabled. |
+|  [RenderlessFilter](./x-components.renderlessfilter.md) | Renders default slot content. It binds to the default slot a [BooleanFilter](./x-types.booleanfilter.md)<!-- -->, the [XEvent](./x-components.xevent.md) that will be emitted when clicking the content, the css classes and if the content should be disabled. |
 |  [ResultsList](./x-components.resultslist.md) | <p>It renders a [ItemsList](./x-components.itemslist.md) list with the results from [SearchState.results](./x-components.searchstate.results.md) by default.</p><p>The component provides a default slot which wraps the whole component with the <code>results</code> bound.</p><p>It also provides the slot result to customize the item, which is within the default slot, with the result bound.</p> |
 |  [ResultVariantSelector](./x-components.resultvariantselector.md) | Component to show and select the available variants of a product for a given nest level. TODO: Add logger warning on mount when result is not injected. |
 |  [ResultVariantsProvider](./x-components.resultvariantsprovider.md) | <p>Component that exposes the result merged with its selected variant in the default slot.</p><p>It receives the original result and keeps track of the selected variant.</p><p>It provides the original result, the array containing the selected variants and a callback to set the selected variant to be used from a child.</p> |
@@ -128,7 +128,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [SpellcheckButton](./x-components.spellcheckbutton.md) | A button that when pressed emits the [XEventsTypes.UserAcceptedAQuery](./x-components.xeventstypes.useracceptedaquery.md) and [XEventsTypes.UserAcceptedSpellcheckQuery](./x-components.xeventstypes.useracceptedspellcheckquery.md) events, expressing the user intention to set the spellchecked query. |
 |  [StaggeredFadeAndSlide](./x-components.staggeredfadeandslide.md) | Renders a transition group wrapping the elements passed in the default slot and animating them with an staggered fade and slide animation. |
 |  [StaggeringTransitionGroup](./x-components.staggeringtransitiongroup.md) | A replacement component for Vue's transition-group, that also adds the option to stagger the animations. |
-|  [Tagging](./x-components.tagging.md) | This component enables and manages the sending of information to the [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html)<!-- -->. It allows to enable or disable the session id management through the <code>consent</code> prop. |
+|  [Tagging](./x-components.tagging.md) | This component enables and manages the sending of information to the \[Empathy Tagging API\](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html). It allows to enable or disable the session id management through the <code>consent</code> prop. |
 |  [UrlHandler](./x-components.urlhandler.md) | This component manages the browser URL parameters to preserve them through reloads and browser history navigation. It allow to configure the default url parameter names using its attributes. This component doesn't render elements to the DOM. |
 |  [WindowScroll](./x-components.windowscroll.md) | The <code>WindowScroll</code> component listens to either the <code>html</code> or <code>body</code> DOM scroll events, and re-emits them as X Events. Additionally it also emits events related to the direction or current position of these elements scroll. |
 |  [XInstaller](./x-components.xinstaller.md) | <p>The purpose of this class is to offer a quick way to initialize the XComponents in a setup project. It allows to receive all the options in [InstallXOptions](./x-components.installxoptions.md) which is an extension of [XPluginOptions](./x-components.xpluginoptions.md) with all the options for the plugin and some options more.</p><p>This class does multiple things: 1. Install the [XPlugin](./x-components.xplugin.md) with the [XPluginOptions](./x-components.xpluginoptions.md)<!-- -->. 2. Creates the public [XAPI](./x-components.xapi.md) and add it to global window. 3. Creates the Vue Application for the customer project.</p><p>The steps 2 &amp; 3 are optional and depends on the options passed in [InstallXOptions](./x-components.installxoptions.md)<!-- -->.</p> |
@@ -397,12 +397,12 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [BasePlaceholderImage](./x-components.baseplaceholderimage.md) |  |
 |  [BasePriceFilterLabel](./x-components.basepricefilterlabel.md) | Renders a label for a price filter, allowing to select different messages depending on the value of the filter. |
 |  [BaseRatingFilterLabel](./x-components.baseratingfilterlabel.md) | Renders a label for a rating filter, allowing to override the elements used to paint the rating. |
-|  [BaseResultCurrentPrice](./x-components.baseresultcurrentprice.md) | Component that renders the [result](./x-types.result.md) current price that may or may not be on sale. |
+|  [BaseResultCurrentPrice](./x-components.baseresultcurrentprice.md) | Component that renders the [Result](./x-types.result.md) current price that may or may not be on sale. |
 |  [BaseResultImage](./x-components.baseresultimage.md) | Component to be reused that renders an <code>&lt;img&gt;</code>. |
 |  [BaseResultLink](./x-components.baseresultlink.md) | Component to be reused that renders an <code>&lt;a&gt;</code> wrapping the result contents. |
-|  [BaseResultPreviousPrice](./x-components.baseresultpreviousprice.md) | Component that renders the [result](./x-types.result.md) previous price. |
+|  [BaseResultPreviousPrice](./x-components.baseresultpreviousprice.md) | Component that renders the [Result](./x-types.result.md) previous price. |
 |  [BaseResultRating](./x-components.baseresultrating.md) | This component renders a [BaseRating](./x-components.baserating.md) for a result passed as prop. |
-|  [BaseSuggestion](./x-components.basesuggestion.md) | <p>Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvents](./x-components.xevent.md) that will be emitted on click with a given feature.</p><p>The default slot receives the suggestion and the matched query has props.</p> |
+|  [BaseSuggestion](./x-components.basesuggestion.md) | <p>Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvent](./x-components.xevent.md) that will be emitted on click with a given feature.</p><p>The default slot receives the suggestion and the matched query has props.</p> |
 |  [BaseTogglePanel](./x-components.basetogglepanel.md) | Simple panel that receives its open state via prop, which is responsible of rendering default slot inside a configurable transition. |
 |  [bus](./x-components.bus.md) | Default  implementation. |
 |  [cancelFetchAndSaveIdentifierResults](./x-components.cancelfetchandsaveidentifierresults.md) | Default implementation for [IdentifierResultsActions.cancelFetchAndSaveIdentifierResults()](./x-components.identifierresultsactions.cancelfetchandsaveidentifierresults.md) action. |

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

@@ -4,7 +4,7 @@
 
 ## Recommendations class
 
-It renders a list of recommendations from the [Recommendations](./x-components.recommendationsstate.recommendations.md) state by default. The component provides the slot layout which wraps the whole component with the recommendations bounded. It also provides the default slot to customize the item, which is within the layout slot, with the recommendation bounded. Each recommendation should be represented by a [result link component](./x-components.baseresultlink.md) besides any other component.
+It renders a list of recommendations from the [RecommendationsState.recommendations](./x-components.recommendationsstate.recommendations.md) state by default. The component provides the slot layout which wraps the whole component with the recommendations bounded. It also provides the default slot to customize the item, which is within the layout slot, with the recommendation bounded. Each recommendation should be represented by a [BaseResultLink](./x-components.baseresultlink.md) component besides any other component.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## RenderlessFilter class
 
-Renders default slot content. It binds to the default slot a [BooleanFilter](./x-types.booleanfilter.md)<!-- -->, the [XEvents](./x-components.xevent.md) that will be emitted when clicking the content, the css classes and if the content should be disabled.
+Renders default slot content. It binds to the default slot a [BooleanFilter](./x-types.booleanfilter.md)<!-- -->, the [XEvent](./x-components.xevent.md) that will be emitted when clicking the content, the css classes and if the content should be disabled.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.scrollmixin.firstelementthresholdpx.md

@@ -4,7 +4,7 @@
 
 ## ScrollMixin.firstElementThresholdPx property
 
-Positive vertical distance to still consider that the an element is the first one visible. For example, if set to 100, after scrolling 100 pixels, the first rendered element will still be considered the first one.
+Positive vertical distance to still consider that the element is the first one visible. For example, if set to 100, after scrolling 100 pixels, the first rendered element will still be considered the first one.
 
 **Signature:**
 

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

@@ -19,8 +19,9 @@ export default class ScrollMixin extends Vue
 |  --- | --- | --- | --- |
 |  [$el](./x-components.scrollmixin._el.md) |  | HTMLElement | The scrolling container reference. |
 |  [distanceToBottom](./x-components.scrollmixin.distancetobottom.md) |  | number | Distance to the end of the scroll that when reached will emit the <code>scroll:about-to-end</code> event. |
-|  [firstElementThresholdPx](./x-components.scrollmixin.firstelementthresholdpx.md) |  | number | Positive vertical distance to still consider that the an element is the first one visible. For example, if set to 100, after scrolling 100 pixels, the first rendered element will still be considered the first one. |
+|  [firstElementThresholdPx](./x-components.scrollmixin.firstelementthresholdpx.md) |  | number | Positive vertical distance to still consider that the element is the first one visible. For example, if set to 100, after scrolling 100 pixels, the first rendered element will still be considered the first one. |
 |  [resetOn](./x-components.scrollmixin.reseton.md) |  | [XEvent](./x-components.xevent.md) | List of events that should reset the scroll when emitted. |
 |  [resetOnChange](./x-components.scrollmixin.resetonchange.md) | <code>protected</code> | boolean | If true (default), sets the scroll position to the top when certain events are emitted. |
+|  [throtteledCall](./x-components.scrollmixin.throtteledcall.md) | <code>protected</code> | import("../..").[ThrottleFunction](./x-components.throttlefunction.md)<!-- -->&lt;\[\]&gt; |  |
 |  [throttleMs](./x-components.scrollmixin.throttlems.md) |  | number | Time duration to ignore the subsequent scroll events after an emission. Higher values will decrease events precision but can prevent performance issues. |
 

package/docs/API-reference/api/x-components.scrollmixin.throtteledcall.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; [ScrollMixin](./x-components.scrollmixin.md) &gt; [throtteledCall](./x-components.scrollmixin.throtteledcall.md)
+
+## ScrollMixin.throtteledCall property
+
+**Signature:**
+
+```typescript
+protected throtteledCall: import("../..").ThrottleFunction<[]>;
+```

package/docs/API-reference/api/x-components.tagging.clickedresultstoragekey.md

@@ -4,7 +4,7 @@
 
 ## Tagging.clickedResultStorageKey property
 
-The Object key of the [result](./x-types.result.md) clicked by the user that will be used as id for the storage. By default, the Result url will be used.
+The Object key of the [Result](./x-types.result.md) clicked by the user that will be used as id for the storage. By default, the Result url will be used.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## Tagging class
 
-This component enables and manages the sending of information to the [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html)<!-- -->. It allows to enable or disable the session id management through the `consent` prop.
+This component enables and manages the sending of information to the \[Empathy Tagging API\](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html). It allows to enable or disable the session id management through the `consent` prop.
 
 **Signature:**
 
@@ -18,7 +18,7 @@ export default class Tagging extends Vue
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [activeConsent](./x-components.tagging.activeconsent.md) | <code>readonly</code> | boolean | The active consent, selected from the <code>consent</code> prop and the <code>snippetConfig.consent</code> property. False by default. |
-|  [clickedResultStorageKey](./x-components.tagging.clickedresultstoragekey.md) |  | string | The Object key of the [result](./x-types.result.md) clicked by the user that will be used as id for the storage. By default, the Result url will be used. |
+|  [clickedResultStorageKey](./x-components.tagging.clickedresultstoragekey.md) |  | string | The Object key of the [Result](./x-types.result.md) clicked by the user that will be used as id for the storage. By default, the Result url will be used. |
 |  [clickedResultStorageTTLMs](./x-components.tagging.clickedresultstoragettlms.md) |  | number | The TTL in milliseconds for storing the clicked result info. |
 |  [config](./x-components.tagging.config.md) | <code>readonly</code> | [TaggingConfig](./x-components.taggingconfig.md) |  |
 |  [consent?](./x-components.tagging.consent.md) | <code>protected</code> | boolean | _(Optional)_ The consent to be emitted. |

package/docs/API-reference/components/common/column-picker/x-components.base-column-picker-dropdown.md

@@ -6,10 +6,10 @@ title: BaseColumnPickerDropdown
 
 # BaseColumnPickerDropdown
 
-Column picker dropdown component renders {@link BaseDropdown | dropdown} component which options are
-the different columns you can set for a grid.
+Column picker dropdown component renders BaseDropdown component which options are the different
+columns you can set for a grid.
 
-It emits {@link XEventsTypes.UserClickedColumnPicker | UserClickedColumnPicker} on dropdown input.
+It emits XEventsTypes.UserClickedColumnPicker on dropdown input.
 
 ## Props
 

package/docs/API-reference/components/common/modals/x-components.base-events-modal-close.md

@@ -6,8 +6,8 @@ title: BaseEventsModalClose
 
 # BaseEventsModalClose
 
-Component contains an event button that emits {@link XEventsTypes.UserClickedCloseEventsModal} when
-clicked. It has a default slot to customize its contents.
+Component contains an event button that emits XEventsTypes.UserClickedCloseEventsModal when clicked.
+It has a default slot to customize its contents.
 
 ## Props
 

package/docs/API-reference/components/common/modals/x-components.base-events-modal-open.md

@@ -6,8 +6,8 @@ title: BaseEventsModalOpen
 
 # BaseEventsModalOpen
 
-Component contains an event button that emits {@link XEventsTypes.UserClickedOpenEventsModal} when
-clicked. It has a default slot to customize its contents.
+Component contains an event button that emits XEventsTypes.UserClickedOpenEventsModal when clicked.
+It has a default slot to customize its contents.
 
 ## Props
 

package/docs/API-reference/components/common/modals/x-components.base-events-modal.md

@@ -6,20 +6,20 @@ title: BaseEventsModal
 
 # BaseEventsModal
 
-Component containing a modal that emits a {@link XEventsTypes.UserClickedCloseEventsModal} when
-clicking outside the content rendered in the default slot and can receive, through the
-eventsToCloseModal prop, a list of {@link XEvent | xEvents} to listen to in order to close also the
-modal, eventsToOpenModal prop, another list of {@link XEvent | xEvents} to customize the events to
-listen to open the modal and a prop, displayOverlay, to display an overlay over the rest of the
-html. The default slot offers the possibility to customize the modal content.
+Component containing a modal that emits a XEventsTypes.UserClickedCloseEventsModal when clicking
+outside the content rendered in the default slot and can receive, through the eventsToCloseModal
+prop, a list of XEvent to listen to in order to close also the modal, eventsToOpenModal prop,
+another list of XEvent to customize the events to listen to open the modal and a prop,
+displayOverlay, to display an overlay over the rest of the html. The default slot offers the
+possibility to customize the modal content.
 
 ## Props
 
 | Name                            | Description                                                                   | Type                | Default                                                                                     |
 | ------------------------------- | ----------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------- |
 | <code>animation</code>          | Animation to use for opening/closing the modal.                               | <code>union</code>  | <code></code>                                                                               |
-| <code>eventsToOpenModal</code>  | Array of {@link XEvent \| xEvents} to listen to open the modal.               | <code>Array</code>  | <code>(): XEvent[] => ['UserClickedOpenEventsModal']</code>                                 |
-| <code>eventsToCloseModal</code> | Array of {@link XEvent \| xEvents} to listen to close the modal.              | <code>Array</code>  | <code>(): XEvent[] => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal']</code> |
+| <code>eventsToOpenModal</code>  | Array of XEvent to listen to open the modal.                                  | <code>Array</code>  | <code>(): XEvent[] => ['UserClickedOpenEventsModal']</code>                                 |
+| <code>eventsToCloseModal</code> | Array of XEvent to listen to close the modal.                                 | <code>Array</code>  | <code>(): XEvent[] => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal']</code> |
 | <code>bodyClickEvent</code>     | Event to emit when any part of the website out of the modal has been clicked. | <code>XEvent</code> | <code>'UserClickedOutOfEventsModal'</code>                                                  |
 
 ## Slots

package/docs/API-reference/components/common/modals/x-components.base-id-modal-close.md

@@ -6,8 +6,8 @@ title: BaseIdModalClose
 
 # BaseIdModalClose
 
-Component that allows to close a modal by emitting {@link XEventsTypes.UserClickedCloseModal}. It
-allows full customization with the 'closing-element' slot and exposes the 'closeModal' function.
+Component that allows to close a modal by emitting XEventsTypes.UserClickedCloseModal. It allows
+full customization with the 'closing-element' slot and exposes the 'closeModal' function.
 
 ## Props
 

package/docs/API-reference/components/common/modals/x-components.base-id-modal-open.md

@@ -6,9 +6,9 @@ title: BaseIdModalOpen
 
 # BaseIdModalOpen
 
-Component that allows to open a modal by emitting {@link XEventsTypes.UserClickedOpenModal} with the
-modalId as payload. It allows full customization with the 'opening-element' slot and exposes the
-'openModal' function.
+Component that allows to open a modal by emitting XEventsTypes.UserClickedOpenModal with the modalId
+as payload. It allows full customization with the 'opening-element' slot and exposes the 'openModal'
+function.
 
 ## Props
 

package/docs/API-reference/components/common/modals/x-components.close-main-modal.md

@@ -6,7 +6,7 @@ title: CloseMainModal
 
 # CloseMainModal
 
-Button to close the {@link MainModal}.
+Button to close the MainModal.
 
 ## Slots
 

package/docs/API-reference/components/common/modals/x-components.open-main-modal.md

@@ -6,7 +6,7 @@ title: OpenMainModal
 
 # OpenMainModal
 
-Button to open the {@link MainModal}.
+Button to open the MainModal.
 
 ## Slots
 

package/docs/API-reference/components/common/panels/x-components.base-id-toggle-panel-button.md

@@ -6,8 +6,8 @@ title: BaseIdTogglePanelButton
 
 # BaseIdTogglePanelButton
 
-Component containing an event button that emits {@link XEventsTypes.UserClickedPanelToggleButton}
-when clicked with the panelId as payload.
+Component containing an event button that emits XEventsTypes.UserClickedPanelToggleButton when
+clicked with the panelId as payload.
 
 It has a default slot to customize its contents.
 

package/docs/API-reference/components/common/result/x-components.base-result-add-to-cart.md

@@ -6,14 +6,14 @@ title: BaseResultAddToCart
 
 # BaseResultAddToCart
 
-Renders a button with a default slot. It receives the result with the data and emits {@link
-XEventsTypes.UserClickedResultAddToCart} to the bus on click mouse event.
+Renders a button with a default slot. It receives the result with the data and emits
+XEventsTypes.UserClickedResultAddToCart to the bus on click mouse event.
 
 ## Props
 
-| Name                | Description                                                             | Type                | Default       |
-| ------------------- | ----------------------------------------------------------------------- | ------------------- | ------------- |
-| <code>result</code> | (Required) The {@link @empathyco/x-types#Result \| result} information. | <code>Result</code> | <code></code> |
+| Name                | Description                                           | Type                | Default       |
+| ------------------- | ----------------------------------------------------- | ------------------- | ------------- |
+| <code>result</code> | (Required) The @empathyco/x-types#Result information. | <code>Result</code> | <code></code> |
 
 ## Slots