@empathyco/x-components 6.0.0-alpha.100 → 6.0.0-alpha.102
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 +16 -0
- package/docs/API-reference/api/x-components.addquerytohistory.md +15 -1
- package/docs/API-reference/api/x-components.animateclippath.md +14 -1
- package/docs/API-reference/api/x-components.animatescale.md +14 -1
- package/docs/API-reference/api/x-components.animatetranslate.md +14 -1
- package/docs/API-reference/api/x-components.cancelfetchandsavecontrols.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsaveidentifierresults.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsavenextqueries.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsavepopularsearches.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsavequerysuggestions.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsaverecommendations.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsaverelatedprompts.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsaverelatedtags.md +5 -1
- package/docs/API-reference/api/x-components.cancelfetchandsavesearchresponse.md +5 -1
- package/docs/API-reference/api/x-components.debouncefunction.md +15 -1
- package/docs/API-reference/api/x-components.fetchandsaveexperiencecontrolsresponse.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsaveidentifierresults.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsavenextqueries.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsavepopularsearches.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsavequerysuggestions.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsaverecommendations.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsaverelatedprompts.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsaverelatedtags.md +13 -1
- package/docs/API-reference/api/x-components.fetchandsavesearchresponse.md +13 -1
- package/docs/API-reference/api/x-components.geturlparameter.md +14 -1
- package/docs/API-reference/api/{x-components.highlight.md → x-components.highlight_2.md} +2 -2
- package/docs/API-reference/api/x-components.isios.md +7 -1
- package/docs/API-reference/api/x-components.md +32 -32
- package/docs/API-reference/api/x-components.removesearchinputfocus.md +5 -1
- package/docs/API-reference/api/x-components.sanitize.md +14 -1
- package/docs/API-reference/api/x-components.throttlefunction.md +4 -4
- package/docs/API-reference/api/x-components.usequeriespreview.md +7 -1
- package/js/components/base-rating.vue3.js +1 -1
- package/js/x-modules/related-prompts/components/related-prompt.vue.js +12 -2
- package/js/x-modules/related-prompts/components/related-prompt.vue.js.map +1 -1
- package/js/x-modules/related-prompts/components/related-prompt.vue2.js.map +1 -1
- package/js/x-modules/related-prompts/components/related-prompt.vue3.js +1 -1
- package/package.json +15 -16
- package/report/tsdoc-metadata.json +1 -1
- package/report/x-adapter-platform.api.json +1 -1
- package/report/x-components.api.json +816 -376
- package/report/x-components.api.md +2 -1
- package/report/x-types.api.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
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.102 (2025-06-26)
|
|
7
|
+
|
|
8
|
+
* chore(deps): bump high confidence packages (#1810) ([892f1b2](https://github.com/empathyco/x/commit/892f1b2)), closes [#1810](https://github.com/empathyco/x/issues/1810)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## 6.0.0-alpha.101 (2025-06-26)
|
|
15
|
+
|
|
16
|
+
* feat(related-prompts): add related prompts images as default (#1811) ([e7e51b4](https://github.com/empathyco/x/commit/e7e51b4)), closes [#1811](https://github.com/empathyco/x/issues/1811)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
## 6.0.0-alpha.100 (2025-06-25)
|
|
7
23
|
|
|
8
24
|
* chore(deps): pin dependency @empathyco/x-tailwindcss to 2.0.0-alpha.11 (#1808) ([c614b25](https://github.com/empathyco/x/commit/c614b25)), closes [#1808](https://github.com/empathyco/x/issues/1808)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [addQueryToHistory](./x-components.addquerytohistory.md)
|
|
4
4
|
|
|
5
|
-
## addQueryToHistory
|
|
5
|
+
## addQueryToHistory() function
|
|
6
6
|
|
|
7
7
|
Default implementation for the [HistoryQueriesActions.addQueryToHistory](./x-components.historyqueriesactions.addquerytohistory.md)<!-- -->.
|
|
8
8
|
|
|
@@ -11,3 +11,17 @@ Default implementation for the [HistoryQueriesActions.addQueryToHistory](./x-com
|
|
|
11
11
|
```typescript
|
|
12
12
|
addQueryToHistory: ({ state, dispatch }: HistoryQueriesActionContext, query: string) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| { state, dispatch } | [HistoryQueriesActionContext](./x-components.historyqueriesactioncontext.md) | |
|
|
20
|
+
| query | string | The query to try to add to the history. |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
26
|
+
A `void` promise that resolves when the history queries finishes updating.
|
|
27
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [animateClipPath](./x-components.animateclippath.md)
|
|
4
4
|
|
|
5
|
-
## animateClipPath
|
|
5
|
+
## animateClipPath() function
|
|
6
6
|
|
|
7
7
|
Returns a transition component to wrap an element passed in the default slot and animating its clip-path using inset and with the origin passed as parameter.
|
|
8
8
|
|
|
@@ -11,3 +11,16 @@ Returns a transition component to wrap an element passed in the default slot and
|
|
|
11
11
|
```typescript
|
|
12
12
|
animateClipPath: (animationOrigin?: import("../create-directional-animation-factory").AnimationOrigin | undefined) => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| animationOrigin | import("../create-directional-animation-factory").AnimationOrigin \| undefined | _(Optional)_ The origin of the animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
24
|
+
|
|
25
|
+
A Transition Component.
|
|
26
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [animateScale](./x-components.animatescale.md)
|
|
4
4
|
|
|
5
|
-
## animateScale
|
|
5
|
+
## animateScale() function
|
|
6
6
|
|
|
7
7
|
Returns a transition component to wrap an element passed in the default slot and animating its scale using transform and with the transform origin passed as parameter.
|
|
8
8
|
|
|
@@ -11,3 +11,16 @@ Returns a transition component to wrap an element passed in the default slot and
|
|
|
11
11
|
```typescript
|
|
12
12
|
animateScale: (animationOrigin?: import("../create-directional-animation-factory").AnimationOrigin | undefined) => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| animationOrigin | import("../create-directional-animation-factory").AnimationOrigin \| undefined | _(Optional)_ The origin of the transform animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
24
|
+
|
|
25
|
+
A Transition Component.
|
|
26
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [animateTranslate](./x-components.animatetranslate.md)
|
|
4
4
|
|
|
5
|
-
## animateTranslate
|
|
5
|
+
## animateTranslate() function
|
|
6
6
|
|
|
7
7
|
Returns a transition component to wrap an element passed in the default slot and animating its translate using transform and with the transform origin passed as parameter.
|
|
8
8
|
|
|
@@ -11,3 +11,16 @@ Returns a transition component to wrap an element passed in the default slot and
|
|
|
11
11
|
```typescript
|
|
12
12
|
animateTranslate: (animationOrigin?: import("../create-directional-animation-factory").AnimationOrigin | undefined) => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| animationOrigin | import("../create-directional-animation-factory").AnimationOrigin \| undefined | _(Optional)_ The origin of the transform animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
24
|
+
|
|
25
|
+
A Transition Component.
|
|
26
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveControls](./x-components.cancelfetchandsavecontrols.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveControls
|
|
5
|
+
## cancelFetchAndSaveControls() function
|
|
6
6
|
|
|
7
7
|
Default implementation for fetchAndSaveExperienceControls action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for fetchAndSaveExperienceControls action.
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveControls: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveIdentifierResults](./x-components.cancelfetchandsaveidentifierresults.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveIdentifierResults
|
|
5
|
+
## cancelFetchAndSaveIdentifierResults() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [IdentifierResultsActions.cancelFetchAndSaveIdentifierResults](./x-components.identifierresultsactions.cancelfetchandsaveidentifierresults.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [IdentifierResultsActions.cancelFetchAndSaveIdentifie
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveIdentifierResults: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveNextQueries](./x-components.cancelfetchandsavenextqueries.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveNextQueries
|
|
5
|
+
## cancelFetchAndSaveNextQueries() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [NextQueriesActions.cancelFetchAndSaveNextQueries](./x-components.nextqueriesactions.cancelfetchandsavenextqueries.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [NextQueriesActions.cancelFetchAndSaveNextQueries](./
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveNextQueries: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSavePopularSearches](./x-components.cancelfetchandsavepopularsearches.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSavePopularSearches
|
|
5
|
+
## cancelFetchAndSavePopularSearches() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [PopularSearchesActions.cancelFetchAndSaveSuggestions](./x-components.popularsearchesactions.cancelfetchandsavesuggestions.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [PopularSearchesActions.cancelFetchAndSaveSuggestions
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveSuggestions: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveQuerySuggestions](./x-components.cancelfetchandsavequerysuggestions.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveQuerySuggestions
|
|
5
|
+
## cancelFetchAndSaveQuerySuggestions() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [QuerySuggestionsActions.cancelFetchAndSaveSuggestions](./x-components.querysuggestionsactions.cancelfetchandsavesuggestions.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [QuerySuggestionsActions.cancelFetchAndSaveSuggestion
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveSuggestions: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveRecommendations](./x-components.cancelfetchandsaverecommendations.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveRecommendations
|
|
5
|
+
## cancelFetchAndSaveRecommendations() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RecommendationsActions.cancelFetchAndSaveRecommendations](./x-components.recommendationsactions.cancelfetchandsaverecommendations.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [RecommendationsActions.cancelFetchAndSaveRecommendat
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveRecommendations: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveRelatedPrompts](./x-components.cancelfetchandsaverelatedprompts.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveRelatedPrompts
|
|
5
|
+
## cancelFetchAndSaveRelatedPrompts() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RelatedPromptsActions.cancelFetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [RelatedPromptsActions.cancelFetchAndSaveRelatedPromp
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveRelatedPrompts: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveRelatedTags](./x-components.cancelfetchandsaverelatedtags.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveRelatedTags
|
|
5
|
+
## cancelFetchAndSaveRelatedTags() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RelatedTagsActions.fetchAndSaveRelatedTags](./x-components.relatedtagsactions.fetchandsaverelatedtags.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [RelatedTagsActions.fetchAndSaveRelatedTags](./x-comp
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveRelatedTags: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveSearchResponse](./x-components.cancelfetchandsavesearchresponse.md)
|
|
4
4
|
|
|
5
|
-
## cancelFetchAndSaveSearchResponse
|
|
5
|
+
## cancelFetchAndSaveSearchResponse() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [SearchActions.cancelFetchAndSaveSearchResponse](./x-components.searchactions.cancelfetchandsavesearchresponse.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,7 @@ Default implementation for [SearchActions.cancelFetchAndSaveSearchResponse](./x-
|
|
|
11
11
|
```typescript
|
|
12
12
|
cancelFetchAndSaveSearchResponse: () => void
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [debounceFunction](./x-components.debouncefunction.md)
|
|
4
4
|
|
|
5
|
-
## debounceFunction
|
|
5
|
+
## debounceFunction() function
|
|
6
6
|
|
|
7
7
|
Util function that returns a debounced version of the function passed as parameter. It can use the leading strategy, trailing strategy or both. Using both would result in one leading execution guaranteed and trailing executions only if there are further calls during the length of the debounce time.
|
|
8
8
|
|
|
@@ -12,6 +12,20 @@ Util function that returns a debounced version of the function passed as paramet
|
|
|
12
12
|
debounce: <Params extends any[]>(fn: (...args: Params) => void, debounceTimeInMs: number, { leading, trailing }?: DebounceOptions) => DebouncedFunction<Params>
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| fn | (...args: Params) => void | Function to be debounced. |
|
|
20
|
+
| debounceTimeInMs | number | |
|
|
21
|
+
| { leading, trailing } | [DebounceOptions](./x-components.debounceoptions.md) | _(Optional)_ |
|
|
22
|
+
|
|
23
|
+
**Returns:**
|
|
24
|
+
|
|
25
|
+
[DebouncedFunction](./x-components.debouncedfunction.md)<!-- --><Params>
|
|
26
|
+
|
|
27
|
+
A new function with the debounce.
|
|
28
|
+
|
|
15
29
|
## Example
|
|
16
30
|
|
|
17
31
|
Debounce options:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveExperienceControlsResponse](./x-components.fetchandsaveexperiencecontrolsresponse.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveExperienceControlsResponse
|
|
5
|
+
## fetchAndSaveExperienceControlsResponse() function
|
|
6
6
|
|
|
7
7
|
Default implementation for fetchAndSaveExperienceControls action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for fetchAndSaveExperienceControls action.
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveExperienceControlsResponse: (context: ExperienceControlsActionContext, request: ExperienceControlsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [ExperienceControlsActionContext](./x-components.experiencecontrolsactioncontext.md) | |
|
|
20
|
+
| request | ExperienceControlsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveIdentifierResults](./x-components.fetchandsaveidentifierresults.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveIdentifierResults
|
|
5
|
+
## fetchAndSaveIdentifierResults() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [IdentifierResultsActions.fetchAndSaveIdentifierResults](./x-components.identifierresultsactions.fetchandsaveidentifierresults.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [IdentifierResultsActions.fetchAndSaveIdentifierResul
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveIdentifierResults: (context: IdentifierResultsActionsContext, request: IdentifierResultsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [IdentifierResultsActionsContext](./x-components.identifierresultsactionscontext.md) | |
|
|
20
|
+
| request | IdentifierResultsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveNextQueries](./x-components.fetchandsavenextqueries.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveNextQueries
|
|
5
|
+
## fetchAndSaveNextQueries() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [NextQueriesActions.fetchAndSaveNextQueries](./x-components.nextqueriesactions.fetchandsavenextqueries.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [NextQueriesActions.fetchAndSaveNextQueries](./x-comp
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveNextQueries: (context: NextQueriesActionContext, request: NextQueriesRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [NextQueriesActionContext](./x-components.nextqueriesactioncontext.md) | |
|
|
20
|
+
| request | NextQueriesRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSavePopularSearches](./x-components.fetchandsavepopularsearches.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSavePopularSearches
|
|
5
|
+
## fetchAndSavePopularSearches() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [PopularSearchesActions.fetchAndSaveSuggestions](./x-components.popularsearchesactions.fetchandsavesuggestions.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [PopularSearchesActions.fetchAndSaveSuggestions](./x-
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveSuggestions: (context: PopularSearchesActionContext, request: PopularSearchesRequest) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [PopularSearchesActionContext](./x-components.popularsearchesactioncontext.md) | |
|
|
20
|
+
| request | PopularSearchesRequest | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveQuerySuggestions](./x-components.fetchandsavequerysuggestions.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveQuerySuggestions
|
|
5
|
+
## fetchAndSaveQuerySuggestions() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [QuerySuggestionsActions.fetchAndSaveSuggestions](./x-components.querysuggestionsactions.fetchandsavesuggestions.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [QuerySuggestionsActions.fetchAndSaveSuggestions](./x
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveSuggestions: (context: QuerySuggestionsActionContext, request: QuerySuggestionsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [QuerySuggestionsActionContext](./x-components.querysuggestionsactioncontext.md) | |
|
|
20
|
+
| request | QuerySuggestionsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveRecommendations](./x-components.fetchandsaverecommendations.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveRecommendations
|
|
5
|
+
## fetchAndSaveRecommendations() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RecommendationsActions.fetchAndSaveRecommendations](./x-components.recommendationsactions.fetchandsaverecommendations.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [RecommendationsActions.fetchAndSaveRecommendations](
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveRecommendations: (context: RecommendationsActionContext, request: RecommendationsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [RecommendationsActionContext](./x-components.recommendationsactioncontext.md) | |
|
|
20
|
+
| request | RecommendationsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveRelatedPrompts](./x-components.fetchandsaverelatedprompts.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveRelatedPrompts
|
|
5
|
+
## fetchAndSaveRelatedPrompts() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RelatedPromptsActions.fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [RelatedPromptsActions.fetchAndSaveRelatedPrompts](./
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveRelatedPrompts: (context: RelatedPromptsActionContext, request: RelatedPromptsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [RelatedPromptsActionContext](./x-components.relatedpromptsactioncontext.md) | |
|
|
20
|
+
| request | RelatedPromptsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveRelatedTags](./x-components.fetchandsaverelatedtags.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveRelatedTags
|
|
5
|
+
## fetchAndSaveRelatedTags() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [RelatedTagsActions.fetchAndSaveRelatedTags](./x-components.relatedtagsactions.fetchandsaverelatedtags.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [RelatedTagsActions.fetchAndSaveRelatedTags](./x-comp
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveRelatedTags: (context: RelatedTagsActionContext, request: RelatedTagsRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [RelatedTagsActionContext](./x-components.relatedtagsactioncontext.md) | |
|
|
20
|
+
| request | RelatedTagsRequest \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSaveSearchResponse](./x-components.fetchandsavesearchresponse.md)
|
|
4
4
|
|
|
5
|
-
## fetchAndSaveSearchResponse
|
|
5
|
+
## fetchAndSaveSearchResponse() function
|
|
6
6
|
|
|
7
7
|
Default implementation for [SearchActions.fetchAndSaveSearchResponse](./x-components.searchactions.fetchandsavesearchresponse.md) action.
|
|
8
8
|
|
|
@@ -11,3 +11,15 @@ Default implementation for [SearchActions.fetchAndSaveSearchResponse](./x-compon
|
|
|
11
11
|
```typescript
|
|
12
12
|
fetchAndSaveSearchResponse: (context: SearchActionContext, request: InternalSearchRequest | null) => void | Promise<void>
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| context | [SearchActionContext](./x-components.searchactioncontext.md) | |
|
|
20
|
+
| request | [InternalSearchRequest](./x-components.internalsearchrequest.md) \| null | |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void \| Promise<void>
|
|
25
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [getURLParameter](./x-components.geturlparameter.md)
|
|
4
4
|
|
|
5
|
-
## getURLParameter
|
|
5
|
+
## getURLParameter() function
|
|
6
6
|
|
|
7
7
|
Get one parameter value from the url.
|
|
8
8
|
|
|
@@ -11,3 +11,16 @@ Get one parameter value from the url.
|
|
|
11
11
|
```typescript
|
|
12
12
|
getURLParameter: (param: string) => string | null
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| param | string | The parameter to get from the url. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string \| null
|
|
24
|
+
|
|
25
|
+
The parameter value from the url.
|
|
26
|
+
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [Highlight](./x-components.
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [Highlight\_2](./x-components.highlight_2.md)
|
|
4
4
|
|
|
5
|
-
## Highlight variable
|
|
5
|
+
## Highlight\_2 variable
|
|
6
6
|
|
|
7
7
|
Highlights the given part of the text. The component is smart enough to do matches between special characters like tilde, cedilla, eñe, capital letters...
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [isIOS](./x-components.isios.md)
|
|
4
4
|
|
|
5
|
-
## isIOS
|
|
5
|
+
## isIOS() function
|
|
6
6
|
|
|
7
7
|
Checks if the user is on an iOS device (iPhone, iPad, or iPod).
|
|
8
8
|
|
|
@@ -11,3 +11,9 @@ Checks if the user is on an iOS device (iPhone, iPad, or iPod).
|
|
|
11
11
|
```typescript
|
|
12
12
|
isIOS: () => boolean
|
|
13
13
|
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
boolean
|
|
17
|
+
|
|
18
|
+
`true` if the user is on iOS, `false` otherwise.
|
|
19
|
+
|