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

package/docs/API-reference/components/facets/x-components.filters/editable-number-range-filter.md

@@ -1,12 +1,13 @@
 ---
-id: x-components.editable-number-range-filter
-title: Editable Number Range Filter
-sidebar_label: Editable Number Range Filter
+
+title: EditableNumberRangeFilter
+
 ---
-# editable-number-range-filter
 
-> Renders an editable number range filter. It has two input fields to handle min and max values,
-> emitting the needed events when clicked.
+# EditableNumberRangeFilter
+
+Renders an editable number range filter. It has two input fields to handle min and max values,
+emitting the needed events when clicked.
 
 It provides a default slot, with some utils bind, to customize the whole component; and two
 named slots `apply-content` and `clear-content` to override each button content.
@@ -33,8 +34,6 @@ rendered. True by default.
 | <code>apply-content</code> | Slot used to customize the apply button content.  | None                                      |
 | <code>clear-content</code> | Slot used to customize the clear button content.  | None                                      |
 
----
-
 # Example
 
 Renders an editable number range filter. It has two input fields to handle min and max values,

package/docs/API-reference/components/facets/x-components.filters/hierarchical-filter.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.hierarchical-filter
-title: Hierarchical Filter
-sidebar_label: Hierarchical Filter
+
+title: HierarchicalFilter
+
 ---
+
 # HierarchicalFilter
 
-> Renders a hierarchical filter recursively, emitting the needed events when clicked.
+Renders a hierarchical filter recursively, emitting the needed events when clicked.
 
 ## Props
 
@@ -21,8 +22,6 @@ sidebar_label: Hierarchical Filter
 | <code>default</code> | The content to render inside the button. | <br /><br /><br />                        |
 | <code>label</code>   | The content to render inside the button. |                                           |
 
----
-
 # Examples
 
 This component renders a button, which on clicked emits the `UserClickedAFilter` and

package/docs/API-reference/components/facets/x-components.filters/number-range-filter.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.number-range-filter
-title: Number Range Filter
-sidebar_label: Number Range Filter
+
+title: NumberRangeFilter
+
 ---
-# number-range-filter
 
-> Renders a number range filter, emitting the needed events when clicked.
+# NumberRangeFilter
+
+Renders a number range filter, emitting the needed events when clicked.
 
 ## Props
 
@@ -19,8 +20,6 @@ sidebar_label: Number Range Filter
 | -------------------- | --------------------------------------- | ------------------------------------------------ |
 | <code>default</code> | The content to render inside the button | **filter** <code>Filter</code> - The filter data |
 
----
-
 # Examples
 
 This component renders a button, which on clicked emits the `UserClickedAFilter` and the

package/docs/API-reference/components/facets/x-components.filters/renderless-filter.md

@@ -1,14 +1,15 @@
 ---
-id: x-components.renderless-filter
-title: Renderless Filter
-sidebar_label: Renderless Filter
+
+title: RenderlessFilter
+
 ---
-# renderless-filter
 
-> Renders default slot content. It binds to the default slot a
-> {@link @empathyco/x-types#BooleanFilter | BooleanFilter}, the {@link XEvent | XEvents}
-> that will be emitted when clicking the content, the css classes and if the content should be
-> disabled.
+# RenderlessFilter
+
+Renders default slot content. It binds to the default slot a
+{@link @empathyco/x-types#BooleanFilter | BooleanFilter}, the {@link XEvent | XEvents}
+that will be emitted when clicking the content, the css classes and if the content should be
+disabled.
 
 ## Props
 
@@ -17,8 +18,6 @@ sidebar_label: Renderless Filter
 | <code>filter</code>      | The filter data to render.                                             | <code>BooleanFilter</code> | <code></code> |
 | <code>clickEvents</code> | Additional events with its payload to emit when the filter is clicked. | <code>Partial</code>       | <code></code> |
 
----
-
 # Examples
 
 Renders default slot content. It binds to the default slot a filter, the events that will be emitted

package/docs/API-reference/components/facets/x-components.filters/simple-filter.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.simple-filter
-title: Simple Filter
-sidebar_label: Simple Filter
+
+title: SimpleFilter
+
 ---
-# simple-filter
 
-> Renders a simple filter, emitting the needed events when clicked.
+# SimpleFilter
+
+Renders a simple filter, emitting the needed events when clicked.
 
 ## Props
 
@@ -20,8 +21,6 @@ sidebar_label: Simple Filter
 | <code>default</code> | The control element to render           | **filter** <code>Filter</code> - The filter data<br />**clickFilter** <code>() => void</code> - Method that will invoke the needed actions after the user<br /> clicks the filter.<br />**cssClasses** <code>Object</code> - Object containing CSS classes to add to the button<br />**isDisabled** <code>Boolean</code> - True if the filter shouldn't be able to be selected by the<br /> user |
 | <code>label</code>   | The content to render inside the button | **filter** <code>Filter</code> - The filter data                                                                                                                                                                                                                                                                                                                                                 |
 
----
-
 # Examples
 
 This component renders a button, which on clicked emits the `UserClickedAFilter` and the

package/docs/API-reference/components/facets/x-components.lists/exclude-filters-with-no-results.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.exclude-filters-with-no-results
-title: Exclude Filters With No Results
-sidebar_label: Exclude Filters With No Results
+
+title: ExcludeFiltersWithNoResults
+
 ---
-# exclude-filters-with-no-results
 
-> The `ExcludeFiltersWithNoResults` component filters the provided list of filters, excluding
-> those which have the `totalResults` property exactly equal to `0`. It won't remove filters with
-> no `totalResults` property.
+# ExcludeFiltersWithNoResults
+
+The `ExcludeFiltersWithNoResults` component filters the provided list of filters, excluding
+those which have the `totalResults` property exactly equal to `0`. It won't remove filters with
+no `totalResults` property.
 
 The new list of filters is bound to the default scoped slot. As this component does not render
 no root element, this default slot must contain a single root node.
@@ -19,8 +20,6 @@ no root element, this default slot must contain a single root node.
 | <code>filters</code>  | The list of filters to be rendered as slots.                                                                                                                                                 | <code>Array</code>               | <code></code> |
 | <code>parentId</code> | This prop is used in the `HierarchicalFilter` component and only in that case. It is necessary<br />to make the `renderedFilters` to return only the filters of each level of the hierarchy. | <code>TSIndexedAccessType</code> | <code></code> |
 
----
-
 # Example
 
 The `ExcludeFiltersWithNoResults` component filters the provided list of filter, excluding those

package/docs/API-reference/components/facets/x-components.lists/filters-list.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.filters-list
-title: Filters List
-sidebar_label: Filters List
+
+title: FiltersList
+
 ---
-# filters-list
 
-> Renders a list with a list item per each
-> {@link @empathyco/x-types#BooleanFilter | BooleanFilter} in the filters prop array.
-> Each list item has a scoped slot, passing the filter as slot prop.
+# FiltersList
+
+Renders a list with a list item per each
+{@link @empathyco/x-types#BooleanFilter | BooleanFilter} in the filters prop array.
+Each list item has a scoped slot, passing the filter as slot prop.
 
 ## Props
 
@@ -23,8 +24,6 @@ sidebar_label: Filters List
 | -------------------- | ------------------------- | ---------------------------------------------------------- |
 | <code>default</code> | (Required) Filter content | **filter** <code>Filter</code> - Search-types filter data. |
 
----
-
 # Examples
 
 Renders a list with a list item per each filter in the filters prop array. Each list item has a

package/docs/API-reference/components/facets/x-components.lists/filters-search.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.filters-search
-title: Filters Search
-sidebar_label: Filters Search
+
+title: FiltersSearch
+
 ---
-# filters-search
 
-> Renders the filters sifted with the input query.
+# FiltersSearch
+
+Renders the filters sifted with the input query.
 
 ## Props
 
@@ -22,8 +23,6 @@ sidebar_label: Filters Search
 | <code>search</code>  | Search content. It is the content which triggers the filters sifting. | **query** <code>string</code> - The query to search in filters.<br />**setQuery** <code>Function</code> - The function to set the query. The query is passed as<br /> parameter.<br />**clearQuery** <code>Function</code> - The function to clear the query. |
 | <code>default</code> | (Required) Sifted filters content.                                    | **siftedFilters** <code>Filter[]</code> - Sifted filters data.                                                                                                                                                                                                |
 
----
-
 # Examples
 
 It renders an input and a list of filters passed as prop or being injected. The list of filters can

package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md

@@ -1,12 +1,13 @@
 ---
-id: x-components.selected-filters-list
-title: Selected Filters List
-sidebar_label: Selected Filters List
+
+title: SelectedFiltersList
+
 ---
-# selected-filters-list
 
-> This component renders a list of selected filters from every facet, or from the facet
-> which facet id is passed as property. It uses the SelectedFilters component (state).
+# SelectedFiltersList
+
+This component renders a list of selected filters from every facet, or from the facet
+which facet id is passed as property. It uses the SelectedFilters component (state).
 
 It provides two slots: a scoped one which name is the filter facet id; and a default one.
 Both exposes the filter and renders the filter label by default.
@@ -27,8 +28,6 @@ The property "alwaysVisible" handles if the component is rendered if no filters
 | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
 | <code>default</code> | Custom filter rendering. Dynamic slot defined in the template with the filter<br /> facet id. It renders the filter label by default. | **filter** <code>Filter</code> - Filter to render. |
 
----
-
 # Example
 
 This component renders a list of selected filters from every facet, or from the facet which facet id

package/docs/API-reference/components/facets/x-components.lists/selected-filters.md

@@ -1,12 +1,13 @@
 ---
-id: x-components.selected-filters
-title: Selected Filters
-sidebar_label: Selected Filters
+
+title: SelectedFilters
+
 ---
-# selected-filters
 
-> Provides a scoped slot with the selected filters from every facet, or from the facet which
-> facet id is passed as property.
+# SelectedFilters
+
+Provides a scoped slot with the selected filters from every facet, or from the facet which
+facet id is passed as property.
 
 The default slot renders the length of the selected filters array.
 The property "alwaysVisible" handles if the component is rendered if no filters are selected.
@@ -24,8 +25,6 @@ The property "alwaysVisible" handles if the component is rendered if no filters
 | -------------------- | ----------- | ----------------------------------------- |
 | <code>default</code> |             |                                           |
 
----
-
 # Examples
 
 Provides a scoped slot with the selected filters from every facet, or from the facet which facet id

package/docs/API-reference/components/facets/x-components.lists/sliced-filters.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.sliced-filters
-title: Sliced Filters
-sidebar_label: Sliced Filters
+
+title: SlicedFilters
+
 ---
-# sliced-filters
 
-> Component that slices a list of filters and returns them using the default scoped slot,
-> allowing the user to show the full list of them or slicing them again using the
-> show more/less buttons.
+# SlicedFilters
+
+Component that slices a list of filters and returns them using the default scoped slot,
+allowing the user to show the full list of them or slicing them again using the
+show more/less buttons.
 
 ## Props
 
@@ -25,8 +26,6 @@ sidebar_label: Sliced Filters
 | <code>show-more</code> | Button show more filters.          | **difference** <code>number</code> - The difference between the filters and max to show. |
 | <code>show-less</code> | Button show less filters.          | **difference** <code>number</code> - The difference between the filters and max to show. |
 
----
-
 # Example
 
 The sliced filters component, takes a list of filters, and the maximum number of filters to render

package/docs/API-reference/components/facets/x-components.lists/sorted-filters.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.sorted-filters
-title: Sorted Filters
-sidebar_label: Sorted Filters
+
+title: SortedFilters
+
 ---
-# sorted-filters
 
-> Component that sorts a list of filters and returns them using the default scoped slot.
+# SortedFilters
+
+Component that sorts a list of filters and returns them using the default scoped slot.
 
 ## Props
 
@@ -14,8 +15,6 @@ sidebar_label: Sorted Filters
 | <code>filters</code>  | The list of filters to be rendered as slots.                                                                                                                                                 | <code>Array</code>               | <code></code> |
 | <code>parentId</code> | This prop is used in the `HierarchicalFilter` component and only in that case. It is necessary<br />to make the `renderedFilters` to return only the filters of each level of the hierarchy. | <code>TSIndexedAccessType</code> | <code></code> |
 
----
-
 # Example
 
 The sorted filters component takes a list of filters and returns this new filters list sorted by the

package/docs/API-reference/components/history-queries/x-components.clear-history-queries.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.x-components.clear-history-queries
-title: Clear History Queries
-sidebar_label: Clear History Queries
+
+title: ClearHistoryQueries
+
 ---
-# clear-history-queries
 
-> A button that when is pressed, emits the
-> {@link HistoryQueriesXEvents.UserPressedClearHistoryQueries} event, expressing the user
-> intention to clear the whole history of queries.
+# ClearHistoryQueries
+
+A button that when is pressed, emits the
+{@link HistoryQueriesXEvents.UserPressedClearHistoryQueries} event, expressing the user
+intention to clear the whole history of queries.
 
 ## Slots
 
@@ -15,8 +16,6 @@ sidebar_label: Clear History Queries
 | -------------------- | --------------------------------------------------------- | ----------------------------------------- |
 | <code>default</code> | (Required) Button content with a message, an icon or both | None                                      |
 
----
-
 # Examples
 
 ## Basic example

package/docs/API-reference/components/history-queries/x-components.history-queries.md

@@ -1,11 +1,12 @@
 ---
-id: x-components.x-components.history-queries
-title: History Queries
-sidebar_label: History Queries
+
+title: HistoryQueries
+
 ---
-# history-queries
 
-> This component renders a list of suggestions coming from the user queries history.
+# HistoryQueries
+
+This component renders a list of suggestions coming from the user queries history.
 
 Allows the user to select one of them, emitting the needed events.
 A history query is just another type of suggestion that contains a query that the user has
@@ -26,8 +27,6 @@ made in the past.
 | <code>suggestion-content</code>        | History Query content               | **suggestion** <code>Suggestion</code> - History Query suggestion data<br />**index** <code>number</code> - History Query suggestion index<br />**queryHTML** <code>string</code> - Suggestion's query with the matching part inside a span tag |
 | <code>suggestion-remove-content</code> | History Query remove button content | **suggestion** <code>Suggestion</code> - History Query suggestion data<br />**index** <code>number</code> - History Query suggestion index                                                                                                      |
 
----
-
 # Examples
 
 This component renders a list of suggestions coming from the user queries history

package/docs/API-reference/components/history-queries/x-components.history-query.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.x-components.history-query
-title: History Query
-sidebar_label: History Query
+
+title: HistoryQuery
+
 ---
-# history-query
 
-> 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.
+# HistoryQuery
+
+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.
 
 ## Props
 
@@ -22,8 +23,6 @@ sidebar_label: History Query
 | <code>default</code>               | History Query content               | **suggestion** <code>Suggestion</code> - History Query suggestion data<br />**queryHTML** <code>string</code> - Suggestion's query with the matching part inside a span tag |
 | <code>remove-button-content</code> | History Query remove button content | **suggestion** <code>Suggestion</code> - History Query suggestion data                                                                                                      |
 
----
-
 # Examples
 
 ## Basic usage

package/docs/API-reference/components/history-queries/x-components.remove-history-query.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.x-components.remove-history-query
-title: Remove History Query
-sidebar_label: Remove History Query
+
+title: RemoveHistoryQuery
+
 ---
-# remove-history-query
 
-> Button that when it is pressed emits the
-> {@link HistoryQueriesXEvents.UserPressedRemoveHistoryQuery} event, expressing the user
-> intention to remove a query in the history.
+# RemoveHistoryQuery
+
+Button that when it is pressed emits the
+{@link HistoryQueriesXEvents.UserPressedRemoveHistoryQuery} event, expressing the user
+intention to remove a query in the history.
 
 ## Props
 
@@ -21,8 +22,6 @@ sidebar_label: Remove History Query
 | -------------------- | ------------------------------------------------------ | ----------------------------------------- |
 | <code>default</code> | (Required) Button content with a text, an icon or both | None                                      |
 
----
-
 # Examples
 
 ## Basic Example

package/docs/API-reference/components/identifier-results/x-components.identifier-result.md

@@ -1,12 +1,13 @@
 ---
-id: x-components.x-components.identifier-result
-title: Identifier Result
-sidebar_label: Identifier Result
+
+title: IdentifierResult
+
 ---
-# identifier-result
 
-> This component renders an identifier result value and highlights its matching part with the
-> query from the state. Receives as prop the {@link @empathyco/x-types#Result | result data}.
+# IdentifierResult
+
+This component renders an identifier result value and highlights its matching part with the
+query from the state. Receives as prop the {@link @empathyco/x-types#Result | result data}.
 
 ## Props
 
@@ -14,8 +15,6 @@ sidebar_label: Identifier Result
 | ------------------- | ----------------------------------------------------------------------- | ------------------- | ------------- |
 | <code>result</code> | (Required) The {@link @empathyco/x-types#Result \| result} information. | <code>Result</code> | <code></code> |
 
----
-
 # Examples
 
 This component renders an identifier result value and highlights its matching part with the query

package/docs/API-reference/components/identifier-results/x-components.identifier-results.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.x-components.identifier-results
-title: Identifier Results
-sidebar_label: Identifier Results
+
+title: IdentifierResults
+
 ---
-# identifier-results
 
-> Paints the list of identifier results stored in the state. Each identifier result should be
-> represented by a {@link IdentifierResult | identifier result component} besides any
-> other component.
+# IdentifierResults
+
+Paints the list of identifier results stored in the state. Each identifier result should be
+represented by a {@link IdentifierResult | identifier result component} besides any
+other component.
 
 ## Props
 
@@ -21,8 +22,6 @@ sidebar_label: Identifier Results
 | -------------------- | ------------------------------------------ | ----------------------------------------------------------------- |
 | <code>default</code> | (Required) Identifier results item content | **identifierResult** <code>Result</code> - Identifier Result data |
 
----
-
 # Examples
 
 ## Adding a IdentifierResult component within a BaseResultLink

package/docs/API-reference/components/next-queries/x-components.next-queries-list.md

@@ -1,12 +1,13 @@
 ---
-id: x-components.x-components.next-queries-list
-title: Next Queries List
-sidebar_label: Next Queries List
+
+title: NextQueriesList
+
 ---
-# next-queries-list
 
-> Component that inserts groups of next queries in different positions of the injected search
-> items list, based on the provided configuration.
+# NextQueriesList
+
+Component that inserts groups of next queries in different positions of the injected search
+items list, based on the provided configuration.
 
 ## Props
 
@@ -24,8 +25,6 @@ sidebar_label: Next Queries List
 | -------------------- | ------------------------- | ----------------------------------------- |
 | <code>default</code> | Next queries list layout. | <br />                                    |
 
----
-
 ## Events
 
 This component emits no events.

package/docs/API-reference/components/next-queries/x-components.next-queries.md

@@ -1,15 +1,16 @@
 ---
-id: x-components.x-components.next-queries
-title: Next Queries
-sidebar_label: Next Queries
+
+title: NextQueries
+
 ---
-# next-queries
 
-> Simple next-queries component that renders a list of suggestions, allowing the user to
-> select one of them, and emitting the needed events.
-> A next query is a suggestion for a new search, related to your previous query. I.e. If
-> people normally search for `shirts`, and then `trousers`, `trousers` would be a next query
-> of `shirts`.
+# NextQueries
+
+Simple next-queries component that renders a list of suggestions, allowing the user to
+select one of them, and emitting the needed events.
+A next query is a suggestion for a new search, related to your previous query. I.e. If
+people normally search for `shirts`, and then `trousers`, `trousers` would be a next query
+of `shirts`.
 
 ## Props
 
@@ -25,8 +26,6 @@ sidebar_label: Next Queries
 | <code>suggestion</code>         | Next Query item    | **suggestion** <code>Suggestion</code> - Next Query suggestion data<br />**index** <code>number</code> - Next Query suggestion index |
 | <code>suggestion-content</code> | Next Query content | **suggestion** <code>Suggestion</code> - Next Query suggestion data<br />**index** <code>number</code> - Next Query suggestion index |
 
----
-
 # Examples
 
 ## Basic example

package/docs/API-reference/components/next-queries/x-components.next-query.md

@@ -1,13 +1,14 @@
 ---
-id: x-components.x-components.next-query
-title: Next Query
-sidebar_label: Next Query
+
+title: NextQuery
+
 ---
-# next-query
 
-> Renders a next query item which receives the suggestion that will be rendered as a prop. It
-> exposes a default slot to change the next query content. If the slot is not overridden,
-> it will render the suggestion query by default.
+# NextQuery
+
+Renders a next query item which receives the suggestion that will be rendered as a prop. It
+exposes a default slot to change the next query content. If the slot is not overridden,
+it will render the suggestion query by default.
 
 ## Props
 
@@ -21,8 +22,6 @@ sidebar_label: Next Query
 | -------------------- | ------------------ | ------------------------------------------------------------------- |
 | <code>default</code> | Next Query content | **suggestion** <code>Suggestion</code> - Next Query suggestion data |
 
----
-
 # Examples
 
 This components expects just a suggestion as a prop to be rendered. It has a slot to override the