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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/docs/API-reference/api/x-components.snippetconfig.isspa.md +13 -0
  3. package/docs/API-reference/api/x-components.snippetconfig.md +1 -0
  4. package/docs/API-reference/components/common/animations/x-components.animate-width.md +5 -6
  5. package/docs/API-reference/components/common/animations/x-components.collapse-from-top.md +6 -7
  6. package/docs/API-reference/components/common/animations/x-components.collapse-height.md +7 -8
  7. package/docs/API-reference/components/common/animations/x-components.collapse-width.md +7 -8
  8. package/docs/API-reference/components/common/animations/x-components.cross-fade.md +6 -7
  9. package/docs/API-reference/components/common/animations/x-components.fade-and-slide.md +6 -7
  10. package/docs/API-reference/components/common/animations/x-components.staggered-fade-and-slide.md +7 -8
  11. package/docs/API-reference/components/common/animations/x-components.translate-from-left.md +6 -7
  12. package/docs/API-reference/components/common/animations/x-components.translate-from-right.md +6 -7
  13. package/docs/API-reference/components/common/column-picker/x-components.base-column-picker-dropdown.md +7 -8
  14. package/docs/API-reference/components/common/column-picker/x-components.base-column-picker-list.md +6 -7
  15. package/docs/API-reference/components/common/currency/x-components.base-currency.md +7 -8
  16. package/docs/API-reference/components/common/filters/labels/x-components.base-price-filter-label.md +7 -8
  17. package/docs/API-reference/components/common/filters/labels/x-components.base-rating-filter-label.md +7 -8
  18. package/docs/API-reference/components/common/icons/x-components.arrow.md +3 -4
  19. package/docs/API-reference/components/common/icons/x-components.bag.md +3 -4
  20. package/docs/API-reference/components/common/icons/x-components.bar-code.md +4 -5
  21. package/docs/API-reference/components/common/icons/x-components.barcode-tiny.md +4 -5
  22. package/docs/API-reference/components/common/icons/x-components.cart.md +3 -4
  23. package/docs/API-reference/components/common/icons/x-components.check-tiny.md +4 -5
  24. package/docs/API-reference/components/common/icons/x-components.check.md +3 -4
  25. package/docs/API-reference/components/common/icons/x-components.checkbox-card-selected.md +4 -5
  26. package/docs/API-reference/components/common/icons/x-components.checkbox-card-unselected.md +4 -5
  27. package/docs/API-reference/components/common/icons/x-components.checkbox-selected.md +4 -5
  28. package/docs/API-reference/components/common/icons/x-components.checkbox-unselected.md +4 -5
  29. package/docs/API-reference/components/common/icons/x-components.chevron-down.md +4 -5
  30. package/docs/API-reference/components/common/icons/x-components.chevron-left.md +4 -5
  31. package/docs/API-reference/components/common/icons/x-components.chevron-right.md +4 -5
  32. package/docs/API-reference/components/common/icons/x-components.chevron-tiny-down.md +4 -5
  33. package/docs/API-reference/components/common/icons/x-components.chevron-tiny-left.md +4 -5
  34. package/docs/API-reference/components/common/icons/x-components.chevron-tiny-right.md +4 -5
  35. package/docs/API-reference/components/common/icons/x-components.chevron-tiny-up.md +4 -5
  36. package/docs/API-reference/components/common/icons/x-components.chevron-up.md +4 -5
  37. package/docs/API-reference/components/common/icons/x-components.cross-tiny.md +4 -5
  38. package/docs/API-reference/components/common/icons/x-components.cross.md +3 -4
  39. package/docs/API-reference/components/common/icons/x-components.filters.md +3 -4
  40. package/docs/API-reference/components/common/icons/x-components.grid-1-col.md +4 -5
  41. package/docs/API-reference/components/common/icons/x-components.grid-2-col.md +4 -5
  42. package/docs/API-reference/components/common/icons/x-components.hide.md +3 -4
  43. package/docs/API-reference/components/common/icons/x-components.history-tiny.md +4 -5
  44. package/docs/API-reference/components/common/icons/x-components.history.md +3 -4
  45. package/docs/API-reference/components/common/icons/x-components.menu.md +3 -4
  46. package/docs/API-reference/components/common/icons/x-components.minus-tiny.md +4 -5
  47. package/docs/API-reference/components/common/icons/x-components.minus.md +3 -4
  48. package/docs/API-reference/components/common/icons/x-components.nq-1.md +4 -5
  49. package/docs/API-reference/components/common/icons/x-components.nq-2.md +4 -5
  50. package/docs/API-reference/components/common/icons/x-components.nq-3.md +4 -5
  51. package/docs/API-reference/components/common/icons/x-components.nq-4.md +4 -5
  52. package/docs/API-reference/components/common/icons/x-components.plus.md +3 -4
  53. package/docs/API-reference/components/common/icons/x-components.search-tiny.md +4 -5
  54. package/docs/API-reference/components/common/icons/x-components.search.md +3 -4
  55. package/docs/API-reference/components/common/icons/x-components.show.md +3 -4
  56. package/docs/API-reference/components/common/icons/x-components.star.md +3 -4
  57. package/docs/API-reference/components/common/icons/x-components.tag.md +3 -4
  58. package/docs/API-reference/components/common/icons/x-components.trash-open.md +4 -5
  59. package/docs/API-reference/components/common/icons/x-components.trash.md +3 -4
  60. package/docs/API-reference/components/common/icons/x-components.trending-tiny.md +4 -5
  61. package/docs/API-reference/components/common/icons/x-components.trending.md +3 -4
  62. package/docs/API-reference/components/common/icons/x-components.user.md +3 -4
  63. package/docs/API-reference/components/common/layouts/x-components.fixed-header-and-asides-layout.md +6 -7
  64. package/docs/API-reference/components/common/layouts/x-components.multi-column-max-width-layout.md +6 -7
  65. package/docs/API-reference/components/common/layouts/x-components.single-column-layout.md +6 -5
  66. package/docs/API-reference/components/common/modals/x-components.base-events-modal-close.md +7 -8
  67. package/docs/API-reference/components/common/modals/x-components.base-events-modal-open.md +7 -8
  68. package/docs/API-reference/components/common/modals/x-components.base-events-modal.md +12 -13
  69. package/docs/API-reference/components/common/modals/x-components.base-id-modal-close.md +7 -8
  70. package/docs/API-reference/components/common/modals/x-components.base-id-modal-open.md +7 -8
  71. package/docs/API-reference/components/common/modals/x-components.base-id-modal.md +9 -10
  72. package/docs/API-reference/components/common/modals/x-components.base-modal.md +6 -7
  73. package/docs/API-reference/components/common/panels/x-components.base-header-toggle-panel.md +7 -8
  74. package/docs/API-reference/components/common/panels/x-components.base-id-toggle-panel-button.md +8 -9
  75. package/docs/API-reference/components/common/panels/x-components.base-id-toggle-panel.md +8 -9
  76. package/docs/API-reference/components/common/panels/x-components.base-toggle-panel.md +6 -7
  77. package/docs/API-reference/components/common/result/x-components.base-result-add-to-cart.md +7 -8
  78. package/docs/API-reference/components/common/result/x-components.base-result-current-price.md +7 -8
  79. package/docs/API-reference/components/common/result/x-components.base-result-fallback-image.md +4 -5
  80. package/docs/API-reference/components/common/result/x-components.base-result-image.md +6 -7
  81. package/docs/API-reference/components/common/result/x-components.base-result-link.md +5 -6
  82. package/docs/API-reference/components/common/result/x-components.base-result-placeholder-image.md +4 -5
  83. package/docs/API-reference/components/common/result/x-components.base-result-previous-price.md +6 -7
  84. package/docs/API-reference/components/common/scroll/x-components.base-scroll.md +6 -7
  85. package/docs/API-reference/components/common/suggestions/x-components.base-suggestion.md +7 -8
  86. package/docs/API-reference/components/common/suggestions/x-components.base-suggestions.md +6 -7
  87. package/docs/API-reference/components/common/x-components.auto-progress-bar.md +5 -6
  88. package/docs/API-reference/components/common/x-components.base-dropdown.md +7 -8
  89. package/docs/API-reference/components/common/x-components.base-event-button.md +9 -10
  90. package/docs/API-reference/components/common/x-components.base-grid.md +11 -12
  91. package/docs/API-reference/components/common/x-components.base-keyboard-navigation.md +6 -7
  92. package/docs/API-reference/components/common/x-components.base-rating.md +7 -8
  93. package/docs/API-reference/components/common/x-components.base-variable-column-grid.md +9 -10
  94. package/docs/API-reference/components/common/x-components.global-x-bus.md +6 -7
  95. package/docs/API-reference/components/common/x-components.items-list.md +6 -5
  96. package/docs/API-reference/components/common/x-components.location-provider.md +6 -7
  97. package/docs/API-reference/components/common/x-components.sliding-panel.md +6 -7
  98. package/docs/API-reference/components/common/x-components.snippet-callbacks.md +6 -7
  99. package/docs/API-reference/components/common/x-components.staggering-transition-group.md +6 -7
  100. package/docs/API-reference/components/device/x-components.device-detector.md +8 -9
  101. package/docs/API-reference/components/empathize/x-components.empathize.md +6 -7
  102. package/docs/API-reference/components/extra-params/x-components.extra-params.md +7 -8
  103. package/docs/API-reference/components/extra-params/x-components.renderless-extra-param.md +7 -8
  104. package/docs/API-reference/components/extra-params/x-components.snippet-config-extra-params.md +6 -7
  105. package/docs/API-reference/components/facets/x-components.clear-filters.md +6 -7
  106. package/docs/API-reference/components/facets/x-components.facets/facets-provider.md +9 -10
  107. package/docs/API-reference/components/facets/x-components.facets/facets.md +6 -7
  108. package/docs/API-reference/components/facets/x-components.filters/all-filter.md +10 -11
  109. package/docs/API-reference/components/facets/x-components.filters/base-filter.md +8 -9
  110. package/docs/API-reference/components/facets/x-components.filters/editable-number-range-filter.md +7 -8
  111. package/docs/API-reference/components/facets/x-components.filters/hierarchical-filter.md +5 -6
  112. package/docs/API-reference/components/facets/x-components.filters/number-range-filter.md +6 -7
  113. package/docs/API-reference/components/facets/x-components.filters/renderless-filter.md +9 -10
  114. package/docs/API-reference/components/facets/x-components.filters/simple-filter.md +6 -7
  115. package/docs/API-reference/components/facets/x-components.lists/exclude-filters-with-no-results.md +8 -9
  116. package/docs/API-reference/components/facets/x-components.lists/filters-list.md +8 -9
  117. package/docs/API-reference/components/facets/x-components.lists/filters-search.md +6 -7
  118. package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md +7 -8
  119. package/docs/API-reference/components/facets/x-components.lists/selected-filters.md +7 -8
  120. package/docs/API-reference/components/facets/x-components.lists/sliced-filters.md +8 -9
  121. package/docs/API-reference/components/facets/x-components.lists/sorted-filters.md +6 -7
  122. package/docs/API-reference/components/history-queries/x-components.clear-history-queries.md +8 -9
  123. package/docs/API-reference/components/history-queries/x-components.history-queries.md +6 -7
  124. package/docs/API-reference/components/history-queries/x-components.history-query.md +8 -9
  125. package/docs/API-reference/components/history-queries/x-components.remove-history-query.md +8 -9
  126. package/docs/API-reference/components/identifier-results/x-components.identifier-result.md +7 -8
  127. package/docs/API-reference/components/identifier-results/x-components.identifier-results.md +8 -9
  128. package/docs/API-reference/components/next-queries/x-components.next-queries-list.md +7 -8
  129. package/docs/API-reference/components/next-queries/x-components.next-queries.md +10 -11
  130. package/docs/API-reference/components/next-queries/x-components.next-query.md +8 -9
  131. package/docs/API-reference/components/popular-searches/x-components.popular-search.md +8 -9
  132. package/docs/API-reference/components/popular-searches/x-components.popular-searches.md +9 -10
  133. package/docs/API-reference/components/query-suggestions/x-components.query-suggestion.md +8 -9
  134. package/docs/API-reference/components/query-suggestions/x-components.query-suggestions.md +8 -9
  135. package/docs/API-reference/components/recommendations/x-components.recommendations.md +10 -11
  136. package/docs/API-reference/components/related-tags/x-components.related-tag.md +8 -9
  137. package/docs/API-reference/components/related-tags/x-components.related-tags.md +10 -11
  138. package/docs/API-reference/components/scroll/x-components.main-scroll-item.md +7 -8
  139. package/docs/API-reference/components/scroll/x-components.main-scroll.md +7 -8
  140. package/docs/API-reference/components/scroll/x-components.scroll-to-top.md +7 -8
  141. package/docs/API-reference/components/scroll/x-components.scroll.md +7 -8
  142. package/docs/API-reference/components/scroll/x-components.window-scroll.md +8 -9
  143. package/docs/API-reference/components/search/x-components.banner.md +8 -9
  144. package/docs/API-reference/components/search/x-components.banners-list.md +7 -8
  145. package/docs/API-reference/components/search/x-components.partial-query-button.md +8 -9
  146. package/docs/API-reference/components/search/x-components.partial-results-list.md +7 -8
  147. package/docs/API-reference/components/search/x-components.promoted.md +7 -8
  148. package/docs/API-reference/components/search/x-components.promoteds-list.md +7 -8
  149. package/docs/API-reference/components/search/x-components.redirection.md +7 -8
  150. package/docs/API-reference/components/search/x-components.results-list.md +7 -8
  151. package/docs/API-reference/components/search/x-components.sort-dropdown.md +7 -8
  152. package/docs/API-reference/components/search/x-components.sort-list.md +7 -8
  153. package/docs/API-reference/components/search/x-components.spellcheck-button.md +8 -9
  154. package/docs/API-reference/components/search/x-components.spellcheck.md +8 -9
  155. package/docs/API-reference/components/search-box/x-components.clear-search-input.md +6 -7
  156. package/docs/API-reference/components/search-box/x-components.search-button.md +6 -7
  157. package/docs/API-reference/components/search-box/x-components.search-input.md +7 -8
  158. package/docs/API-reference/components/tagging/x-components.tagging.md +7 -8
  159. package/docs/API-reference/components/url/x-components.url-handler.md +7 -8
  160. package/docs/build-search-ui/README.md +0 -5
  161. package/docs/build-search-ui/web-archetype-integration-guide.md +0 -5
  162. package/docs/build-search-ui/web-use-x-components-guide.md +0 -5
  163. package/docs/build-search-ui/web-x-components-integration-guide.md +0 -5
  164. package/docs/build-search-ui/x-architecture/README.md +0 -5
  165. package/js/x-modules/identifier-results/store/actions/fetch-and-save-identifier-results.action.js +4 -2
  166. package/js/x-modules/identifier-results/store/actions/fetch-and-save-identifier-results.action.js.map +1 -1
  167. package/js/x-modules/identifier-results/store/getters/identifier-results-request.getter.js +2 -3
  168. package/js/x-modules/identifier-results/store/getters/identifier-results-request.getter.js.map +1 -1
  169. package/js/x-modules/identifier-results/wiring.js +2 -1
  170. package/js/x-modules/identifier-results/wiring.js.map +1 -1
  171. package/js/x-modules/search/store/actions/fetch-and-save-search-response.action.js +4 -1
  172. package/js/x-modules/search/store/actions/fetch-and-save-search-response.action.js.map +1 -1
  173. package/js/x-modules/search/store/getters/request.getter.js +2 -3
  174. package/js/x-modules/search/store/getters/request.getter.js.map +1 -1
  175. package/js/x-modules/search/wiring.js +2 -1
  176. package/js/x-modules/search/wiring.js.map +1 -1
  177. package/js/x-modules/search-box/components/search-input.vue.js +2 -2
  178. package/js/x-modules/search-box/components/search-input.vue.js.map +1 -1
  179. package/js/x-modules/search-box/components/search-input.vue_rollup-plugin-vue=script.js +7 -5
  180. package/js/x-modules/search-box/components/search-input.vue_rollup-plugin-vue=script.js.map +1 -1
  181. package/js/x-modules/url/components/url-handler.vue.js +1 -1
  182. package/js/x-modules/url/components/url-handler.vue.js.map +1 -1
  183. package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue=script.js +101 -5
  184. package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue=script.js.map +1 -1
  185. package/package.json +2 -2
  186. package/report/x-components.api.json +26 -0
  187. package/report/x-components.api.md +17 -0
  188. package/types/x-installer/api/api.types.d.ts +2 -0
  189. package/types/x-installer/api/api.types.d.ts.map +1 -1
  190. package/types/x-modules/identifier-results/store/actions/fetch-and-save-identifier-results.action.d.ts.map +1 -1
  191. package/types/x-modules/identifier-results/store/getters/identifier-results-request.getter.d.ts.map +1 -1
  192. package/types/x-modules/identifier-results/wiring.d.ts +1 -0
  193. package/types/x-modules/identifier-results/wiring.d.ts.map +1 -1
  194. package/types/x-modules/search/store/actions/fetch-and-save-search-response.action.d.ts.map +1 -1
  195. package/types/x-modules/search/store/getters/request.getter.d.ts.map +1 -1
  196. package/types/x-modules/search/wiring.d.ts +1 -0
  197. package/types/x-modules/search/wiring.d.ts.map +1 -1
  198. package/types/x-modules/search-box/components/search-input.vue.d.ts +5 -2
  199. package/types/x-modules/search-box/components/search-input.vue.d.ts.map +1 -1
  200. package/types/x-modules/url/components/url-handler.vue.d.ts +70 -7
  201. package/types/x-modules/url/components/url-handler.vue.d.ts.map +1 -1
  202. package/docs/sidebar.json +0 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,31 @@
3
3
  All notable changes to this project will be documented in this file. See
4
4
  [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.0.0-alpha.34](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.33...@empathyco/x-components@3.0.0-alpha.34) (2021-12-03)
7
+
8
+ ### Features
9
+
10
+ - **search-box:** focus search input after clicking clear search button
11
+ ([d28994c](https://github.com/empathyco/x/commit/d28994c1995834a1adb19798060051089200d7f7)),
12
+ closes [EX-2242](https://searchbroker.atlassian.net/browse/EX-2242)
13
+ - **tagging:** move `origin` from `request.getter` to `fetchAndSave.action`
14
+ ([b0bb40d](https://github.com/empathyco/x/commit/b0bb40de5e2ae7f65e2e2df032a1da9a51f0cb4d)),
15
+ closes [EX-5079](https://searchbroker.atlassian.net/browse/EX-5079)
16
+ - **url:** set `origin` when navigating
17
+ ([02aa766](https://github.com/empathyco/x/commit/02aa7661a15c3718f4809d094a01b0f684a1f55d)),
18
+ closes [EX-3541](https://searchbroker.atlassian.net/browse/EX-3541)
19
+
20
+ ### Documentation
21
+
22
+ - Remove docusaurus headers
23
+ ([6252165](https://github.com/empathyco/x/commit/62521658374eb5c78112314502606e2d82113a95)),
24
+ closes [EX-5081](https://searchbroker.atlassian.net/browse/EX-5081)
25
+
26
+ # Change Log
27
+
28
+ All notable changes to this project will be documented in this file. See
29
+ [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
30
+
6
31
  ## [3.0.0-alpha.33](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.32...@empathyco/x-components@3.0.0-alpha.33) (2021-11-30)
7
32
 
8
33
  ### Features
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SnippetConfig](./x-components.snippetconfig.md) &gt; [isSpa](./x-components.snippetconfig.isspa.md)
4
+
5
+ ## SnippetConfig.isSpa property
6
+
7
+ Flag determining if the page is a single page application or not.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ isSpa?: boolean;
13
+ ```
@@ -22,6 +22,7 @@ export interface SnippetConfig
22
22
  | [documentDirection?](./x-components.snippetconfig.documentdirection.md) | [DocumentDirection](./x-components.documentdirection.md) | <i>(Optional)</i> Document direction. |
23
23
  | [env?](./x-components.snippetconfig.env.md) | 'live' \| 'staging' | <i>(Optional)</i> Backend services environment. |
24
24
  | [instance](./x-components.snippetconfig.instance.md) | string | Customer instance. |
25
+ | [isSpa?](./x-components.snippetconfig.isspa.md) | boolean | <i>(Optional)</i> Flag determining if the page is a single page application or not. |
25
26
  | [lang](./x-components.snippetconfig.lang.md) | string | Language to display. |
26
27
  | [scope](./x-components.snippetconfig.scope.md) | string | Execution scope (desktop, mobile, app, ...). |
27
28
  | [searchLang?](./x-components.snippetconfig.searchlang.md) | string | <i>(Optional)</i> Language to send to backend services. |
@@ -1,11 +1,12 @@
1
1
  ---
2
- id: x-components.x-components.animate-width
3
- title: Animate Width
4
- sidebar_label: Animate Width
2
+
3
+ title: AnimateWidth
4
+
5
5
  ---
6
+
6
7
  # AnimateWidth
7
8
 
8
- > Renders a transition wrapping an element passed in the default slot and animating its width.
9
+ Renders a transition wrapping an element passed in the default slot and animating its width.
9
10
 
10
11
  ## Slots
11
12
 
@@ -13,8 +14,6 @@ sidebar_label: Animate Width
13
14
  | -------------------- | ----------------------------- | ----------------------------------------- |
14
15
  | <code>default</code> | (Required) Transition content | None |
15
16
 
16
- ---
17
-
18
17
  # Examples
19
18
 
20
19
  The AnimateWidth component is intended to be used as a prop in animatable components but also works
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.collapse-from-top
3
- title: Collapse From Top
4
- sidebar_label: Collapse From Top
2
+
3
+ title: CollapseFromTop
4
+
5
5
  ---
6
+
6
7
  # CollapseFromTop
7
8
 
8
- > Renders a transition group wrapping the element passed in the default slot and animating
9
- > it with a scale.
9
+ Renders a transition group wrapping the element passed in the default slot and animating
10
+ it with a scale.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Collapse From Top
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Examples
20
19
 
21
20
  The CollapseTop component is intended to be used as animation to wrap an element with v-if or v-show
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.collapse-height
3
- title: Collapse Height
4
- sidebar_label: Collapse Height
2
+
3
+ title: CollapseHeight
4
+
5
5
  ---
6
- # collapse-height
7
6
 
8
- > Renders a transition wrapping the element passed in the default slot and animating
9
- > it with a height animation.
7
+ # CollapseHeight
8
+
9
+ Renders a transition wrapping the element passed in the default slot and animating
10
+ it with a height animation.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Collapse Height
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Examples
20
19
 
21
20
  The CollapseHeight component is intended to be used as animation to wrap an element with v-if or
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.collapse-width
3
- title: Collapse Width
4
- sidebar_label: Collapse Width
2
+
3
+ title: CollapseWidth
4
+
5
5
  ---
6
- # collapse-width
7
6
 
8
- > Renders a transition wrapping the element passed in the default slot and animating
9
- > it with a width animation.
7
+ # CollapseWidth
8
+
9
+ Renders a transition wrapping the element passed in the default slot and animating
10
+ it with a width animation.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Collapse Width
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Examples
20
19
 
21
20
  The CollapseWidth component is intended to be used as animation to wrap an element with v-if or
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.cross-fade
3
- title: Cross Fade
4
- sidebar_label: Cross Fade
2
+
3
+ title: CrossFade
4
+
5
5
  ---
6
+
6
7
  # CrossFade
7
8
 
8
- > Renders a transition wrapping the element passed in the default slo. The transition
9
- > fades between the two toggled elements at the same time.
9
+ Renders a transition wrapping the element passed in the default slo. The transition
10
+ fades between the two toggled elements at the same time.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Cross Fade
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Example
20
19
 
21
20
  The `CrossFade` component is intended to be used as animation to wrap an element with v-if or v-show
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.fade-and-slide
3
- title: Fade And Slide
4
- sidebar_label: Fade And Slide
2
+
3
+ title: FadeAndSlide
4
+
5
5
  ---
6
+
6
7
  # FadeAndSlide
7
8
 
8
- > Renders a transition group wrapping the elements passed in the default slot and animating
9
- > them with a fade and slide animation.
9
+ Renders a transition group wrapping the elements passed in the default slot and animating
10
+ them with a fade and slide animation.
10
11
 
11
12
  ## Props
12
13
 
@@ -20,8 +21,6 @@ sidebar_label: Fade And Slide
20
21
  | -------------------- | ----------------------------------- | ----------------------------------------- |
21
22
  | <code>default</code> | (Required) Transition-group content | None |
22
23
 
23
- ---
24
-
25
24
  # Examples
26
25
 
27
26
  The FadeAndSlide component is intended to be used as a prop in animatable components but also works
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.staggered-fade-and-slide
3
- title: Staggered Fade And Slide
4
- sidebar_label: Staggered Fade And Slide
2
+
3
+ title: StaggeredFadeAndSlide
4
+
5
5
  ---
6
- # staggered-fade-and-slide
7
6
 
8
- > Renders a transition group wrapping the elements passed in the default slot and animating
9
- > them with an staggered fade and slide animation.
7
+ # StaggeredFadeAndSlide
8
+
9
+ Renders a transition group wrapping the elements passed in the default slot and animating
10
+ them with an staggered fade and slide animation.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Staggered Fade And Slide
14
15
  | -------------------- | ----------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) Transition-group content | None |
16
17
 
17
- ---
18
-
19
18
  The Staggered fade and slide components works as the normal fade and slide components, but it also
20
19
  adds a configurable delay to each transition.
21
20
 
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.translate-from-left
3
- title: Translate From Left
4
- sidebar_label: Translate From Left
2
+
3
+ title: TranslateFromLeft
4
+
5
5
  ---
6
+
6
7
  # TranslateFromLeft
7
8
 
8
- > Renders a transition wrapping the element passed in the default slot and moving it to its
9
- > desired position.
9
+ Renders a transition wrapping the element passed in the default slot and moving it to its
10
+ desired position.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Translate From Left
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Example
20
19
 
21
20
  The `TranslateFromRight` component is intended to be used as animation to wrap an element with v-if
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.translate-from-right
3
- title: Translate From Right
4
- sidebar_label: Translate From Right
2
+
3
+ title: TranslateFromRight
4
+
5
5
  ---
6
+
6
7
  # TranslateFromRight
7
8
 
8
- > Renders a transition wrapping the element passed in the default slot and moving it to its
9
- > desired position.
9
+ Renders a transition wrapping the element passed in the default slot and moving it to its
10
+ desired position.
10
11
 
11
12
  ## Slots
12
13
 
@@ -14,8 +15,6 @@ sidebar_label: Translate From Right
14
15
  | -------------------- | ------------------------------------------- | ----------------------------------------- |
15
16
  | <code>default</code> | (Required) to add content to the transition | None |
16
17
 
17
- ---
18
-
19
18
  # Example
20
19
 
21
20
  The `TranslateFromRight` component is intended to be used as animation to wrap an element with v-if
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.base-column-picker-dropdown
3
- title: Base Column Picker Dropdown
4
- sidebar_label: Base Column Picker Dropdown
2
+
3
+ title: BaseColumnPickerDropdown
4
+
5
5
  ---
6
- # base-column-picker-dropdown
7
6
 
8
- > Column picker dropdown component renders {@link BaseDropdown | dropdown} component which
9
- > options are the different columns you can set for a grid.
7
+ # BaseColumnPickerDropdown
8
+
9
+ Column picker dropdown component renders {@link BaseDropdown | dropdown} component which
10
+ options are the different columns you can set for a grid.
10
11
 
11
12
  It emits {@link XEventsTypes.UserClickedColumnPicker | UserClickedColumnPicker} on dropdown
12
13
  input.
@@ -32,8 +33,6 @@ input.
32
33
  | <code>toggle</code> | From `BaseDropdown` component: Used to render the contents of the dropdown toggle<br /> button. If not provided, it uses the `item` slot as fallback. | **item** <code>string &#124; number &#124; Identifiable</code> - The item data to render.<br />**isOpen** <code>boolean</code> - True if the dropdown is opened, and false if it is<br /> closed. |
33
34
  | <code>item</code> | (required) From `BaseDropdown` component: Used to render each one of the items<br /> content, and as fallback for the toggle button content slot if it is not provided. | **item** <code>string &#124; number &#124; Identifiable</code> - Item to render<br />**isSelected** <code>boolean</code> - True when the item is selected.<br />**isHighlighted** <code>boolean</code> - True when the item has the focus. |
34
35
 
35
- ---
36
-
37
36
  # Example
38
37
 
39
38
  Column picker dropdown component renders a dropdown component which options are the different
@@ -1,11 +1,12 @@
1
1
  ---
2
- id: x-components.x-components.base-column-picker-list
3
- title: Base Column Picker List
4
- sidebar_label: Base Column Picker List
2
+
3
+ title: BaseColumnPickerList
4
+
5
5
  ---
6
- # base-column-picker-list
7
6
 
8
- > Column picker list component renders a list of buttons to choose the columns number.
7
+ # BaseColumnPickerList
8
+
9
+ Column picker list component renders a list of buttons to choose the columns number.
9
10
 
10
11
  ## Props
11
12
 
@@ -26,8 +27,6 @@ sidebar_label: Base Column Picker List
26
27
  | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
27
28
  | <code>default</code> | Customized Column Picker Button content. Specifying a slot with the column value<br /> will result in the column using that slot composition to render. | **column** <code>number</code> - Columns Number to pick.<br />**isSelected** <code>boolean</code> - True if the columns number are the chosen value. |
28
29
 
29
- ---
30
-
31
30
  # Examples
32
31
 
33
32
  This component renders a list of elements in different slots depending on the columns prop. Each
@@ -1,13 +1,14 @@
1
1
  ---
2
- id: x-components.x-components.base-currency
3
- title: Base Currency
4
- sidebar_label: Base Currency
2
+
3
+ title: BaseCurrency
4
+
5
5
  ---
6
+
6
7
  # BaseCurrency
7
8
 
8
- > Renders the value received as a property which always must be a JavaScript number, with the
9
- > proper format provided as a string property or by injection. The rendered tag is a span in
10
- > order to render a default inline HTML element.
9
+ Renders the value received as a property which always must be a JavaScript number, with the
10
+ proper format provided as a string property or by injection. The rendered tag is a span in
11
+ order to render a default inline HTML element.
11
12
 
12
13
  Regarding the format or mask to be defined as string:
13
14
 
@@ -40,8 +41,6 @@ See docs below for more examples.
40
41
  | <code>value</code> | Numeric value to be formatted. | <code>number</code> | <code></code> |
41
42
  | <code>format</code> | The format as string. | <code>string</code> | <code></code> |
42
43
 
43
- ---
44
-
45
44
  # Example
46
45
 
47
46
  Renders the value received as a property, which always must be a JavaScript number, with the proper
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.base-price-filter-label
3
- title: Base Price Filter Label
4
- sidebar_label: Base Price Filter Label
2
+
3
+ title: BasePriceFilterLabel
4
+
5
5
  ---
6
- # base-price-filter-label
7
6
 
8
- > Renders a label for a price filter, allowing to select different messages depending on the
9
- > value of the filter.
7
+ # BasePriceFilterLabel
8
+
9
+ Renders a label for a price filter, allowing to select different messages depending on the
10
+ value of the filter.
10
11
 
11
12
  ## Props
12
13
 
@@ -18,8 +19,6 @@ sidebar_label: Base Price Filter Label
18
19
  | <code>fromTo</code> | Message shown when the filter has both the min and max values defined. | <code>string</code> | <code></code> |
19
20
  | <code>from</code> | Message shown when the filter hasn't got max value defined. | <code>string</code> | <code></code> |
20
21
 
21
- ---
22
-
23
22
  # Example
24
23
 
25
24
  Renders a label for a price filter, allowing to select different messages depending on the value of
@@ -1,12 +1,13 @@
1
1
  ---
2
- id: x-components.x-components.base-rating-filter-label
3
- title: Base Rating Filter Label
4
- sidebar_label: Base Rating Filter Label
2
+
3
+ title: BaseRatingFilterLabel
4
+
5
5
  ---
6
- # base-rating-filter-label
7
6
 
8
- > Renders a label for a rating filter, allowing to override the elements used to paint
9
- > the rating.
7
+ # BaseRatingFilterLabel
8
+
9
+ Renders a label for a rating filter, allowing to override the elements used to paint
10
+ the rating.
10
11
 
11
12
  ## Props
12
13
 
@@ -22,8 +23,6 @@ sidebar_label: Base Rating Filter Label
22
23
  | <code>rating-icon-filled</code> | Filled icon content | None |
23
24
  | <code>rating-icon-empty</code> | Empty icon content | None |
24
25
 
25
- ---
26
-
27
26
  # Example
28
27
 
29
28
  Renders a label for a rating filter, allowing to override the elements used to paint the rating. The
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.arrow
2
+
3
3
  title: Arrow
4
- sidebar_label: Arrow
4
+
5
5
  ---
6
- # arrow
7
6
 
8
- > functional
7
+ # Arrow
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.bag
2
+
3
3
  title: Bag
4
- sidebar_label: Bag
4
+
5
5
  ---
6
- # bag
7
6
 
8
- > functional
7
+ # Bag
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.bar-code
3
- title: Bar Code
4
- sidebar_label: Bar Code
2
+
3
+ title: BarCode
4
+
5
5
  ---
6
- # bar-code
7
6
 
8
- > functional
7
+ # BarCode
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.barcode-tiny
3
- title: Barcode Tiny
4
- sidebar_label: Barcode Tiny
2
+
3
+ title: BarcodeTiny
4
+
5
5
  ---
6
- # barcode-tiny
7
6
 
8
- > functional
7
+ # BarcodeTiny
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.cart
2
+
3
3
  title: Cart
4
- sidebar_label: Cart
4
+
5
5
  ---
6
- # cart
7
6
 
8
- > functional
7
+ # Cart
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.check-tiny
3
- title: Check Tiny
4
- sidebar_label: Check Tiny
2
+
3
+ title: CheckTiny
4
+
5
5
  ---
6
- # check-tiny
7
6
 
8
- > functional
7
+ # CheckTiny
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.check
2
+
3
3
  title: Check
4
- sidebar_label: Check
4
+
5
5
  ---
6
- # check
7
6
 
8
- > functional
7
+ # Check
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.checkbox-card-selected
3
- title: Checkbox Card Selected
4
- sidebar_label: Checkbox Card Selected
2
+
3
+ title: CheckboxCardSelected
4
+
5
5
  ---
6
- # checkbox-card-selected
7
6
 
8
- > functional
7
+ # CheckboxCardSelected
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.checkbox-card-unselected
3
- title: Checkbox Card Unselected
4
- sidebar_label: Checkbox Card Unselected
2
+
3
+ title: CheckboxCardUnselected
4
+
5
5
  ---
6
- # checkbox-card-unselected
7
6
 
8
- > functional
7
+ # CheckboxCardUnselected
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.checkbox-selected
3
- title: Checkbox Selected
4
- sidebar_label: Checkbox Selected
2
+
3
+ title: CheckboxSelected
4
+
5
5
  ---
6
- # checkbox-selected
7
6
 
8
- > functional
7
+ # CheckboxSelected
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.checkbox-unselected
3
- title: Checkbox Unselected
4
- sidebar_label: Checkbox Unselected
2
+
3
+ title: CheckboxUnselected
4
+
5
5
  ---
6
- # checkbox-unselected
7
6
 
8
- > functional
7
+ # CheckboxUnselected
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.chevron-down
3
- title: Chevron Down
4
- sidebar_label: Chevron Down
2
+
3
+ title: ChevronDown
4
+
5
5
  ---
6
- # chevron-down
7
6
 
8
- > functional
7
+ # ChevronDown
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.chevron-left
3
- title: Chevron Left
4
- sidebar_label: Chevron Left
2
+
3
+ title: ChevronLeft
4
+
5
5
  ---
6
- # chevron-left
7
6
 
8
- > functional
7
+ # ChevronLeft
@@ -1,8 +1,7 @@
1
1
  ---
2
- id: x-components.x-components.chevron-right
3
- title: Chevron Right
4
- sidebar_label: Chevron Right
2
+
3
+ title: ChevronRight
4
+
5
5
  ---
6
- # chevron-right
7
6
 
8
- > functional
7
+ # ChevronRight