@empathyco/x-components 3.0.0-alpha.76 → 3.0.0-alpha.77
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.
- package/CHANGELOG.md +13 -0
- package/core/index.js +0 -1
- package/core/index.js.map +1 -1
- package/design-system/default-theme.css +100 -100
- package/design-system/full-theme.css +14 -15
- package/docs/API-reference/api/x-components.actionstree.md +1 -1
- package/docs/API-reference/api/x-components.anyactionstree.md +1 -1
- package/docs/API-reference/api/x-components.anygetterstree.md +1 -1
- package/docs/API-reference/api/x-components.anymutationstree.md +1 -1
- package/docs/API-reference/api/x-components.compilemessage.md +1 -1
- package/docs/API-reference/api/x-components.extraparams.md +2 -2
- package/docs/API-reference/api/x-components.extraparamsmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.extraparamsstate.md +1 -1
- package/docs/API-reference/api/x-components.extraparamsxevents.md +4 -4
- package/docs/API-reference/api/x-components.getterstree.md +1 -1
- package/docs/API-reference/api/x-components.identifierresultsmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.identifierresultsstate.md +1 -1
- package/docs/API-reference/api/x-components.md +0 -8
- package/docs/API-reference/api/x-components.mutationstree.md +1 -1
- package/docs/API-reference/api/x-components.nextqueriesmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.nextqueriesstate.md +1 -1
- package/docs/API-reference/api/x-components.popularsearchesmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.popularsearchesstate.md +1 -1
- package/docs/API-reference/api/x-components.querysuggestionsmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.querysuggestionsstate.md +1 -1
- package/docs/API-reference/api/x-components.recommendationsmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.recommendationsstate.md +1 -1
- package/docs/API-reference/api/x-components.relatedtagsmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.relatedtagsstate.md +1 -1
- package/docs/API-reference/api/x-components.renderlessextraparams.md +1 -1
- package/docs/API-reference/api/x-components.returns.md +0 -2
- package/docs/API-reference/api/x-components.scrollstate.md +1 -1
- package/docs/API-reference/api/x-components.searchmutations.setparams.md +1 -1
- package/docs/API-reference/api/x-components.searchstate.md +2 -2
- package/docs/API-reference/api/x-components.setextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setidentifierresultsextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setinitialextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setnextqueriesextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setpopularsearchesextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setquerysuggestionsextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setrecommendationsextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setrelatedtagsextraparams.md +1 -1
- package/docs/API-reference/api/x-components.setsearchextraparams.md +1 -1
- package/docs/API-reference/api/x-components.simplestateselector.md +0 -2
- package/docs/API-reference/api/x-components.snippetconfigextraparams.md +1 -1
- package/docs/API-reference/api/x-components.urlhandler.md +1 -1
- package/docs/API-reference/api/x-components.urlmutations.setinitialextraparams.md +1 -1
- package/docs/API-reference/api/x-components.urlstate.md +1 -1
- package/docs/API-reference/api/x-components.urlxevents.extraparamsloadedfromurl.md +1 -1
- package/docs/API-reference/api/x-components.urlxevents.md +1 -1
- package/docs/API-reference/api/x-components.vuecssclasses.md +0 -2
- package/docs/API-reference/api/x-components.wiring.md +1 -1
- package/js/components/global-x-bus.vue.js.map +1 -1
- package/js/components/global-x-bus.vue_rollup-plugin-vue_script.vue.js +1 -1
- package/js/components/global-x-bus.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/snippet-callbacks.vue.js.map +1 -1
- package/js/components/snippet-callbacks.vue_rollup-plugin-vue_script.vue.js +1 -1
- package/js/components/snippet-callbacks.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/suggestions/base-suggestion.vue.js.map +1 -1
- package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js +1 -1
- package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/filters/compile-message.filter.js.map +1 -1
- package/js/index.js +0 -1
- package/js/index.js.map +1 -1
- package/js/plugins/x-emitters.js +1 -1
- package/js/plugins/x-emitters.js.map +1 -1
- package/js/plugins/x-plugin.js +1 -2
- package/js/plugins/x-plugin.js.map +1 -1
- package/js/store/utils/getters-proxy.utils.js +1 -1
- package/js/store/utils/getters-proxy.utils.js.map +1 -1
- package/js/store/utils/store-emitters.utils.js.map +1 -1
- package/js/x-installer/x-installer/x-installer.js +1 -1
- package/js/x-installer/x-installer/x-installer.js.map +1 -1
- package/js/x-modules/extra-params/components/extra-params.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/extra-params.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/renderless-extra-param.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/renderless-extra-param.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js +1 -2
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue.js +2 -2
- package/js/x-modules/facets/components/facets/facets.vue.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue_rollup-plugin-vue_script.vue.js +1 -1
- package/js/x-modules/facets/components/facets/facets.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/facets/store/getters/facets.getter.js +1 -1
- package/js/x-modules/facets/store/getters/facets.getter.js.map +1 -1
- package/js/x-modules/facets/store/getters/selected-filters-by-facet.getter.js +1 -1
- package/js/x-modules/facets/store/getters/selected-filters-by-facet.getter.js.map +1 -1
- package/js/x-modules/scroll/components/scroll-to-top.vue.js.map +1 -1
- package/js/x-modules/scroll/components/scroll-to-top.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/search/store/actions/reset-state.action.js +1 -1
- package/js/x-modules/search/store/actions/reset-state.action.js.map +1 -1
- package/js/x-modules/url/components/url-handler.vue.js.map +1 -1
- package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue_script.vue.js +1 -1
- package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/x-modules/url/store/getters/url-params.getter.js +1 -1
- package/js/x-modules/url/store/getters/url-params.getter.js.map +1 -1
- package/js/x-modules/url/store/mutations/set-params.mutation.js +1 -1
- package/js/x-modules/url/store/mutations/set-params.mutation.js.map +1 -1
- package/package.json +5 -5
- package/report/x-components.api.json +70 -744
- package/report/x-components.api.md +1 -24
- package/types/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/components/suggestions/base-suggestion.vue.d.ts.map +1 -1
- package/types/filters/compile-message.filter.d.ts +1 -1
- package/types/filters/compile-message.filter.d.ts.map +1 -1
- package/types/plugins/x-emitters.d.ts.map +1 -1
- package/types/plugins/x-plugin.d.ts.map +1 -1
- package/types/store/actions.types.d.ts +2 -1
- package/types/store/actions.types.d.ts.map +1 -1
- package/types/store/getters.types.d.ts +1 -1
- package/types/store/getters.types.d.ts.map +1 -1
- package/types/store/mutations.types.d.ts +1 -1
- package/types/store/mutations.types.d.ts.map +1 -1
- package/types/store/utils/getters-proxy.utils.d.ts.map +1 -1
- package/types/store/utils/store-emitters.utils.d.ts +2 -1
- package/types/store/utils/store-emitters.utils.d.ts.map +1 -1
- package/types/utils/index.d.ts +0 -1
- package/types/utils/index.d.ts.map +1 -1
- package/types/utils/types.d.ts +1 -9
- package/types/utils/types.d.ts.map +1 -1
- package/types/wiring/wiring.types.d.ts +2 -1
- package/types/wiring/wiring.types.d.ts.map +1 -1
- package/types/x-installer/x-installer/x-installer.d.ts.map +1 -1
- package/types/x-modules/extra-params/components/extra-params.vue.d.ts +1 -1
- package/types/x-modules/extra-params/components/extra-params.vue.d.ts.map +1 -1
- package/types/x-modules/extra-params/components/renderless-extra-param.vue.d.ts +1 -1
- package/types/x-modules/extra-params/components/renderless-extra-param.vue.d.ts.map +1 -1
- package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts +1 -1
- package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts.map +1 -1
- package/types/x-modules/extra-params/events.types.d.ts +1 -1
- package/types/x-modules/extra-params/events.types.d.ts.map +1 -1
- package/types/x-modules/extra-params/store/emitters.d.ts +1 -1
- package/types/x-modules/extra-params/store/types.d.ts +1 -1
- package/types/x-modules/extra-params/store/types.d.ts.map +1 -1
- package/types/x-modules/extra-params/wiring.d.ts +4 -4
- package/types/x-modules/extra-params/wiring.d.ts.map +1 -1
- package/types/x-modules/facets/components/facets/facets.vue.d.ts +1 -1
- package/types/x-modules/facets/components/facets/facets.vue.d.ts.map +1 -1
- package/types/x-modules/identifier-results/store/types.d.ts +1 -1
- package/types/x-modules/identifier-results/store/types.d.ts.map +1 -1
- package/types/x-modules/identifier-results/wiring.d.ts +2 -2
- package/types/x-modules/identifier-results/wiring.d.ts.map +1 -1
- package/types/x-modules/next-queries/store/types.d.ts +1 -1
- package/types/x-modules/next-queries/store/types.d.ts.map +1 -1
- package/types/x-modules/next-queries/wiring.d.ts +2 -2
- package/types/x-modules/next-queries/wiring.d.ts.map +1 -1
- package/types/x-modules/popular-searches/store/types.d.ts +1 -1
- package/types/x-modules/popular-searches/store/types.d.ts.map +1 -1
- package/types/x-modules/popular-searches/wiring.d.ts +2 -2
- package/types/x-modules/popular-searches/wiring.d.ts.map +1 -1
- package/types/x-modules/query-suggestions/store/types.d.ts +1 -1
- package/types/x-modules/query-suggestions/store/types.d.ts.map +1 -1
- package/types/x-modules/query-suggestions/wiring.d.ts +2 -2
- package/types/x-modules/query-suggestions/wiring.d.ts.map +1 -1
- package/types/x-modules/recommendations/store/types.d.ts +1 -1
- package/types/x-modules/recommendations/store/types.d.ts.map +1 -1
- package/types/x-modules/recommendations/wiring.d.ts +2 -2
- package/types/x-modules/recommendations/wiring.d.ts.map +1 -1
- package/types/x-modules/related-tags/store/types.d.ts +1 -1
- package/types/x-modules/related-tags/store/types.d.ts.map +1 -1
- package/types/x-modules/related-tags/wiring.d.ts +2 -2
- package/types/x-modules/related-tags/wiring.d.ts.map +1 -1
- package/types/x-modules/scroll/components/scroll-to-top.vue.d.ts +1 -1
- package/types/x-modules/scroll/components/scroll-to-top.vue.d.ts.map +1 -1
- package/types/x-modules/scroll/store/types.d.ts +1 -1
- package/types/x-modules/scroll/store/types.d.ts.map +1 -1
- package/types/x-modules/search/store/types.d.ts +1 -1
- package/types/x-modules/search/store/types.d.ts.map +1 -1
- package/types/x-modules/search/wiring.d.ts +2 -2
- package/types/x-modules/search/wiring.d.ts.map +1 -1
- package/types/x-modules/url/components/url-handler.vue.d.ts +1 -1
- package/types/x-modules/url/components/url-handler.vue.d.ts.map +1 -1
- package/types/x-modules/url/events.types.d.ts +3 -2
- package/types/x-modules/url/events.types.d.ts.map +1 -1
- package/types/x-modules/url/store/types.d.ts +1 -1
- package/types/x-modules/url/store/types.d.ts.map +1 -1
- package/types/x-modules/url/wiring.d.ts +2 -2
- package/types/x-modules/url/wiring.d.ts.map +1 -1
- package/docs/API-reference/api/x-components.cleanundefined.md +0 -26
- package/docs/API-reference/api/x-components.dictionary.md +0 -13
- package/docs/API-reference/api/x-components.every.md +0 -27
- package/docs/API-reference/api/x-components.foreach.md +0 -25
- package/docs/API-reference/api/x-components.getnewandupdatedkeys.md +0 -27
- package/docs/API-reference/api/x-components.map.md +0 -27
- package/docs/API-reference/api/x-components.objectfilter.md +0 -27
- package/docs/API-reference/api/x-components.reduce.md +0 -28
- package/js/utils/object.js +0 -115
- package/js/utils/object.js.map +0 -1
- package/types/utils/object.d.ts +0 -70
- package/types/utils/object.d.ts.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
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.77](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.76...@empathyco/x-components@3.0.0-alpha.77) (2022-04-01)
|
|
7
|
+
|
|
8
|
+
### Code Refactoring
|
|
9
|
+
|
|
10
|
+
- move `object` utils from `x-components` to `x-utils`
|
|
11
|
+
([512b350](https://github.com/empathyco/x/commit/512b350da4a3dd73ddbd78a7b2965a1e07735a8e)),
|
|
12
|
+
closes [EX-5793](https://searchbroker.atlassian.net/browse/EX-5793)
|
|
13
|
+
|
|
14
|
+
# Change Log
|
|
15
|
+
|
|
16
|
+
All notable changes to this project will be documented in this file. See
|
|
17
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
18
|
+
|
|
6
19
|
## [3.0.0-alpha.76](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.75...@empathyco/x-components@3.0.0-alpha.76) (2022-04-01)
|
|
7
20
|
|
|
8
21
|
### Code Refactoring
|
package/core/index.js
CHANGED
|
@@ -136,7 +136,6 @@ export { getURLParameter } from '../js/utils/get-url-parameters.js';
|
|
|
136
136
|
export { isElementEqualOrContained } from '../js/utils/html.js';
|
|
137
137
|
export { normalizeString } from '../js/utils/normalize.js';
|
|
138
138
|
export { isInRange } from '../js/utils/number.js';
|
|
139
|
-
export { cleanUndefined, every, forEach, getNewAndUpdatedKeys, map, objectFilter, reduce } from '../js/utils/object.js';
|
|
140
139
|
export { createOrigin } from '../js/utils/origin.js';
|
|
141
140
|
export { sanitize } from '../js/utils/sanitize.js';
|
|
142
141
|
export { localStorageService } from '../js/utils/storage.js';
|
package/core/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -2127,6 +2127,106 @@
|
|
|
2127
2127
|
--x-size-line-height-suggestion-group-default: var(--x-size-line-height-suggestion-default);
|
|
2128
2128
|
--x-number-font-weight-suggestion-group-default: var(--x-number-font-weight-suggestion-default);
|
|
2129
2129
|
}
|
|
2130
|
+
|
|
2131
|
+
[dir="ltr"] .x-suggestion-group {
|
|
2132
|
+
padding-left: var(--x-size-padding-left-suggestion-group-default);
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2135
|
+
[dir="rtl"] .x-suggestion-group {
|
|
2136
|
+
padding-right: var(--x-size-padding-left-suggestion-group-default);
|
|
2137
|
+
}
|
|
2138
|
+
|
|
2139
|
+
[dir="ltr"] .x-suggestion-group {
|
|
2140
|
+
padding-right: var(--x-size-padding-right-suggestion-group-default);
|
|
2141
|
+
}
|
|
2142
|
+
|
|
2143
|
+
[dir="rtl"] .x-suggestion-group {
|
|
2144
|
+
padding-left: var(--x-size-padding-right-suggestion-group-default);
|
|
2145
|
+
}
|
|
2146
|
+
|
|
2147
|
+
[dir="ltr"] .x-suggestion-group {
|
|
2148
|
+
border-left-width: var(--x-size-border-width-left-suggestion-group-default);
|
|
2149
|
+
}
|
|
2150
|
+
|
|
2151
|
+
[dir="rtl"] .x-suggestion-group {
|
|
2152
|
+
border-right-width: var(--x-size-border-width-left-suggestion-group-default);
|
|
2153
|
+
}
|
|
2154
|
+
|
|
2155
|
+
[dir="ltr"] .x-suggestion-group {
|
|
2156
|
+
border-right-width: var(--x-size-border-width-right-suggestion-group-default);
|
|
2157
|
+
}
|
|
2158
|
+
|
|
2159
|
+
[dir="rtl"] .x-suggestion-group {
|
|
2160
|
+
border-left-width: var(--x-size-border-width-right-suggestion-group-default);
|
|
2161
|
+
}
|
|
2162
|
+
|
|
2163
|
+
.x-suggestion-group {
|
|
2164
|
+
display: flex;
|
|
2165
|
+
flex-flow: row nowrap;
|
|
2166
|
+
box-sizing: border-box;
|
|
2167
|
+
background-color: var(--x-color-background-suggestion-group-default);
|
|
2168
|
+
color: var(--x-color-text-suggestion-group-default);
|
|
2169
|
+
border-color: var(--x-color-border-suggestion-group-default);
|
|
2170
|
+
font-family: var(--x-font-family-suggestion-group-default);
|
|
2171
|
+
font-size: var(--x-size-font-suggestion-group-default);
|
|
2172
|
+
line-height: var(--x-size-line-height-suggestion-group-default);
|
|
2173
|
+
font-weight: var(--x-number-font-weight-suggestion-group-default);
|
|
2174
|
+
cursor: pointer;
|
|
2175
|
+
padding-top: var(--x-size-padding-top-suggestion-group-default);
|
|
2176
|
+
padding-bottom: var(--x-size-padding-bottom-suggestion-group-default);
|
|
2177
|
+
gap: var(--x-size-gap-suggestion-group-default);
|
|
2178
|
+
border-style: solid;
|
|
2179
|
+
border-top-width: var(--x-size-border-width-top-suggestion-group-default);
|
|
2180
|
+
border-bottom-width: var(--x-size-border-width-bottom-suggestion-group-default);
|
|
2181
|
+
border-radius: var(--x-size-border-radius-top-left-suggestion-group-default) var(--x-size-border-radius-top-right-suggestion-group-default) var(--x-size-border-radius-bottom-right-suggestion-group-default) var(--x-size-border-radius-bottom-left-suggestion-group-default);
|
|
2182
|
+
}
|
|
2183
|
+
@media not all and (min-resolution: 0.001dpcm) {
|
|
2184
|
+
.x-suggestion-group {
|
|
2185
|
+
gap: 0;
|
|
2186
|
+
}
|
|
2187
|
+
.x-suggestion-group > *:not(:last-child) {
|
|
2188
|
+
margin-right: var(--x-size-gap-suggestion-group-default);
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
.x-suggestion-group .x-suggestion {
|
|
2192
|
+
padding: 0;
|
|
2193
|
+
flex: 1 1 auto;
|
|
2194
|
+
border: none;
|
|
2195
|
+
}
|
|
2196
|
+
.x-suggestion-group .x-button {
|
|
2197
|
+
--x-color-background-button-default: transparent;
|
|
2198
|
+
--x-color-border-button-default: transparent;
|
|
2199
|
+
--x-color-text-button-default: var(--x-color-text-suggestion-group-default);
|
|
2200
|
+
--x-size-height-button-default: var(--x-size-line-height-suggestion-group-default);
|
|
2201
|
+
--x-size-padding-right-button-default: 0;
|
|
2202
|
+
--x-size-padding-left-button-default: 0;
|
|
2203
|
+
border: none;
|
|
2204
|
+
}
|
|
2205
|
+
:root {
|
|
2206
|
+
--x-color-text-suggestion-group-default: var(--x-color-text-suggestion-default);
|
|
2207
|
+
--x-color-text-suggestion-group-matching-part-default: var(--x-color-text-suggestion-matching-part-default);
|
|
2208
|
+
--x-color-background-suggestion-group-default: var(--x-color-background-suggestion-default);
|
|
2209
|
+
--x-color-border-suggestion-group-default: var(--x-color-text-suggestion-group-default);
|
|
2210
|
+
--x-size-padding-top-suggestion-group-default: var(--x-size-padding-top-suggestion-default);
|
|
2211
|
+
--x-size-padding-right-suggestion-group-default: var(--x-size-padding-right-suggestion-default);
|
|
2212
|
+
--x-size-padding-bottom-suggestion-group-default: var(--x-size-padding-bottom-suggestion-default);
|
|
2213
|
+
--x-size-padding-left-suggestion-group-default: var(--x-size-padding-left-suggestion-default);
|
|
2214
|
+
--x-size-gap-suggestion-group-default: var(--x-size-gap-suggestion-default);
|
|
2215
|
+
--x-size-border-width-suggestion-group-default: 0;
|
|
2216
|
+
--x-size-border-width-top-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2217
|
+
--x-size-border-width-right-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2218
|
+
--x-size-border-width-bottom-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2219
|
+
--x-size-border-width-left-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2220
|
+
--x-size-border-radius-suggestion-group-default: var(--x-size-border-radius-base-none);
|
|
2221
|
+
--x-size-border-radius-top-left-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2222
|
+
--x-size-border-radius-top-right-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2223
|
+
--x-size-border-radius-bottom-right-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2224
|
+
--x-size-border-radius-bottom-left-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2225
|
+
--x-font-family-suggestion-group-default: var(--x-font-family-suggestion-default);
|
|
2226
|
+
--x-size-font-suggestion-group-default: var(--x-size-font-suggestion-default);
|
|
2227
|
+
--x-size-line-height-suggestion-group-default: var(--x-size-line-height-suggestion-default);
|
|
2228
|
+
--x-number-font-weight-suggestion-group-default: var(--x-number-font-weight-suggestion-default);
|
|
2229
|
+
}
|
|
2130
2230
|
:root {
|
|
2131
2231
|
--x-string-align-items-suggestion-default: center;
|
|
2132
2232
|
--x-color-text-suggestion-default: var(--x-color-text-default);
|
|
@@ -2802,104 +2902,4 @@
|
|
|
2802
2902
|
--x-size-line-height-base-s: 16px;
|
|
2803
2903
|
--x-size-line-height-base-m: 24px;
|
|
2804
2904
|
--x-size-line-height-base-l: 32px;
|
|
2805
|
-
}
|
|
2806
|
-
:root {
|
|
2807
|
-
--x-color-text-suggestion-group-default: var(--x-color-text-suggestion-default);
|
|
2808
|
-
--x-color-text-suggestion-group-matching-part-default: var(--x-color-text-suggestion-matching-part-default);
|
|
2809
|
-
--x-color-background-suggestion-group-default: var(--x-color-background-suggestion-default);
|
|
2810
|
-
--x-color-border-suggestion-group-default: var(--x-color-text-suggestion-group-default);
|
|
2811
|
-
--x-size-padding-top-suggestion-group-default: var(--x-size-padding-top-suggestion-default);
|
|
2812
|
-
--x-size-padding-right-suggestion-group-default: var(--x-size-padding-right-suggestion-default);
|
|
2813
|
-
--x-size-padding-bottom-suggestion-group-default: var(--x-size-padding-bottom-suggestion-default);
|
|
2814
|
-
--x-size-padding-left-suggestion-group-default: var(--x-size-padding-left-suggestion-default);
|
|
2815
|
-
--x-size-gap-suggestion-group-default: var(--x-size-gap-suggestion-default);
|
|
2816
|
-
--x-size-border-width-suggestion-group-default: 0;
|
|
2817
|
-
--x-size-border-width-top-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2818
|
-
--x-size-border-width-right-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2819
|
-
--x-size-border-width-bottom-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2820
|
-
--x-size-border-width-left-suggestion-group-default: var(--x-size-border-width-suggestion-default);
|
|
2821
|
-
--x-size-border-radius-suggestion-group-default: var(--x-size-border-radius-base-none);
|
|
2822
|
-
--x-size-border-radius-top-left-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2823
|
-
--x-size-border-radius-top-right-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2824
|
-
--x-size-border-radius-bottom-right-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2825
|
-
--x-size-border-radius-bottom-left-suggestion-group-default: var(--x-size-border-radius-suggestion-default);
|
|
2826
|
-
--x-font-family-suggestion-group-default: var(--x-font-family-suggestion-default);
|
|
2827
|
-
--x-size-font-suggestion-group-default: var(--x-size-font-suggestion-default);
|
|
2828
|
-
--x-size-line-height-suggestion-group-default: var(--x-size-line-height-suggestion-default);
|
|
2829
|
-
--x-number-font-weight-suggestion-group-default: var(--x-number-font-weight-suggestion-default);
|
|
2830
|
-
}
|
|
2831
|
-
|
|
2832
|
-
[dir="ltr"] .x-suggestion-group {
|
|
2833
|
-
padding-left: var(--x-size-padding-left-suggestion-group-default);
|
|
2834
|
-
}
|
|
2835
|
-
|
|
2836
|
-
[dir="rtl"] .x-suggestion-group {
|
|
2837
|
-
padding-right: var(--x-size-padding-left-suggestion-group-default);
|
|
2838
|
-
}
|
|
2839
|
-
|
|
2840
|
-
[dir="ltr"] .x-suggestion-group {
|
|
2841
|
-
padding-right: var(--x-size-padding-right-suggestion-group-default);
|
|
2842
|
-
}
|
|
2843
|
-
|
|
2844
|
-
[dir="rtl"] .x-suggestion-group {
|
|
2845
|
-
padding-left: var(--x-size-padding-right-suggestion-group-default);
|
|
2846
|
-
}
|
|
2847
|
-
|
|
2848
|
-
[dir="ltr"] .x-suggestion-group {
|
|
2849
|
-
border-left-width: var(--x-size-border-width-left-suggestion-group-default);
|
|
2850
|
-
}
|
|
2851
|
-
|
|
2852
|
-
[dir="rtl"] .x-suggestion-group {
|
|
2853
|
-
border-right-width: var(--x-size-border-width-left-suggestion-group-default);
|
|
2854
|
-
}
|
|
2855
|
-
|
|
2856
|
-
[dir="ltr"] .x-suggestion-group {
|
|
2857
|
-
border-right-width: var(--x-size-border-width-right-suggestion-group-default);
|
|
2858
|
-
}
|
|
2859
|
-
|
|
2860
|
-
[dir="rtl"] .x-suggestion-group {
|
|
2861
|
-
border-left-width: var(--x-size-border-width-right-suggestion-group-default);
|
|
2862
|
-
}
|
|
2863
|
-
|
|
2864
|
-
.x-suggestion-group {
|
|
2865
|
-
display: flex;
|
|
2866
|
-
flex-flow: row nowrap;
|
|
2867
|
-
box-sizing: border-box;
|
|
2868
|
-
background-color: var(--x-color-background-suggestion-group-default);
|
|
2869
|
-
color: var(--x-color-text-suggestion-group-default);
|
|
2870
|
-
border-color: var(--x-color-border-suggestion-group-default);
|
|
2871
|
-
font-family: var(--x-font-family-suggestion-group-default);
|
|
2872
|
-
font-size: var(--x-size-font-suggestion-group-default);
|
|
2873
|
-
line-height: var(--x-size-line-height-suggestion-group-default);
|
|
2874
|
-
font-weight: var(--x-number-font-weight-suggestion-group-default);
|
|
2875
|
-
cursor: pointer;
|
|
2876
|
-
padding-top: var(--x-size-padding-top-suggestion-group-default);
|
|
2877
|
-
padding-bottom: var(--x-size-padding-bottom-suggestion-group-default);
|
|
2878
|
-
gap: var(--x-size-gap-suggestion-group-default);
|
|
2879
|
-
border-style: solid;
|
|
2880
|
-
border-top-width: var(--x-size-border-width-top-suggestion-group-default);
|
|
2881
|
-
border-bottom-width: var(--x-size-border-width-bottom-suggestion-group-default);
|
|
2882
|
-
border-radius: var(--x-size-border-radius-top-left-suggestion-group-default) var(--x-size-border-radius-top-right-suggestion-group-default) var(--x-size-border-radius-bottom-right-suggestion-group-default) var(--x-size-border-radius-bottom-left-suggestion-group-default);
|
|
2883
|
-
}
|
|
2884
|
-
@media not all and (min-resolution: 0.001dpcm) {
|
|
2885
|
-
.x-suggestion-group {
|
|
2886
|
-
gap: 0;
|
|
2887
|
-
}
|
|
2888
|
-
.x-suggestion-group > *:not(:last-child) {
|
|
2889
|
-
margin-right: var(--x-size-gap-suggestion-group-default);
|
|
2890
|
-
}
|
|
2891
|
-
}
|
|
2892
|
-
.x-suggestion-group .x-suggestion {
|
|
2893
|
-
padding: 0;
|
|
2894
|
-
flex: 1 1 auto;
|
|
2895
|
-
border: none;
|
|
2896
|
-
}
|
|
2897
|
-
.x-suggestion-group .x-button {
|
|
2898
|
-
--x-color-background-button-default: transparent;
|
|
2899
|
-
--x-color-border-button-default: transparent;
|
|
2900
|
-
--x-color-text-button-default: var(--x-color-text-suggestion-group-default);
|
|
2901
|
-
--x-size-height-button-default: var(--x-size-line-height-suggestion-group-default);
|
|
2902
|
-
--x-size-padding-right-button-default: 0;
|
|
2903
|
-
--x-size-padding-left-button-default: 0;
|
|
2904
|
-
border: none;
|
|
2905
2905
|
}
|
|
@@ -218,6 +218,20 @@
|
|
|
218
218
|
--x-color-border-button-ghost: transparent;
|
|
219
219
|
--x-color-text-button-ghost: var(--x-color-base-lead);
|
|
220
220
|
}
|
|
221
|
+
.x-button--pill.x-button,
|
|
222
|
+
.x-button--pill .x-button {
|
|
223
|
+
--x-size-border-radius-button-default: var(--x-size-border-radius-button-pill);
|
|
224
|
+
--x-size-border-radius-top-left-button-default: var(--x-size-border-radius-top-left-button-pill);
|
|
225
|
+
--x-size-border-radius-top-right-button-default: var(
|
|
226
|
+
--x-size-border-radius-top-right-button-pill
|
|
227
|
+
);
|
|
228
|
+
--x-size-border-radius-bottom-right-button-default: var(
|
|
229
|
+
--x-size-border-radius-bottom-right-button-pill
|
|
230
|
+
);
|
|
231
|
+
--x-size-border-radius-bottom-left-button-default: var(
|
|
232
|
+
--x-size-border-radius-bottom-left-button-pill
|
|
233
|
+
);
|
|
234
|
+
}
|
|
221
235
|
:root {
|
|
222
236
|
--x-size-border-radius-button-pill: var(--x-size-border-radius-base-pill);
|
|
223
237
|
--x-size-border-radius-top-left-button-pill: var(--x-size-border-radius-button-pill);
|
|
@@ -7552,18 +7566,3 @@
|
|
|
7552
7566
|
.x-normal-case {
|
|
7553
7567
|
text-transform: none;
|
|
7554
7568
|
}
|
|
7555
|
-
|
|
7556
|
-
.x-button--pill.x-button,
|
|
7557
|
-
.x-button--pill .x-button {
|
|
7558
|
-
--x-size-border-radius-button-default: var(--x-size-border-radius-button-pill);
|
|
7559
|
-
--x-size-border-radius-top-left-button-default: var(--x-size-border-radius-top-left-button-pill);
|
|
7560
|
-
--x-size-border-radius-top-right-button-default: var(
|
|
7561
|
-
--x-size-border-radius-top-right-button-pill
|
|
7562
|
-
);
|
|
7563
|
-
--x-size-border-radius-bottom-right-button-default: var(
|
|
7564
|
-
--x-size-border-radius-bottom-right-button-pill
|
|
7565
|
-
);
|
|
7566
|
-
--x-size-border-radius-bottom-left-button-default: var(
|
|
7567
|
-
--x-size-border-radius-bottom-left-button-pill
|
|
7568
|
-
);
|
|
7569
|
-
}
|
|
@@ -13,5 +13,5 @@ export declare type ActionsTree<State extends Dictionary, Getters extends Dictio
|
|
|
13
13
|
[Key in keyof Actions]: (context: XActionContext<State, Getters, Mutations, Actions>, payload: ExtractPayload<Actions[Key]>) => ReturnType<Actions[Key]> | Promise<ReturnType<Actions[Key]>>;
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
|
-
<b>References:</b> [
|
|
16
|
+
<b>References:</b> [MutationsDictionary](./x-components.mutationsdictionary.md)<!-- -->, [ActionsDictionary](./x-components.actionsdictionary.md)<!-- -->, [XActionContext](./x-components.xactioncontext.md)<!-- -->, [ExtractPayload](./x-components.extractpayload.md)
|
|
17
17
|
|
|
@@ -11,5 +11,5 @@ Alias for any actions tree. Use only when you really don't care about the action
|
|
|
11
11
|
```typescript
|
|
12
12
|
export declare type AnyActionsTree = ActionsTree<Dictionary, Dictionary, MutationsDictionary<any>, ActionsDictionary<any>>;
|
|
13
13
|
```
|
|
14
|
-
<b>References:</b> [ActionsTree](./x-components.actionstree.md)<!-- -->, [
|
|
14
|
+
<b>References:</b> [ActionsTree](./x-components.actionstree.md)<!-- -->, [MutationsDictionary](./x-components.mutationsdictionary.md)<!-- -->, [ActionsDictionary](./x-components.actionsdictionary.md)
|
|
15
15
|
|
|
@@ -11,5 +11,5 @@ Alias for any getters tree. Use only when you don't care about the type.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export declare type AnyGettersTree = GettersTree<Dictionary, Dictionary>;
|
|
13
13
|
```
|
|
14
|
-
<b>References:</b> [GettersTree](./x-components.getterstree.md)
|
|
14
|
+
<b>References:</b> [GettersTree](./x-components.getterstree.md)
|
|
15
15
|
|
|
@@ -11,5 +11,5 @@ Alias for any mutations tree. Use only when the concrete type does not matter.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export declare type AnyMutationsTree = MutationsTree<Dictionary, MutationsDictionary<any>>;
|
|
13
13
|
```
|
|
14
|
-
<b>References:</b> [MutationsTree](./x-components.mutationstree.md)<!-- -->, [
|
|
14
|
+
<b>References:</b> [MutationsTree](./x-components.mutationstree.md)<!-- -->, [MutationsDictionary](./x-components.mutationsdictionary.md)
|
|
15
15
|
|
|
@@ -17,7 +17,7 @@ export declare function compileMessage(message: string, params: Dictionary<strin
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| message | string | String containing the keys to be replaced. |
|
|
20
|
-
| params |
|
|
20
|
+
| params | Dictionary<string \| number> | Dictionary of key-values that will be used to format compiledMessage. |
|
|
21
21
|
|
|
22
22
|
<b>Returns:</b>
|
|
23
23
|
|
|
@@ -17,8 +17,8 @@ export default class ExtraParams extends Vue
|
|
|
17
17
|
|
|
18
18
|
| Property | Modifiers | Type | Description |
|
|
19
19
|
| --- | --- | --- | --- |
|
|
20
|
-
| [storeExtraParams](./x-components.extraparams.storeextraparams.md) | |
|
|
21
|
-
| [values](./x-components.extraparams.values.md) | |
|
|
20
|
+
| [storeExtraParams](./x-components.extraparams.storeextraparams.md) | | Dictionary<unknown> | State extra params. Used to override the initial extra params. |
|
|
21
|
+
| [values](./x-components.extraparams.values.md) | | Dictionary<unknown> | (Required) A Dictionary where the keys are the extra param names and its values. |
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
@@ -14,7 +14,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| params |
|
|
17
|
+
| params | Dictionary<unknown> | |
|
|
18
18
|
|
|
19
19
|
<b>Returns:</b>
|
|
20
20
|
|
|
@@ -16,5 +16,5 @@ export interface ExtraParamsState
|
|
|
16
16
|
|
|
17
17
|
| Property | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| [params](./x-components.extraparamsstate.params.md) |
|
|
19
|
+
| [params](./x-components.extraparamsstate.params.md) | Dictionary<unknown> | |
|
|
20
20
|
|
|
@@ -16,8 +16,8 @@ export interface ExtraParamsXEvents
|
|
|
16
16
|
|
|
17
17
|
| Property | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| [ExtraParamsChanged](./x-components.extraparamsxevents.extraparamschanged.md) |
|
|
20
|
-
| [ExtraParamsInitialized](./x-components.extraparamsxevents.extraparamsinitialized.md) |
|
|
21
|
-
| [ExtraParamsProvided](./x-components.extraparamsxevents.extraparamsprovided.md) |
|
|
22
|
-
| [UserChangedExtraParams](./x-components.extraparamsxevents.userchangedextraparams.md) |
|
|
19
|
+
| [ExtraParamsChanged](./x-components.extraparamsxevents.extraparamschanged.md) | Dictionary<unknown> | The Extra Params have been changed. \* Payload: The new extra params dictionary. |
|
|
20
|
+
| [ExtraParamsInitialized](./x-components.extraparamsxevents.extraparamsinitialized.md) | Dictionary<unknown> | The Initial Extra Params have been loaded into the state. \* Payload: The new extra params dictionary. |
|
|
21
|
+
| [ExtraParamsProvided](./x-components.extraparamsxevents.extraparamsprovided.md) | Dictionary<unknown> | The Extra Params have been provided. \* Payload: The new extra params dictionary. |
|
|
22
|
+
| [UserChangedExtraParams](./x-components.extraparamsxevents.userchangedextraparams.md) | Dictionary<unknown> | The user changed the extra params. \* Payload: The new extra params dictionary. |
|
|
23
23
|
|
|
@@ -13,5 +13,5 @@ export declare type GettersTree<State extends Dictionary, Getters extends Dictio
|
|
|
13
13
|
[Key in keyof Getters]: (state: State, getters: Getters, rootState: RootXStoreState, rootGetters: any) => Getters[Key];
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
|
-
<b>References:</b> [
|
|
16
|
+
<b>References:</b> [RootXStoreState](./x-components.rootxstorestate.md)
|
|
17
17
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -20,6 +20,6 @@ export interface IdentifierResultsState extends StatusState, QueryState
|
|
|
20
20
|
| [config](./x-components.identifierresultsstate.config.md) | [IdentifierResultsConfig](./x-components.identifierresultsconfig.md) | The configuration of the identifier results module. |
|
|
21
21
|
| [identifierResults](./x-components.identifierresultsstate.identifierresults.md) | Result\[\] | The list of the identifier results, related to the <code>query</code> property of the state. |
|
|
22
22
|
| [origin](./x-components.identifierresultsstate.origin.md) | [QueryOrigin](./x-components.queryorigin.md) \| null | The origin property of the request. |
|
|
23
|
-
| [params](./x-components.identifierresultsstate.params.md) |
|
|
23
|
+
| [params](./x-components.identifierresultsstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
24
24
|
| [query](./x-components.identifierresultsstate.query.md) | string | The internal query of the module. Used to request the identifier results. |
|
|
25
25
|
|
|
@@ -143,7 +143,6 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
143
143
|
| [arrayToObject(array)](./x-components.arraytoobject.md) | Reduce an array of strings to an object which properties names are the value of each string, and the value under that property are also the string. |
|
|
144
144
|
| [arrayToObject(array, key)](./x-components.arraytoobject_1.md) | Reduce an array of objects to an object which properties names are the value of each object\[key\], and the value under that property are each object. 'key' is the the parameter passed to this function. |
|
|
145
145
|
| [capitalize(str)](./x-components.capitalize.md) | Util to capitalize a string . |
|
|
146
|
-
| [cleanUndefined(obj)](./x-components.cleanundefined.md) | Creates an object picking only the not undefined properties. |
|
|
147
146
|
| [clone(something)](./x-components.clone.md) | Deeply clones an object or an array. |
|
|
148
147
|
| [compileMessage(message, params)](./x-components.compilemessage.md) | Replaces each key in compiledMessage for the provided key's value. |
|
|
149
148
|
| [createCollapseAnimationMixin(property)](./x-components.createcollapseanimationmixin.md) | Adds parametrized methods to a component to allow the collapsing of the provided property. |
|
|
@@ -157,14 +156,11 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
157
156
|
| [Debounce(debounceTimeInMs, debounceOptions)](./x-components.debounce.md) | Adds debounce to the method that the decorator is applied to. |
|
|
158
157
|
| [deepFilter(array, condition, childrenKey)](./x-components.deepfilter.md) | Filters an array with all elements that pass the test implemented by the given filter function. If an item has another list of items in the <code>childrenKey</code> property it recursively filters that new list, adding it to the returned one. |
|
|
159
158
|
| [deepFlat(array, childrenKey)](./x-components.deepflat.md) | Flat an <code>Item[]</code> deeply using the given <code>childrenKey</code> to access to his children. |
|
|
160
|
-
| [every(object, condition)](./x-components.every.md) | Ensures that the given condition is met in all the non-undefined entries of the object. |
|
|
161
159
|
| [filter(wire, filterFn)](./x-components.filter.md) | Creates a [Wire](./x-components.wire.md) that is only executed whenever the condition in the filterFn is true. |
|
|
162
160
|
| [filterBlacklistedModules(wire, blacklist)](./x-components.filterblacklistedmodules.md) | Creates a [Wire](./x-components.wire.md) that is only executed if the event is emitted from a [XModule](./x-components.xmodule.md) that is NOT included in the <code>blacklist</code> array passed as parameter. |
|
|
163
161
|
| [filterFalsyPayload(wire)](./x-components.filterfalsypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is truthy. A truthy value is whatever is not a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
|
|
164
162
|
| [filterTruthyPayload(wire)](./x-components.filtertruthypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
|
|
165
163
|
| [filterWhitelistedModules(wire, whitelist)](./x-components.filterwhitelistedmodules.md) | Creates a [Wire](./x-components.wire.md) that is only executed if the event is emitted from a [XModule](./x-components.xmodule.md) that is included in the <code>whitelist</code> array passed as parameter. |
|
|
166
|
-
| [forEach(obj, callbackFn)](./x-components.foreach.md) | Iterates over every non-undefined property of the object calling the callback passed as parameter. |
|
|
167
|
-
| [getNewAndUpdatedKeys(newValue, oldValue)](./x-components.getnewandupdatedkeys.md) | Compares two objects of the same type, checking the values of their keys and retrieving those that were not present in the old value and/or those whose value has changed. |
|
|
168
164
|
| [getRootXComponent(component)](./x-components.getrootxcomponent.md) | Given a component, finds the root XComponent in the ancestors hierarchy. |
|
|
169
165
|
| [getStateAndGettersFromModule(state, getters, moduleName)](./x-components.getstateandgettersfrommodule.md) | Returns an object with the getters and state of a module of store defined by the moduleName parameter. |
|
|
170
166
|
| [Getter(module, getter)](./x-components.getter.md) | Generates a computed property which returns the selected getter value.<!-- -->The decorated property needs to be public for type inference to work. |
|
|
@@ -175,7 +171,6 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
175
171
|
| [isNewQuery(newQuery, previousQuery)](./x-components.isnewquery.md) | Compares two queries to know if the new one is a refined query from the previous one or a new one.<!-- -->A refined query is a query which has the previous query or part of it. Example: - previousQuery = 'lego star'. - newQuery = 'lego star wars'.<!-- -->Example: - previousQuery = 'lego star wars'. - newQuery = 'lego star'.<!-- -->A new query is a query which has not the previous query. Example: - previousQuery = 'lego star'. - newQuery = 'lego wars'.<!-- -->In this case, it is changing the word set, because a word is changed by another one, so this is changing the search intention. |
|
|
176
172
|
| [isStringEmpty(str)](./x-components.isstringempty.md) | Util used to return true if the string is empty, undefined or null. |
|
|
177
173
|
| [isXComponent(component)](./x-components.isxcomponent.md) | Returns if the component is an X-Component. An X-Component is a component that has an [XModule](./x-components.xmodule.md) associated to it. |
|
|
178
|
-
| [map(obj, mapper)](./x-components.map.md) | Creates an object from another object transforming each property value. |
|
|
179
174
|
| [mapWire(toWire, mapFn)](./x-components.mapwire.md) | Creates a [Wire](./x-components.wire.md) from other <code>toWire</code> wire. It uses <code>mapFn</code> to transform the <code>FromPayload</code> received to <code>ToPayload</code> which <code>toWire</code> requires. This is useful to reuse wires in different Events where the payload doesn't fit exactly. |
|
|
180
175
|
| [namespacedDebounce(moduleName)](./x-components.namespaceddebounce.md) | Type safe debounce operator which creates a function which can only access the Module of the [Vuex](https://vuex.vuejs.org/) Store passed as parameter. |
|
|
181
176
|
| [namespacedThrottle(moduleName)](./x-components.namespacedthrottle.md) | Type safe throttle operator which creates a function which can only access the Module of the [Vuex](https://vuex.vuejs.org/) Store passed as parameter. |
|
|
@@ -184,8 +179,6 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
184
179
|
| [namespacedWireDispatch(moduleName)](./x-components.namespacedwiredispatch.md) | Creates a namespaced [wireDispatch()](./x-components.wiredispatch.md) for the module name passed. |
|
|
185
180
|
| [namespacedWireDispatchWithoutPayload(moduleName)](./x-components.namespacedwiredispatchwithoutpayload.md) | Creates a namespaced [wireDispatchWithoutPayload()](./x-components.wiredispatchwithoutpayload.md) for the module name passed. |
|
|
186
181
|
| [normalizeString(string)](./x-components.normalizestring.md) | Trims the string, transforms it to lower case, and removes [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks) from it. |
|
|
187
|
-
| [objectFilter(obj, isIncluded)](./x-components.objectfilter.md) | Creates an object picking only the ones that pass the test implemented by the provided function isIncluded. |
|
|
188
|
-
| [reduce(obj, reducer, initialValue)](./x-components.reduce.md) | Iterates through the obj properties calling the reducer function. |
|
|
189
182
|
| [setStatus(state, status)](./x-components.setstatus.md) | Sets the request status. Can be used as a mutation. |
|
|
190
183
|
| [State(module, path)](./x-components.state.md) | Generates a computed property which returns the selected state.<!-- -->The decorated property needs to be public for type inference to work. |
|
|
191
184
|
| [throttle(wire, timeInMs, options)](./x-components.throttle.md) | Creates a throttled [Wire](./x-components.wire.md)<!-- -->. Being throttled means that it will only be executed once every couple of milliseconds given by the <code>timeInMs</code> parameter. |
|
|
@@ -585,7 +578,6 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
585
578
|
| [DeepPartial](./x-components.deeppartial.md) | Makes all the properties of the T type optional in depth. |
|
|
586
579
|
| [DeviceXModule](./x-components.devicexmodule.md) | Device [XModule](./x-components.xmodule.md) alias. |
|
|
587
580
|
| [DeviceXStoreModule](./x-components.devicexstoremodule.md) | Device type safe store module. |
|
|
588
|
-
| [Dictionary](./x-components.dictionary.md) | Object where all its properties are strings, and the value of them is defined by the type of the T property. |
|
|
589
581
|
| [DocumentDirection](./x-components.documentdirection.md) | The HTML document direction orientation. Possible values: ltr (left to right) or rtl (right to left). |
|
|
590
582
|
| [Emitter](./x-components.emitter.md) | Type safe for emitter payload. It is the wire payload. |
|
|
591
583
|
| [Emitters](./x-components.emitters.md) | Type safe emitters dictionary, where each key is the [XEvent](./x-components.xevent.md) name, and the value is a [https://rxjs.dev/api/index/class/Subject](https://rxjs.dev/api/index/class/Subject) of the [XEventPayload](./x-components.xeventpayload.md) type. |
|
|
@@ -13,5 +13,5 @@ export declare type MutationsTree<State extends Dictionary, Mutations extends Mu
|
|
|
13
13
|
[Key in keyof Mutations]: (state: State, payload: ExtractPayload<Mutations[Key]>) => void;
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
|
-
<b>References:</b> [
|
|
16
|
+
<b>References:</b> [MutationsDictionary](./x-components.mutationsdictionary.md)<!-- -->, [ExtractPayload](./x-components.extractpayload.md)
|
|
17
17
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -19,7 +19,7 @@ export interface NextQueriesState extends StatusState, QueryState
|
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| [config](./x-components.nextqueriesstate.config.md) | [NextQueriesConfig](./x-components.nextqueriesconfig.md) | Configuration options of the next queries module. |
|
|
21
21
|
| [nextQueries](./x-components.nextqueriesstate.nextqueries.md) | NextQuery\[\] | The list of the next queries, related to the <code>query</code> property of the state. |
|
|
22
|
-
| [params](./x-components.nextqueriesstate.params.md) |
|
|
22
|
+
| [params](./x-components.nextqueriesstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
23
23
|
| [query](./x-components.nextqueriesstate.query.md) | string | The internal query of the module. Used to request the next queries. |
|
|
24
24
|
| [searchedQueries](./x-components.nextqueriesstate.searchedqueries.md) | HistoryQuery\[\] | The list of the searched queries, related to the <code>query</code> property of the state. |
|
|
25
25
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ export interface PopularSearchesState extends StatusState
|
|
|
18
18
|
| Property | Type | Description |
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| [config](./x-components.popularsearchesstate.config.md) | [PopularSearchesConfig](./x-components.popularsearchesconfig.md) | The popular searches module configuration. |
|
|
21
|
-
| [params](./x-components.popularsearchesstate.params.md) |
|
|
21
|
+
| [params](./x-components.popularsearchesstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
22
22
|
| [popularSearches](./x-components.popularsearchesstate.popularsearches.md) | Suggestion\[\] | The suggestions list. These suggestions represent the most searched queries. |
|
|
23
23
|
| [searchedQueries](./x-components.popularsearchesstate.searchedqueries.md) | HistoryQuery\[\] | The list of the searched queries, related to the <code>query</code> property of the state. |
|
|
24
24
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ export interface QuerySuggestionsState extends StatusState, QueryState
|
|
|
18
18
|
| Property | Type | Description |
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| [config](./x-components.querysuggestionsstate.config.md) | [QuerySuggestionsConfig](./x-components.querysuggestionsconfig.md) | The configuration of the query suggestions module. |
|
|
21
|
-
| [params](./x-components.querysuggestionsstate.params.md) |
|
|
21
|
+
| [params](./x-components.querysuggestionsstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
22
22
|
| [query](./x-components.querysuggestionsstate.query.md) | string | The query of the query suggestions module. Used to request the suggestions. |
|
|
23
23
|
| [suggestions](./x-components.querysuggestionsstate.suggestions.md) | Suggestion\[\] | The suggestions for the query of the state. |
|
|
24
24
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -19,6 +19,6 @@ export interface RecommendationsState extends StatusState
|
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| [config](./x-components.recommendationsstate.config.md) | [RecommendationsConfig](./x-components.recommendationsconfig.md) | Configuration for the <code>Recommendations</code> module. |
|
|
21
21
|
| [origin](./x-components.recommendationsstate.origin.md) | string | Param to be sent on the recommendations request. |
|
|
22
|
-
| [params](./x-components.recommendationsstate.params.md) |
|
|
22
|
+
| [params](./x-components.recommendationsstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
23
23
|
| [recommendations](./x-components.recommendationsstate.recommendations.md) | Result\[\] | The recommendations of the module. |
|
|
24
24
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ export interface RelatedTagsState extends StatusState, QueryState
|
|
|
18
18
|
| Property | Type | Description |
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| [config](./x-components.relatedtagsstate.config.md) | [RelatedTagsConfig](./x-components.relatedtagsconfig.md) | The configuration of the related tags module. |
|
|
21
|
-
| [params](./x-components.relatedtagsstate.params.md) |
|
|
21
|
+
| [params](./x-components.relatedtagsstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
|
|
22
22
|
| [relatedTags](./x-components.relatedtagsstate.relatedtags.md) | RelatedTag\[\] | The list of the related tags, related to the <code>query</code> property of the state. |
|
|
23
23
|
| [selectedRelatedTags](./x-components.relatedtagsstate.selectedrelatedtags.md) | RelatedTag\[\] | The list of the selected related tags. |
|
|
24
24
|
|
|
@@ -18,5 +18,5 @@ export default class RenderlessExtraParam extends Vue
|
|
|
18
18
|
| Property | Modifiers | Type | Description |
|
|
19
19
|
| --- | --- | --- | --- |
|
|
20
20
|
| [name](./x-components.renderlessextraparams.name.md) | | string | The extra param's name. |
|
|
21
|
-
| [stateParams](./x-components.renderlessextraparams.stateparams.md) | |
|
|
21
|
+
| [stateParams](./x-components.renderlessextraparams.stateparams.md) | | Dictionary<unknown> | A dictionary with the extra params in the store state. |
|
|
22
22
|
|
|
@@ -16,6 +16,6 @@ export interface ScrollState
|
|
|
16
16
|
|
|
17
17
|
| Property | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| [data](./x-components.scrollstate.data.md) |
|
|
19
|
+
| [data](./x-components.scrollstate.data.md) | Dictionary<[ScrollComponentState](./x-components.scrollcomponentstate.md)<!-- -->> | State data of the scroll components. |
|
|
20
20
|
| [pendingScrollTo](./x-components.scrollstate.pendingscrollto.md) | string | The <code>[data-scroll]</code> value of the pending to restore scroll. |
|
|
21
21
|
|
|
@@ -16,7 +16,7 @@ setParams(params: Dictionary<unknown>): void;
|
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| params |
|
|
19
|
+
| params | Dictionary<unknown> | The new extra params. |
|
|
20
20
|
|
|
21
21
|
<b>Returns:</b>
|
|
22
22
|
|