@empathyco/x-components 6.0.0-alpha.203 → 6.0.0-alpha.204
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 +11 -0
- package/docs/API-reference/api/x-components.addquerytohistory.md +15 -1
- package/docs/API-reference/api/x-components.addquerytohistoryaction.addquerytohistory.md +15 -1
- package/docs/API-reference/api/x-components.addquerytohistoryaction.md +1 -1
- package/docs/API-reference/api/x-components.basedropdown.md +1 -1
- package/docs/API-reference/api/x-components.baseidmodal.md +1 -1
- package/docs/API-reference/api/x-components.baseresultimage.md +1 -1
- package/docs/API-reference/api/x-components.collapseheight.md +3 -3
- package/docs/API-reference/api/x-components.collapsewidth.md +3 -3
- package/docs/API-reference/api/x-components.createfetchandsaveactions.md +15 -1
- package/docs/API-reference/api/x-components.createrelatedtagsquerygetter.md +15 -1
- package/docs/API-reference/api/x-components.debouncefunction.md +17 -1
- package/docs/API-reference/api/x-components.defaultfacetsservice.clearfilterswithmetadata.md +17 -1
- package/docs/API-reference/api/x-components.defaultfacetsservice.md +1 -1
- package/docs/API-reference/api/x-components.historyqueriesgetter.historyqueries.md +15 -1
- package/docs/API-reference/api/x-components.historyqueriesgetter.md +1 -1
- package/docs/API-reference/api/x-components.isinrange.md +15 -1
- package/docs/API-reference/api/x-components.md +10 -10
- package/docs/API-reference/api/x-components.querysuggestionsgetter.md +1 -1
- package/docs/API-reference/api/x-components.querysuggestionsgetter.querysuggestions.md +15 -1
- package/docs/API-reference/api/x-components.usecollapseanimation.md +4 -4
- package/docs/API-reference/api/x-components.useemitdisplayevent.md +15 -1
- package/docs/API-reference/api/x-components.useondisplay.md +15 -1
- package/docs/API-reference/api/x-components.usescroll.md +15 -1
- package/docs/API-reference/api/x-types.suggestion.key.md +1 -1
- package/docs/API-reference/api/x-types.suggestion.md +4 -4
- package/js/components/animations/animate-scale/animate-scale.style.css.js +1 -1
- package/js/components/animations/use-collapse-animation.js +9 -0
- package/js/components/animations/use-collapse-animation.js.map +1 -1
- package/js/components/base-dropdown.vue.js +3 -3
- package/js/components/base-dropdown.vue.js.map +1 -1
- package/js/components/base-dropdown.vue2.js +6 -4
- package/js/components/base-dropdown.vue2.js.map +1 -1
- package/js/components/base-grid.vue.js.map +1 -1
- package/js/components/base-grid.vue2.js.map +1 -1
- package/js/components/base-rating.vue3.js +1 -1
- package/js/components/column-picker/base-column-picker-list.vue.js.map +1 -1
- package/js/components/column-picker/base-column-picker-list.vue2.js.map +1 -1
- package/js/components/modals/base-id-modal.vue.js +1 -1
- package/js/components/modals/base-id-modal.vue.js.map +1 -1
- package/js/components/modals/base-id-modal.vue2.js +3 -3
- package/js/components/modals/base-id-modal.vue2.js.map +1 -1
- package/js/components/panels/base-tabs-panel.vue.js +1 -1
- package/js/components/panels/base-tabs-panel.vue.js.map +1 -1
- package/js/components/panels/base-tabs-panel.vue2.js.map +1 -1
- package/js/components/result/base-result-current-price.vue.js +4 -3
- package/js/components/result/base-result-current-price.vue.js.map +1 -1
- package/js/components/result/base-result-current-price.vue2.js.map +1 -1
- package/js/components/result/base-result-image.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue2.js +2 -1
- package/js/components/result/base-result-image.vue2.js.map +1 -1
- package/js/components/result/base-result-previous-price.vue.js +1 -1
- package/js/components/result/base-result-previous-price.vue.js.map +1 -1
- package/js/components/result/base-result-previous-price.vue2.js.map +1 -1
- package/js/components/sliding-panel.vue3.js +1 -1
- package/js/x-modules/facets/components/facets/facets.vue.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue2.js.map +1 -1
- package/js/x-modules/facets/components/filters/editable-number-range-filter.vue.js +2 -2
- package/js/x-modules/facets/components/filters/editable-number-range-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/editable-number-range-filter.vue2.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue.js +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue2.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue3.js +1 -1
- package/js/x-modules/facets/components/lists/selected-filters-list.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js.map +1 -1
- package/js/x-modules/related-prompts/components/related-prompts-tag-list.vue.js.map +1 -1
- package/js/x-modules/related-prompts/components/related-prompts-tag-list.vue2.js.map +1 -1
- package/js/x-modules/search/components/sort-picker-list.vue.js.map +1 -1
- package/js/x-modules/search/components/sort-picker-list.vue2.js.map +1 -1
- package/package.json +17 -17
- package/report/tsdoc-metadata.json +1 -1
- package/report/x-adapter-platform.api.json +1 -1
- package/report/x-components.api.json +161 -67
- package/report/x-components.api.md +46 -45
- package/report/x-types.api.json +4 -4
- package/types/components/animations/collapse-height.vue.d.ts +3 -3
- package/types/components/animations/collapse-width.vue.d.ts +3 -3
- package/types/components/animations/use-collapse-animation.d.ts +3 -3
- package/types/components/animations/use-collapse-animation.d.ts.map +1 -1
- package/types/components/base-dropdown.vue.d.ts +1 -1
- package/types/components/base-dropdown.vue.d.ts.map +1 -1
- package/types/components/base-grid.types.d.ts +11 -0
- package/types/components/base-grid.types.d.ts.map +1 -0
- package/types/components/base-grid.vue.d.ts +2 -10
- package/types/components/base-grid.vue.d.ts.map +1 -1
- package/types/components/column-picker/base-column-picker-list.types.d.ts +9 -0
- package/types/components/column-picker/base-column-picker-list.types.d.ts.map +1 -0
- package/types/components/column-picker/base-column-picker-list.vue.d.ts +1 -8
- package/types/components/column-picker/base-column-picker-list.vue.d.ts.map +1 -1
- package/types/components/modals/base-id-modal.vue.d.ts +1 -1
- package/types/components/result/base-result-image.vue.d.ts +1 -1
- package/types/components/result/base-result-image.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/facets/facets.types.d.ts +12 -0
- package/types/x-modules/facets/components/facets/facets.types.d.ts.map +1 -0
- package/types/x-modules/facets/components/facets/facets.vue.d.ts +1 -10
- package/types/x-modules/facets/components/facets/facets.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/lists/selected-filters-list.types.d.ts +11 -0
- package/types/x-modules/facets/components/lists/selected-filters-list.types.d.ts.map +1 -0
- package/types/x-modules/facets/components/lists/selected-filters-list.vue.d.ts +1 -9
- package/types/x-modules/facets/components/lists/selected-filters-list.vue.d.ts.map +1 -1
- package/types/x-modules/search/components/sort-picker-list.types.d.ts +12 -0
- package/types/x-modules/search/components/sort-picker-list.types.d.ts.map +1 -0
- package/types/x-modules/search/components/sort-picker-list.vue.d.ts +1 -10
- package/types/x-modules/search/components/sort-picker-list.vue.d.ts.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## 6.0.0-alpha.204 (2026-02-25)
|
|
7
|
+
|
|
8
|
+
* chore(deps): update all non-major dependencies (#1976) ([1a54734](https://github.com/empathyco/x/commit/1a54734)), closes [#1976](https://github.com/empathyco/x/issues/1976)
|
|
9
|
+
* chore(deps): update vue version to 3.5.28 ([c023c00](https://github.com/empathyco/x/commit/c023c00))
|
|
10
|
+
* refactor: fix type issues ([74216e4](https://github.com/empathyco/x/commit/74216e4))
|
|
11
|
+
* build(tsconfig): fix libs and add skipLibCheck option ([c1db14a](https://github.com/empathyco/x/commit/c1db14a))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
## 6.0.0-alpha.203 (2026-02-24)
|
|
7
18
|
|
|
8
19
|
* refactor: remove sass ([1557098](https://github.com/empathyco/x/commit/1557098))
|
|
@@ -9,7 +9,7 @@ Default implementation for the [HistoryQueriesActions.addQueryToHistory](./x-com
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
addQueryToHistory: (
|
|
12
|
+
addQueryToHistory: (input: HistoryQueriesActionContext, query: string) => void | Promise<void>
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ state, dispatch }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[HistoryQueriesActionContext](./x-components.historyqueriesactioncontext.md)
|
|
@@ -9,7 +9,7 @@ Default implementation for the [HistoryQueriesActions.addQueryToHistory](./x-com
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
addQueryToHistory(
|
|
12
|
+
addQueryToHistory(input: HistoryQueriesActionContext, query: string): void | Promise<void>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ state, dispatch }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[HistoryQueriesActionContext](./x-components.historyqueriesactioncontext.md)
|
|
@@ -33,7 +33,7 @@ Description
|
|
|
33
33
|
</th></tr></thead>
|
|
34
34
|
<tbody><tr><td>
|
|
35
35
|
|
|
36
|
-
[addQueryToHistory({ state, dispatch }, query)](./x-components.addquerytohistoryaction.addquerytohistory.md)
|
|
36
|
+
[addQueryToHistory({ state, dispatch }, input, query)](./x-components.addquerytohistoryaction.addquerytohistory.md)
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
</td><td>
|
|
@@ -41,7 +41,7 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
41
41
|
highlightPreviousItem: () => void;
|
|
42
42
|
highlightedItemIndex: import("vue").Ref<number, number>;
|
|
43
43
|
isOpen: import("vue").Ref<boolean, boolean>;
|
|
44
|
-
itemsButtonRefs: import("vue").Ref<HTMLButtonElement[], HTMLButtonElement[]>;
|
|
44
|
+
itemsButtonRefs: import("vue").Ref<(HTMLButtonElement | null)[], (HTMLButtonElement | null)[]>;
|
|
45
45
|
itemsCSSClasses: import("vue").ComputedRef<{
|
|
46
46
|
'x-dropdown__item--is-selected': boolean;
|
|
47
47
|
'x-dropdown__item--is-highlighted': boolean;
|
|
@@ -18,7 +18,7 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
18
18
|
required: true;
|
|
19
19
|
};
|
|
20
20
|
}>, {
|
|
21
|
-
el: import("vue").
|
|
21
|
+
el: Readonly<import("vue").ShallowRef<any>>;
|
|
22
22
|
isOpen: import("vue").Ref<boolean, boolean>;
|
|
23
23
|
emitClickOutOfModal: (event: MouseEvent | FocusEvent) => void;
|
|
24
24
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -30,7 +30,7 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
30
30
|
loadedImages: Ref<string[], string[]>;
|
|
31
31
|
isHovering: Ref<boolean, boolean>;
|
|
32
32
|
userHasHoveredImage: Ref<boolean, boolean>;
|
|
33
|
-
loaderStyles:
|
|
33
|
+
loaderStyles: import("vue").CSSProperties;
|
|
34
34
|
animation: import("vue").ComputedRef<string | Function | Record<string, any>>;
|
|
35
35
|
imageSrc: import("vue").ComputedRef<string>;
|
|
36
36
|
shouldLoadNextImage: import("vue").ComputedRef<boolean>;
|
|
@@ -15,9 +15,9 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
15
15
|
default: boolean;
|
|
16
16
|
};
|
|
17
17
|
}>, {
|
|
18
|
-
expand: (element:
|
|
19
|
-
cleanUpAnimationStyles: (element:
|
|
20
|
-
collapse: (element:
|
|
18
|
+
expand: (element: Element) => void;
|
|
19
|
+
cleanUpAnimationStyles: (element: Element) => void;
|
|
20
|
+
collapse: (element: Element) => void;
|
|
21
21
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
22
22
|
appear: {
|
|
23
23
|
type: BooleanConstructor;
|
|
@@ -15,9 +15,9 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
15
15
|
default: boolean;
|
|
16
16
|
};
|
|
17
17
|
}>, {
|
|
18
|
-
expand: (element:
|
|
19
|
-
cleanUpAnimationStyles: (element:
|
|
20
|
-
collapse: (element:
|
|
18
|
+
expand: (element: Element) => void;
|
|
19
|
+
cleanUpAnimationStyles: (element: Element) => void;
|
|
20
|
+
collapse: (element: Element) => void;
|
|
21
21
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
22
22
|
appear: {
|
|
23
23
|
type: BooleanConstructor;
|
|
@@ -9,7 +9,7 @@ Utility to create an action that requests and save some data asynchronously, wit
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function createFetchAndSaveActions<Context extends XActionContext<StatusState, object, StatusMutations, object>, Request, Response>(
|
|
12
|
+
export declare function createFetchAndSaveActions<Context extends XActionContext<StatusState, object, StatusMutations, object>, Request, Response>(input: FetchAndSaveHooks<Context, Request, Response>): FetchAndSaveActions<Context, Request>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ fetch, onSuccess, onError, onCancel, }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[FetchAndSaveHooks](./x-components.fetchandsavehooks.md)<!-- --><Context, Request, Response>
|
|
@@ -9,7 +9,7 @@ Creates a getter that combines the current selected related tags and the query o
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function createRelatedTagsQueryGetter<State extends QueryState, Getters>(
|
|
12
|
+
export declare function createRelatedTagsQueryGetter<State extends QueryState, Getters>(input: CreateRelatedTagsQueryGetterOptions<State, Getters>): (state: State, getters: Getters) => string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ getRelatedTags, }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[CreateRelatedTagsQueryGetterOptions](./x-components.createrelatedtagsquerygetteroptions.md)<!-- --><State, Getters>
|
|
@@ -9,7 +9,7 @@ Util function that returns a debounced version of the function passed as paramet
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
debounce: <Params extends any[]>(fn: (...args: Params) => void, debounceTimeInMs: number,
|
|
12
|
+
debounce: <Params extends any[]>(fn: (...args: Params) => void, debounceTimeInMs: number, input?: DebounceOptions) => DebouncedFunction<Params>
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -65,6 +65,22 @@ number
|
|
|
65
65
|
{ leading, trailing }
|
|
66
66
|
|
|
67
67
|
|
|
68
|
+
</td><td>
|
|
69
|
+
|
|
70
|
+
(not declared)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
</td><td>
|
|
74
|
+
|
|
75
|
+
_(Optional)_
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
</td></tr>
|
|
79
|
+
<tr><td>
|
|
80
|
+
|
|
81
|
+
input
|
|
82
|
+
|
|
83
|
+
|
|
68
84
|
</td><td>
|
|
69
85
|
|
|
70
86
|
[DebounceOptions](./x-components.debounceoptions.md)
|
package/docs/API-reference/api/x-components.defaultfacetsservice.clearfilterswithmetadata.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
clearFiltersWithMetadata(
|
|
10
|
+
clearFiltersWithMetadata(input?: {
|
|
11
11
|
facetIds?: Array<Facet['id']>;
|
|
12
12
|
metadata?: FiltersMetadata;
|
|
13
13
|
}): void;
|
|
@@ -36,6 +36,22 @@ Description
|
|
|
36
36
|
{ facetIds, metadata, }
|
|
37
37
|
|
|
38
38
|
|
|
39
|
+
</td><td>
|
|
40
|
+
|
|
41
|
+
(not declared)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</td><td>
|
|
45
|
+
|
|
46
|
+
_(Optional)_
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</td></tr>
|
|
50
|
+
<tr><td>
|
|
51
|
+
|
|
52
|
+
input
|
|
53
|
+
|
|
54
|
+
|
|
39
55
|
</td><td>
|
|
40
56
|
|
|
41
57
|
{ facetIds?: Array<Facet\['id'\]>; metadata?: [FiltersMetadata](./x-components.filtersmetadata.md)<!-- -->; }
|
|
@@ -144,7 +144,7 @@ Description
|
|
|
144
144
|
</td></tr>
|
|
145
145
|
<tr><td>
|
|
146
146
|
|
|
147
|
-
[clearFiltersWithMetadata({ facetIds, metadata, })](./x-components.defaultfacetsservice.clearfilterswithmetadata.md)
|
|
147
|
+
[clearFiltersWithMetadata({ facetIds, metadata, }, input)](./x-components.defaultfacetsservice.clearfilterswithmetadata.md)
|
|
148
148
|
|
|
149
149
|
|
|
150
150
|
</td><td>
|
|
@@ -9,7 +9,7 @@ Default implementation for the [HistoryQueriesGetters.historyQueries](./x-compon
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
historyQueries(
|
|
12
|
+
historyQueries(input: HistoryQueriesState): HistoryQuery[];
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ query, historyQueries, config }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[HistoryQueriesState](./x-components.historyqueriesstate.md)
|
|
@@ -33,7 +33,7 @@ Description
|
|
|
33
33
|
</th></tr></thead>
|
|
34
34
|
<tbody><tr><td>
|
|
35
35
|
|
|
36
|
-
[historyQueries({ query, historyQueries, config })](./x-components.historyqueriesgetter.historyqueries.md)
|
|
36
|
+
[historyQueries({ query, historyQueries, config }, input)](./x-components.historyqueriesgetter.historyqueries.md)
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
</td><td>
|
|
@@ -9,7 +9,7 @@ Returns true if the number is greater than or equal than the min, and less than
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function isInRange(number: number,
|
|
12
|
+
export declare function isInRange(number: number, input: [number, number]): boolean;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -51,6 +51,20 @@ The number to check if it belongs to the range.
|
|
|
51
51
|
\[min, max\]
|
|
52
52
|
|
|
53
53
|
|
|
54
|
+
</td><td>
|
|
55
|
+
|
|
56
|
+
(not declared)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
</td><td>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td></tr>
|
|
63
|
+
<tr><td>
|
|
64
|
+
|
|
65
|
+
input
|
|
66
|
+
|
|
67
|
+
|
|
54
68
|
</td><td>
|
|
55
69
|
|
|
56
70
|
\[number, number\]
|
|
@@ -174,7 +174,7 @@ Description
|
|
|
174
174
|
</th></tr></thead>
|
|
175
175
|
<tbody><tr><td>
|
|
176
176
|
|
|
177
|
-
[addQueryToHistory({ state, dispatch }, query)](./x-components.addquerytohistory.md)
|
|
177
|
+
[addQueryToHistory({ state, dispatch }, input, query)](./x-components.addquerytohistory.md)
|
|
178
178
|
|
|
179
179
|
|
|
180
180
|
</td><td>
|
|
@@ -394,7 +394,7 @@ Deeply clones an object or an array.
|
|
|
394
394
|
</td></tr>
|
|
395
395
|
<tr><td>
|
|
396
396
|
|
|
397
|
-
[createFetchAndSaveActions({ fetch, onSuccess, onError, onCancel, })](./x-components.createfetchandsaveactions.md)
|
|
397
|
+
[createFetchAndSaveActions({ fetch, onSuccess, onError, onCancel, }, input)](./x-components.createfetchandsaveactions.md)
|
|
398
398
|
|
|
399
399
|
|
|
400
400
|
</td><td>
|
|
@@ -416,7 +416,7 @@ Helper method which creates the filter entity from the filter ir of the url.
|
|
|
416
416
|
</td></tr>
|
|
417
417
|
<tr><td>
|
|
418
418
|
|
|
419
|
-
[createRelatedTagsQueryGetter({ getRelatedTags, })](./x-components.createrelatedtagsquerygetter.md)
|
|
419
|
+
[createRelatedTagsQueryGetter({ getRelatedTags, }, input)](./x-components.createrelatedtagsquerygetter.md)
|
|
420
420
|
|
|
421
421
|
|
|
422
422
|
</td><td>
|
|
@@ -559,7 +559,7 @@ Creates a debounced [Wire](./x-components.wire.md)<!-- -->. Being debounced mean
|
|
|
559
559
|
</td></tr>
|
|
560
560
|
<tr><td>
|
|
561
561
|
|
|
562
|
-
[debounceFunction(fn, debounceTimeInMs, { leading, trailing })](./x-components.debouncefunction.md)
|
|
562
|
+
[debounceFunction(fn, debounceTimeInMs, { leading, trailing }, input)](./x-components.debouncefunction.md)
|
|
563
563
|
|
|
564
564
|
|
|
565
565
|
</td><td>
|
|
@@ -845,7 +845,7 @@ Groups the array items based on the provided `groupBy` function.
|
|
|
845
845
|
</td></tr>
|
|
846
846
|
<tr><td>
|
|
847
847
|
|
|
848
|
-
[historyQueries({ query, historyQueries, config })](./x-components.historyqueries.md)
|
|
848
|
+
[historyQueries({ query, historyQueries, config }, input)](./x-components.historyqueries.md)
|
|
849
849
|
|
|
850
850
|
|
|
851
851
|
</td><td>
|
|
@@ -878,7 +878,7 @@ Returns true if the two elements are the same, or if `b` is a child of `a`<!-- -
|
|
|
878
878
|
</td></tr>
|
|
879
879
|
<tr><td>
|
|
880
880
|
|
|
881
|
-
[isInRange(number, \[min, max\])](./x-components.isinrange.md)
|
|
881
|
+
[isInRange(number, \[min, max\], input)](./x-components.isinrange.md)
|
|
882
882
|
|
|
883
883
|
|
|
884
884
|
</td><td>
|
|
@@ -1040,7 +1040,7 @@ Trims the string, transforms it to lower case, and removes [combining diacritica
|
|
|
1040
1040
|
</td></tr>
|
|
1041
1041
|
<tr><td>
|
|
1042
1042
|
|
|
1043
|
-
[querySuggestions({ query, suggestions, config, searchedQueries, })](./x-components.querysuggestions.md)
|
|
1043
|
+
[querySuggestions({ query, suggestions, config, searchedQueries, }, input)](./x-components.querysuggestions.md)
|
|
1044
1044
|
|
|
1045
1045
|
|
|
1046
1046
|
</td><td>
|
|
@@ -1194,7 +1194,7 @@ Composable to ease disabling animations.
|
|
|
1194
1194
|
</td></tr>
|
|
1195
1195
|
<tr><td>
|
|
1196
1196
|
|
|
1197
|
-
[useEmitDisplayEvent({ element, taggingRequest, eventMetadata, })](./x-components.useemitdisplayevent.md)
|
|
1197
|
+
[useEmitDisplayEvent({ element, taggingRequest, eventMetadata, }, input)](./x-components.useemitdisplayevent.md)
|
|
1198
1198
|
|
|
1199
1199
|
|
|
1200
1200
|
</td><td>
|
|
@@ -1227,7 +1227,7 @@ Composable to share filters injection logic.
|
|
|
1227
1227
|
</td></tr>
|
|
1228
1228
|
<tr><td>
|
|
1229
1229
|
|
|
1230
|
-
[useOnDisplay({ element, callback, triggerOnce, })](./x-components.useondisplay.md)
|
|
1230
|
+
[useOnDisplay({ element, callback, triggerOnce, }, input)](./x-components.useondisplay.md)
|
|
1231
1231
|
|
|
1232
1232
|
|
|
1233
1233
|
</td><td>
|
|
@@ -1249,7 +1249,7 @@ Composable helpers for the QueriesPreview module.
|
|
|
1249
1249
|
</td></tr>
|
|
1250
1250
|
<tr><td>
|
|
1251
1251
|
|
|
1252
|
-
[useScroll(props, { emit }, scrollEl)](./x-components.usescroll.md)
|
|
1252
|
+
[useScroll(props, { emit }, input, scrollEl)](./x-components.usescroll.md)
|
|
1253
1253
|
|
|
1254
1254
|
|
|
1255
1255
|
</td><td>
|
|
@@ -33,7 +33,7 @@ Description
|
|
|
33
33
|
</th></tr></thead>
|
|
34
34
|
<tbody><tr><td>
|
|
35
35
|
|
|
36
|
-
[querySuggestions({ query, suggestions, config, searchedQueries, })](./x-components.querysuggestionsgetter.querysuggestions.md)
|
|
36
|
+
[querySuggestions({ query, suggestions, config, searchedQueries, }, input)](./x-components.querysuggestionsgetter.querysuggestions.md)
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
</td><td>
|
|
@@ -9,7 +9,7 @@ Default implementation for the [QuerySuggestionsGetter.querySuggestions()](./x-c
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
querySuggestions(
|
|
12
|
+
querySuggestions(input: QuerySuggestionsState): Suggestion[];
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ query, suggestions, config, searchedQueries, }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
[QuerySuggestionsState](./x-components.querysuggestionsstate.md)
|
|
@@ -10,9 +10,9 @@ Returns parametrized methods to use in a component to allow the collapsing of th
|
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
12
|
export declare function useCollapseAnimation(property: AnimatedProperty): {
|
|
13
|
-
expand: (element:
|
|
14
|
-
cleanUpAnimationStyles: (element:
|
|
15
|
-
collapse: (element:
|
|
13
|
+
expand: (element: Element) => void;
|
|
14
|
+
cleanUpAnimationStyles: (element: Element) => void;
|
|
15
|
+
collapse: (element: Element) => void;
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
@@ -54,7 +54,7 @@ The property that will be animated.
|
|
|
54
54
|
|
|
55
55
|
**Returns:**
|
|
56
56
|
|
|
57
|
-
{ expand: (element:
|
|
57
|
+
{ expand: (element: Element) => void; cleanUpAnimationStyles: (element: Element) => void; collapse: (element: Element) => void; }
|
|
58
58
|
|
|
59
59
|
Composable for the module.
|
|
60
60
|
|
|
@@ -9,7 +9,7 @@ Composable that emits a `TrackableElementDisplayed` event whenever the provided
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function useEmitDisplayEvent(
|
|
12
|
+
export declare function useEmitDisplayEvent(input: UseEmitDisplayEventOptions): UseOnDisplayReturn;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ element, taggingRequest, eventMetadata, }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
UseEmitDisplayEventOptions
|
|
@@ -9,7 +9,7 @@ Composable that triggers a callback whenever the provided element appears in the
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function useOnDisplay(
|
|
12
|
+
export declare function useOnDisplay(input: UseOnDisplayOptions): UseOnDisplayReturn;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -35,6 +35,20 @@ Description
|
|
|
35
35
|
{ element, callback, triggerOnce, }
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
(not declared)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
input
|
|
50
|
+
|
|
51
|
+
|
|
38
52
|
</td><td>
|
|
39
53
|
|
|
40
54
|
UseOnDisplayOptions
|
|
@@ -15,7 +15,7 @@ export declare function useScroll(props: {
|
|
|
15
15
|
throttleMs: number;
|
|
16
16
|
resetOnChange: boolean;
|
|
17
17
|
resetOn: XEvent | XEvent[];
|
|
18
|
-
},
|
|
18
|
+
}, input: SetupContext<any>, scrollEl: Ref<HTMLElement | undefined>): {
|
|
19
19
|
throttledStoreScrollData: import("vue").ComputedRef<import("../..").ThrottleFunction<[]>>;
|
|
20
20
|
};
|
|
21
21
|
```
|
|
@@ -59,6 +59,20 @@ Composable props.
|
|
|
59
59
|
{ emit }
|
|
60
60
|
|
|
61
61
|
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
(not declared)
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
</td><td>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</td></tr>
|
|
71
|
+
<tr><td>
|
|
72
|
+
|
|
73
|
+
input
|
|
74
|
+
|
|
75
|
+
|
|
62
76
|
</td><td>
|
|
63
77
|
|
|
64
78
|
SetupContext<any>
|
|
@@ -9,9 +9,9 @@ A suggestion represents a query that has been proposed to the user, due of being
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface Suggestion extends NamedModel<'QuerySuggestion' | 'PopularSearch'>, Previewable
|
|
12
|
+
export interface Suggestion extends NamedModel<'QuerySuggestion' | 'PopularSearch' | 'SemanticQuery' | 'NextQuery' | 'HistoryQuery'>, Previewable
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- --><'QuerySuggestion' \| 'PopularSearch'>, [Previewable](./x-types.previewable.md)
|
|
14
|
+
**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- --><'QuerySuggestion' \| 'PopularSearch' \| 'SemanticQuery' \| 'NextQuery' \| 'HistoryQuery'>, [Previewable](./x-types.previewable.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -57,7 +57,7 @@ _(Optional)_ If it's a curated suggestion.
|
|
|
57
57
|
</td></tr>
|
|
58
58
|
<tr><td>
|
|
59
59
|
|
|
60
|
-
[key](./x-types.suggestion.key.md)
|
|
60
|
+
[key?](./x-types.suggestion.key.md)
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
</td><td>
|
|
@@ -70,7 +70,7 @@ string
|
|
|
70
70
|
|
|
71
71
|
</td><td>
|
|
72
72
|
|
|
73
|
-
Unique identifier of the suggestion.
|
|
73
|
+
_(Optional)_ Unique identifier of the suggestion.
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
</td></tr>
|