@empathyco/x-components 6.0.0-alpha.21 → 6.0.0-alpha.23
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 +18 -0
- package/core/index.js +3 -0
- package/core/index.js.map +1 -1
- package/design-system/deprecated-full-theme.css +2849 -2849
- package/docs/API-reference/api/x-components.configmutations.config.md +11 -0
- package/docs/API-reference/api/x-components.configmutations.md +29 -0
- package/docs/API-reference/api/x-components.configmutations.mergeconfig.md +24 -0
- package/docs/API-reference/api/x-components.configmutations.setconfig.md +24 -0
- package/docs/API-reference/api/x-components.createrelatedtagsquerygetter.md +26 -0
- package/docs/API-reference/api/x-components.createrelatedtagsquerygetteroptions.getrelatedtags.md +13 -0
- package/docs/API-reference/api/x-components.createrelatedtagsquerygetteroptions.md +20 -0
- package/docs/API-reference/api/x-components.empathizemutations.md +1 -1
- package/docs/API-reference/api/x-components.facetsmutations.md +1 -1
- package/docs/API-reference/api/x-components.historyqueriesmutations.md +1 -1
- package/docs/API-reference/api/x-components.historyqueriesstate.md +1 -1
- package/docs/API-reference/api/x-components.identifierresultsmutations.md +1 -1
- package/docs/API-reference/api/x-components.identifierresultsstate.md +1 -1
- package/docs/API-reference/api/x-components.md +8 -0
- package/docs/API-reference/api/x-components.mergeconfig.md +27 -0
- package/docs/API-reference/api/x-components.nextqueriesmutations.md +1 -1
- package/docs/API-reference/api/x-components.nextqueriesstate.md +1 -1
- package/docs/API-reference/api/x-components.popularsearchesmutations.md +1 -1
- package/docs/API-reference/api/x-components.queriespreviewmutations.md +1 -1
- package/docs/API-reference/api/x-components.querymutations.md +20 -0
- package/docs/API-reference/api/x-components.querymutations.setquery.md +24 -0
- package/docs/API-reference/api/x-components.querystate.md +20 -0
- package/docs/API-reference/api/x-components.querystate.query.md +13 -0
- package/docs/API-reference/api/x-components.querysuggestionsmutations.md +1 -1
- package/docs/API-reference/api/x-components.querysuggestionsstate.md +1 -1
- package/docs/API-reference/api/x-components.recommendationsmutations.md +1 -1
- package/docs/API-reference/api/x-components.relatedpromptsmutations.md +1 -1
- package/docs/API-reference/api/x-components.relatedpromptsstate.md +1 -1
- package/docs/API-reference/api/x-components.relatedtagsmutations.md +1 -1
- package/docs/API-reference/api/x-components.relatedtagsstate.md +1 -1
- package/docs/API-reference/api/x-components.searchboxmutations.md +1 -1
- package/docs/API-reference/api/x-components.searchboxstate.md +1 -1
- package/docs/API-reference/api/x-components.searchmutations.md +1 -1
- package/docs/API-reference/api/x-components.searchstate.md +1 -1
- package/docs/API-reference/api/x-components.semanticqueriesmutations.md +1 -1
- package/docs/API-reference/api/x-components.semanticqueriesstate.md +1 -1
- package/docs/API-reference/api/x-components.setconfig.md +27 -0
- package/docs/API-reference/api/x-components.setquery.md +25 -0
- package/docs/API-reference/api/x-components.taggingmutations.md +1 -1
- package/docs/API-reference/api/x-components.urlmutations.md +1 -1
- package/docs/API-reference/api/x-components.urlstate.md +1 -1
- package/js/components/base-dropdown.vue.js.map +1 -1
- package/js/components/base-dropdown.vue2.js +1 -7
- package/js/components/base-dropdown.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 -2
- package/js/components/result/base-result-image.vue2.js.map +1 -1
- package/js/index.js +3 -0
- package/js/index.js.map +1 -1
- package/js/x-modules/device/store/emitters.js +1 -0
- package/js/x-modules/device/store/emitters.js.map +1 -1
- package/js/x-modules/empathize/store/emitters.js +1 -0
- package/js/x-modules/empathize/store/emitters.js.map +1 -1
- package/js/x-modules/experience-controls/store/emitters.js +1 -0
- package/js/x-modules/experience-controls/store/emitters.js.map +1 -1
- package/js/x-modules/extra-params/store/emitters.js +1 -0
- package/js/x-modules/extra-params/store/emitters.js.map +1 -1
- package/js/x-modules/history-queries/store/emitters.js +1 -0
- package/js/x-modules/history-queries/store/emitters.js.map +1 -1
- package/js/x-modules/identifier-results/store/emitters.js +1 -0
- package/js/x-modules/identifier-results/store/emitters.js.map +1 -1
- package/js/x-modules/next-queries/store/emitters.js +1 -0
- package/js/x-modules/next-queries/store/emitters.js.map +1 -1
- package/js/x-modules/queries-preview/store/emitters.js +1 -0
- package/js/x-modules/queries-preview/store/emitters.js.map +1 -1
- package/js/x-modules/query-suggestions/store/emitters.js +1 -0
- package/js/x-modules/query-suggestions/store/emitters.js.map +1 -1
- package/js/x-modules/recommendations/store/emitters.js +1 -0
- package/js/x-modules/recommendations/store/emitters.js.map +1 -1
- package/js/x-modules/related-prompts/store/emitters.js +1 -0
- package/js/x-modules/related-prompts/store/emitters.js.map +1 -1
- package/js/x-modules/related-tags/store/emitters.js +1 -0
- package/js/x-modules/related-tags/store/emitters.js.map +1 -1
- package/js/x-modules/scroll/store/emitters.js +1 -0
- package/js/x-modules/scroll/store/emitters.js.map +1 -1
- package/js/x-modules/search/store/emitters.js +1 -0
- package/js/x-modules/search/store/emitters.js.map +1 -1
- package/js/x-modules/search/store/module.js +2 -1
- package/js/x-modules/search/store/module.js.map +1 -1
- package/js/x-modules/search-box/store/emitters.js +1 -0
- package/js/x-modules/search-box/store/emitters.js.map +1 -1
- package/js/x-modules/url/store/emitters.js +1 -0
- package/js/x-modules/url/store/emitters.js.map +1 -1
- package/package.json +2 -2
- package/report/x-components.api.json +690 -34
- package/report/x-components.api.md +49 -7
- package/types/components/base-dropdown.vue.d.ts.map +1 -1
- package/types/store/index.d.ts +4 -1
- package/types/store/index.d.ts.map +1 -1
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ConfigMutations](./x-components.configmutations.md) > [config](./x-components.configmutations.config.md)
|
|
4
|
+
|
|
5
|
+
## ConfigMutations.config property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
config: T['config'];
|
|
11
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ConfigMutations](./x-components.configmutations.md)
|
|
4
|
+
|
|
5
|
+
## ConfigMutations interface
|
|
6
|
+
|
|
7
|
+
Config mutations, containing a method to change the current config and other to merge a new one.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface ConfigMutations<T extends {
|
|
13
|
+
config: T['config'];
|
|
14
|
+
}>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
| Property | Modifiers | Type | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| [config](./x-components.configmutations.config.md) | | T\['config'\] | |
|
|
22
|
+
|
|
23
|
+
## Methods
|
|
24
|
+
|
|
25
|
+
| Method | Description |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| [mergeConfig(config)](./x-components.configmutations.mergeconfig.md) | Merges a new config with the current one. |
|
|
28
|
+
| [setConfig(config)](./x-components.configmutations.setconfig.md) | Sets the module config. |
|
|
29
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ConfigMutations](./x-components.configmutations.md) > [mergeConfig](./x-components.configmutations.mergeconfig.md)
|
|
4
|
+
|
|
5
|
+
## ConfigMutations.mergeConfig() method
|
|
6
|
+
|
|
7
|
+
Merges a new config with the current one.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
mergeConfig(config: T['config']): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| config | T\['config'\] | The config to be merged. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
void
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ConfigMutations](./x-components.configmutations.md) > [setConfig](./x-components.configmutations.setconfig.md)
|
|
4
|
+
|
|
5
|
+
## ConfigMutations.setConfig() method
|
|
6
|
+
|
|
7
|
+
Sets the module config.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setConfig(config: T['config']): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| config | T\['config'\] | The new config. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
void
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [createRelatedTagsQueryGetter](./x-components.createrelatedtagsquerygetter.md)
|
|
4
|
+
|
|
5
|
+
## createRelatedTagsQueryGetter() function
|
|
6
|
+
|
|
7
|
+
Creates a getter that combines the current selected related tags and the query of the module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function createRelatedTagsQueryGetter<State extends QueryState, Getters>({ getRelatedTags }: CreateRelatedTagsQueryGetterOptions<State, Getters>): (state: State, getters: Getters) => string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| { getRelatedTags } | [CreateRelatedTagsQueryGetterOptions](./x-components.createrelatedtagsquerygetteroptions.md)<!-- --><State, Getters> | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
(state: State, getters: Getters) => string
|
|
24
|
+
|
|
25
|
+
A getter that combines the selected related tags with the query.
|
|
26
|
+
|
package/docs/API-reference/api/x-components.createrelatedtagsquerygetteroptions.getrelatedtags.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [CreateRelatedTagsQueryGetterOptions](./x-components.createrelatedtagsquerygetteroptions.md) > [getRelatedTags](./x-components.createrelatedtagsquerygetteroptions.getrelatedtags.md)
|
|
4
|
+
|
|
5
|
+
## CreateRelatedTagsQueryGetterOptions.getRelatedTags property
|
|
6
|
+
|
|
7
|
+
Retrieves the selected related tags of the module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getRelatedTags: (state: State, getters: Getters) => RelatedTag[];
|
|
13
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [CreateRelatedTagsQueryGetterOptions](./x-components.createrelatedtagsquerygetteroptions.md)
|
|
4
|
+
|
|
5
|
+
## CreateRelatedTagsQueryGetterOptions interface
|
|
6
|
+
|
|
7
|
+
Options to create a getter that combines the query with the selected related tags.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface CreateRelatedTagsQueryGetterOptions<State, Getters>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [getRelatedTags](./x-components.createrelatedtagsquerygetteroptions.getrelatedtags.md) | | (state: State, getters: Getters) => RelatedTag\[\] | Retrieves the selected related tags of the module. |
|
|
20
|
+
|
|
@@ -11,7 +11,7 @@ Empathize store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface EmpathizeMutations extends ConfigMutations<EmpathizeState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** ConfigMutations
|
|
14
|
+
**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- --><[EmpathizeState](./x-components.empathizestate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Facets store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** QueryMutations
|
|
14
|
+
**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[FacetsState](./x-components.facetsstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ HistoryQueries store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface HistoryQueriesMutations extends QueryMutations, ConfigMutations<HistoryQueriesState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** QueryMutations
|
|
14
|
+
**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[HistoryQueriesState](./x-components.historyqueriesstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ IdentifierResults store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface IdentifierResultsMutations extends StatusMutations, QueryMutations, ConfigMutations<IdentifierResultsState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[IdentifierResultsState](./x-components.identifierresultsstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ IdentifierResults store state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface IdentifierResultsState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -32,6 +32,7 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
32
32
|
| [clone(something)](./x-components.clone.md) | Deeply clones an object or an array. |
|
|
33
33
|
| [createFetchAndSaveActions({ fetch, onSuccess, onError, onCancel })](./x-components.createfetchandsaveactions.md) | Utility to create an action that requests and save some data asynchronously, with the option to cancel the request at any moment. This factory provides with the standard flow for requesting, cancelling, handling errors for a module, while also taking care of its status. |
|
|
34
34
|
| [createRawFilters(filterIds)](./x-components.createrawfilters.md) | Helper method which creates the filter entity from the filter ir of the url. |
|
|
35
|
+
| [createRelatedTagsQueryGetter({ getRelatedTags })](./x-components.createrelatedtagsquerygetter.md) | Creates a getter that combines the current selected related tags and the query of the module. |
|
|
35
36
|
| [createSetQueryTaggingFromQueryPreview()](./x-components.createsetquerytaggingfromquerypreview.md) | Factory helper to create a wire to set the queryTagging. |
|
|
36
37
|
| [createStoreEmitters(storeModule, emitters)](./x-components.createstoreemitters.md) | Helper function for creating type-safe [StoreEmitters](./x-components.storeemitters.md)<!-- -->. |
|
|
37
38
|
| [createTrackDisplayWire(property)](./x-components.createtrackdisplaywire.md) | Factory helper to create a wire for the track of the display click. |
|
|
@@ -62,6 +63,7 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
62
63
|
| [isStringEmpty(str)](./x-components.isstringempty.md) | Util used to return true if the string is empty, undefined or null. |
|
|
63
64
|
| [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. |
|
|
64
65
|
| [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. |
|
|
66
|
+
| [mergeConfig(state, config)](./x-components.mergeconfig.md) | Merges a new config with the current one. Can be used as a mutation. |
|
|
65
67
|
| [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. |
|
|
66
68
|
| [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. |
|
|
67
69
|
| [namespacedWireCommit(moduleName)](./x-components.namespacedwirecommit.md) | Creates a namespaced [wireCommit()](./x-components.wirecommit.md) for the module name passed. |
|
|
@@ -69,6 +71,8 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
69
71
|
| [namespacedWireDispatch(moduleName)](./x-components.namespacedwiredispatch.md) | Creates a namespaced [wireDispatch()](./x-components.wiredispatch.md) for the module name passed. |
|
|
70
72
|
| [namespacedWireDispatchWithoutPayload(moduleName)](./x-components.namespacedwiredispatchwithoutpayload.md) | Creates a namespaced [wireDispatchWithoutPayload()](./x-components.wiredispatchwithoutpayload.md) for the module name passed. |
|
|
71
73
|
| [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. |
|
|
74
|
+
| [setConfig(state, config)](./x-components.setconfig.md) | Sets the request config. Can be used as a mutation. |
|
|
75
|
+
| [setQuery(state, query)](./x-components.setquery.md) | Sets the query of the module. |
|
|
72
76
|
| [setStatus(state, status)](./x-components.setstatus.md) | Sets the request status. Can be used as a mutation. |
|
|
73
77
|
| [setupDevtools(app)](./x-components.setupdevtools.md) | **_(BETA)_** Setups a plugin for the Vue's devtools adding: - [XEvent](./x-components.xevent.md)<!-- -->s timeline. Every event is recorded in time, and its payload and metadata can be inspected. - Wiring inspector. Events and its wires can be viewed and disabled. |
|
|
74
78
|
| [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. |
|
|
@@ -101,6 +105,8 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
101
105
|
|
|
102
106
|
| Interface | Description |
|
|
103
107
|
| --- | --- |
|
|
108
|
+
| [ConfigMutations](./x-components.configmutations.md) | Config mutations, containing a method to change the current config and other to merge a new one. |
|
|
109
|
+
| [CreateRelatedTagsQueryGetterOptions](./x-components.createrelatedtagsquerygetteroptions.md) | Options to create a getter that combines the query with the selected related tags. |
|
|
104
110
|
| [DebouncedFunction](./x-components.debouncedfunction.md) | The type returned by the [debounce()](./x-components.debounce.md) function. Basically is the function the [debounce()](./x-components.debounce.md) receives but debounced and with a method <code>cancel()</code> to cancel pending timeouts. |
|
|
105
111
|
| [DebounceOptions](./x-components.debounceoptions.md) | Debounce options for the strategies that the debounce would use. |
|
|
106
112
|
| [DeviceActions](./x-components.deviceactions.md) | Device store actions. |
|
|
@@ -178,9 +184,11 @@ X-Components is a library usable everywhere not only for search experiences.
|
|
|
178
184
|
| [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) | QueriesPreview store mutations. |
|
|
179
185
|
| [QueriesPreviewState](./x-components.queriespreviewstate.md) | QueriesPreview store state. |
|
|
180
186
|
| [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) | Dictionary of the events of QueriesPreview XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
|
|
187
|
+
| [QueryMutations](./x-components.querymutations.md) | The [QueryState](./x-components.querystate.md) mutations. |
|
|
181
188
|
| [QueryPreviewInfo](./x-components.querypreviewinfo.md) | Information to render or request a query preview with. |
|
|
182
189
|
| [QueryPreviewItem](./x-components.querypreviewitem.md) | QueriesPreview store state. |
|
|
183
190
|
| [QueryPreviewStatusPayload](./x-components.querypreviewstatuspayload.md) | Payload to use in the <code>setStatus</code> mutation. |
|
|
191
|
+
| [QueryState](./x-components.querystate.md) | Query state type, containing a property to hold the current query of the module. |
|
|
184
192
|
| [QuerySuggestionsActions](./x-components.querysuggestionsactions.md) | QuerySuggestions store actions. |
|
|
185
193
|
| [QuerySuggestionsConfig](./x-components.querysuggestionsconfig.md) | Configuration options for the [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md)<!-- -->. |
|
|
186
194
|
| [QuerySuggestionsGetters](./x-components.querysuggestionsgetters.md) | QuerySuggestions store getters. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [mergeConfig](./x-components.mergeconfig.md)
|
|
4
|
+
|
|
5
|
+
## mergeConfig() function
|
|
6
|
+
|
|
7
|
+
Merges a new config with the current one. Can be used as a mutation.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function mergeConfig<T extends {
|
|
13
|
+
config: T['config'];
|
|
14
|
+
}>(state: T, config: Partial<T['config']>): void;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| state | T | The [state](https://vuex.vuejs.org/guide/state.html) provided by Vuex. |
|
|
22
|
+
| config | Partial<T\['config'\]> | The config to be merged. |
|
|
23
|
+
|
|
24
|
+
**Returns:**
|
|
25
|
+
|
|
26
|
+
void
|
|
27
|
+
|
|
@@ -11,7 +11,7 @@ Next queries module mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface NextQueriesMutations extends StatusMutations, QueryMutations, ConfigMutations<NextQueriesState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[NextQueriesState](./x-components.nextqueriesstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Next queries module state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface NextQueriesState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Popular searches module mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface PopularSearchesMutations extends StatusMutations, ConfigMutations<PopularSearchesState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, ConfigMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[PopularSearchesState](./x-components.popularsearchesstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ QueriesPreview store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface QueriesPreviewMutations extends ConfigMutations<QueriesPreviewState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** ConfigMutations
|
|
14
|
+
**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- --><[QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryMutations](./x-components.querymutations.md)
|
|
4
|
+
|
|
5
|
+
## QueryMutations interface
|
|
6
|
+
|
|
7
|
+
The [QueryState](./x-components.querystate.md) mutations.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface QueryMutations
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
| Method | Description |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| [setQuery(query)](./x-components.querymutations.setquery.md) | Sets the query. |
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryMutations](./x-components.querymutations.md) > [setQuery](./x-components.querymutations.setquery.md)
|
|
4
|
+
|
|
5
|
+
## QueryMutations.setQuery() method
|
|
6
|
+
|
|
7
|
+
Sets the query.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setQuery(query: string): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| query | string | The new query. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
void
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryState](./x-components.querystate.md)
|
|
4
|
+
|
|
5
|
+
## QueryState interface
|
|
6
|
+
|
|
7
|
+
Query state type, containing a property to hold the current query of the module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface QueryState
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [query](./x-components.querystate.query.md) | | string | The query of the module. Different modules may have queries that differ in value or time. |
|
|
20
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryState](./x-components.querystate.md) > [query](./x-components.querystate.query.md)
|
|
4
|
+
|
|
5
|
+
## QueryState.query property
|
|
6
|
+
|
|
7
|
+
The query of the module. Different modules may have queries that differ in value or time.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
query: string;
|
|
13
|
+
```
|
|
@@ -11,7 +11,7 @@ QuerySuggestions store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface QuerySuggestionsMutations extends StatusMutations, QueryMutations, ConfigMutations<QuerySuggestionsState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[QuerySuggestionsState](./x-components.querysuggestionsstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ QuerySuggestions store state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface QuerySuggestionsState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Recommendations store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface RecommendationsMutations extends StatusMutations, ConfigMutations<RecommendationsState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, ConfigMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[RecommendationsState](./x-components.recommendationsstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Related prompts module mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface RelatedPromptsMutations extends StatusMutations, QueryMutations
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Related prompts module state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface RelatedPromptsState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ RelatedTags store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface RelatedTagsMutations extends StatusMutations, QueryMutations, ConfigMutations<RelatedTagsState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[RelatedTagsState](./x-components.relatedtagsstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ RelatedTags store state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface RelatedTagsState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Search store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface SearchMutations extends StatusMutations, QueryMutations, ConfigMutations<SearchState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, QueryMutations
|
|
14
|
+
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[SearchState](./x-components.searchstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ Search store state.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface SearchState extends StatusState, QueryState
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, QueryState
|
|
14
|
+
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -11,7 +11,7 @@ SemanticQueries store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface SemanticQueriesMutations extends QueryMutations, ConfigMutations<SemanticQueriesState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** QueryMutations
|
|
14
|
+
**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[SemanticQueriesState](./x-components.semanticqueriesstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setConfig](./x-components.setconfig.md)
|
|
4
|
+
|
|
5
|
+
## setConfig() function
|
|
6
|
+
|
|
7
|
+
Sets the request config. Can be used as a mutation.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function setConfig<T extends {
|
|
13
|
+
config: T['config'];
|
|
14
|
+
}>(state: T, config: T['config']): void;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| state | T | The [state](https://vuex.vuejs.org/guide/state.html) provided by Vuex. |
|
|
22
|
+
| config | T\['config'\] | The new config. |
|
|
23
|
+
|
|
24
|
+
**Returns:**
|
|
25
|
+
|
|
26
|
+
void
|
|
27
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setQuery](./x-components.setquery.md)
|
|
4
|
+
|
|
5
|
+
## setQuery() function
|
|
6
|
+
|
|
7
|
+
Sets the query of the module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function setQuery(state: QueryState, query: string): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| state | [QueryState](./x-components.querystate.md) | State of the module. |
|
|
20
|
+
| query | string | The new query to set. |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
void
|
|
25
|
+
|
|
@@ -11,7 +11,7 @@ Tagging store mutations.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface TaggingMutations extends ConfigMutations<TaggingState>
|
|
13
13
|
```
|
|
14
|
-
**Extends:** ConfigMutations
|
|
14
|
+
**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- --><[TaggingState](./x-components.taggingstate.md)<!-- -->>
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|