@empathyco/x-components 6.0.0-alpha.16 → 6.0.0-alpha.18
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 +23 -0
- package/design-system/deprecated-full-theme.css +361 -361
- package/docs/API-reference/api/x-components.animationprop.md +6 -1
- package/docs/API-reference/api/x-components.bannerslist.md +3 -3
- package/docs/API-reference/api/x-components.basedropdown.md +3 -3
- package/docs/API-reference/api/x-components.baseeventsmodal.md +2 -2
- package/docs/API-reference/api/x-components.basegrid.md +3 -3
- package/docs/API-reference/api/x-components.baseheadertogglepanel.md +3 -3
- package/docs/API-reference/api/x-components.baseidmodal.md +2 -2
- package/docs/API-reference/api/x-components.baseidtogglepanel.md +3 -3
- package/docs/API-reference/api/x-components.basemodal.md +6 -6
- package/docs/API-reference/api/x-components.baseresultimage.md +9 -9
- package/docs/API-reference/api/x-components.basesuggestions.md +3 -3
- package/docs/API-reference/api/x-components.basetabspanel.md +6 -6
- package/docs/API-reference/api/x-components.basetogglepanel.md +3 -3
- package/docs/API-reference/api/x-components.basevariablecolumngrid.md +3 -3
- package/docs/API-reference/api/x-components.empathize.md +3 -3
- package/docs/API-reference/api/x-components.facets.md +3 -3
- package/docs/API-reference/api/x-components.filterslist.md +3 -3
- package/docs/API-reference/api/x-components.globalxbus.md +4 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +4 -2
- package/docs/API-reference/api/x-components.identifierresults.md +3 -3
- package/docs/API-reference/api/x-components.itemslist.md +3 -3
- package/docs/API-reference/api/x-components.mainmodal.md +2 -2
- package/docs/API-reference/api/x-components.multicolumnmaxwidthlayout.md +3 -3
- package/docs/API-reference/api/x-components.myhistory.md +3 -3
- package/docs/API-reference/api/x-components.nextquerieslist.md +3 -3
- package/docs/API-reference/api/x-components.partialresultslist.md +3 -3
- package/docs/API-reference/api/x-components.promotedslist.md +3 -3
- package/docs/API-reference/api/x-components.querypreviewlist.md +3 -3
- package/docs/API-reference/api/x-components.recommendations.md +3 -3
- package/docs/API-reference/api/x-components.relatedpromptslist.md +3 -3
- package/docs/API-reference/api/x-components.relatedpromptsmutations.md +2 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedprompt.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedquery.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.md +2 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.selectedprompt.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.selectedquery.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.md +2 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedprompt.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md +13 -0
- package/docs/API-reference/api/x-components.relatedtags.md +3 -3
- package/docs/API-reference/api/x-components.resultslist.md +3 -3
- package/docs/API-reference/api/x-components.scrolltotop.md +3 -3
- package/docs/API-reference/api/x-components.searchinputplaceholder.md +3 -3
- package/docs/API-reference/api/x-components.selectedfilterslist.md +3 -3
- package/docs/API-reference/api/x-components.simplefilter.md +2 -0
- package/docs/API-reference/api/x-components.singlecolumnlayout.md +3 -3
- package/docs/API-reference/api/x-components.snippetcallbacks.md +2 -0
- package/docs/API-reference/components/common/result/x-components.base-result-image.md +2 -2
- package/docs/API-reference/components/common/x-components.items-list.md +1 -1
- package/docs/API-reference/components/facets/x-components.facets/facets.md +1 -1
- package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md +1 -1
- package/docs/API-reference/components/search/x-components.results-list.md +1 -1
- package/js/components/items-list.vue.js.map +1 -1
- package/js/components/items-list.vue2.js +2 -2
- package/js/components/items-list.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 +3 -3
- package/js/components/result/base-result-image.vue2.js.map +1 -1
- package/js/types/animation-prop.js +5 -0
- package/js/types/animation-prop.js.map +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 +2 -2
- package/js/x-modules/facets/components/facets/facets.vue2.js.map +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 +2 -2
- package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js.map +1 -1
- package/js/x-modules/related-prompts/store/module.js +10 -0
- package/js/x-modules/related-prompts/store/module.js.map +1 -1
- package/js/x-modules/related-prompts/wiring.js +14 -0
- package/js/x-modules/related-prompts/wiring.js.map +1 -1
- package/js/x-modules/search/components/results-list.vue.js +2 -2
- package/js/x-modules/search/components/results-list.vue.js.map +1 -1
- package/package.json +2 -2
- package/report/x-components.api.json +1904 -7485
- package/report/x-components.api.md +155 -133
- package/types/components/base-dropdown.vue.d.ts +3 -3
- package/types/components/base-grid.vue.d.ts +3 -3
- package/types/components/base-variable-column-grid.vue.d.ts +3 -3
- package/types/components/global-x-bus.vue.d.ts +4 -0
- package/types/components/global-x-bus.vue.d.ts.map +1 -1
- package/types/components/items-list.vue.d.ts +3 -3
- package/types/components/layouts/multi-column-max-width-layout.vue.d.ts +3 -3
- package/types/components/layouts/single-column-layout.vue.d.ts +3 -3
- package/types/components/modals/base-events-modal.vue.d.ts +2 -2
- package/types/components/modals/base-id-modal.vue.d.ts +2 -2
- package/types/components/modals/base-modal.vue.d.ts +6 -6
- package/types/components/modals/main-modal.vue.d.ts +2 -2
- package/types/components/panels/base-header-toggle-panel.vue.d.ts +3 -3
- package/types/components/panels/base-id-toggle-panel.vue.d.ts +3 -3
- package/types/components/panels/base-tabs-panel.vue.d.ts +6 -6
- package/types/components/panels/base-toggle-panel.vue.d.ts +3 -3
- package/types/components/result/base-result-image.vue.d.ts +10 -10
- package/types/components/result/base-result-image.vue.d.ts.map +1 -1
- package/types/components/snippet-callbacks.vue.d.ts +2 -0
- package/types/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/components/suggestions/base-suggestions.vue.d.ts +3 -3
- package/types/types/animation-prop.d.ts +6 -2
- package/types/types/animation-prop.d.ts.map +1 -1
- package/types/x-modules/empathize/components/empathize.vue.d.ts +3 -3
- package/types/x-modules/facets/components/facets/facets.vue.d.ts +3 -3
- package/types/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +4 -2
- package/types/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/filters/simple-filter.vue.d.ts +2 -0
- package/types/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/lists/filters-list.vue.d.ts +3 -3
- package/types/x-modules/facets/components/lists/selected-filters-list.vue.d.ts +3 -3
- package/types/x-modules/history-queries/components/my-history.vue.d.ts +3 -3
- package/types/x-modules/identifier-results/components/identifier-results.vue.d.ts +3 -3
- package/types/x-modules/next-queries/components/next-queries-list.vue.d.ts +3 -3
- package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts +3 -3
- package/types/x-modules/recommendations/components/recommendations.vue.d.ts +3 -3
- package/types/x-modules/related-prompts/components/related-prompts-list.vue.d.ts +3 -3
- package/types/x-modules/related-prompts/events.types.d.ts +10 -0
- package/types/x-modules/related-prompts/events.types.d.ts.map +1 -1
- package/types/x-modules/related-prompts/store/module.d.ts.map +1 -1
- package/types/x-modules/related-prompts/store/types.d.ts +16 -0
- package/types/x-modules/related-prompts/store/types.d.ts.map +1 -1
- package/types/x-modules/related-prompts/wiring.d.ts +6 -0
- package/types/x-modules/related-prompts/wiring.d.ts.map +1 -1
- package/types/x-modules/related-tags/components/related-tags.vue.d.ts +3 -3
- package/types/x-modules/scroll/components/scroll-to-top.vue.d.ts +3 -3
- package/types/x-modules/search/components/banners-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/partial-results-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/promoteds-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/results-list.vue.d.ts +3 -3
- package/types/x-modules/search-box/components/search-input-placeholder.vue.d.ts +3 -3
- package/js/utils/options-api.js +0 -4
- package/js/utils/options-api.js.map +0 -1
- package/types/utils/options-api.d.ts +0 -3
- package/types/utils/options-api.d.ts.map +0 -1
|
@@ -11,7 +11,7 @@ A specialised version of a modal component, made to contain a full search applic
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
};
|
|
16
16
|
closeEvents: {
|
|
17
17
|
type: PropType<(keyof import("../../wiring/events.types").XEventsTypes)[]>;
|
|
@@ -31,7 +31,7 @@ _default: import("vue").DefineComponent<{
|
|
|
31
31
|
};
|
|
32
32
|
}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
33
33
|
animation: {
|
|
34
|
-
type:
|
|
34
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
35
35
|
};
|
|
36
36
|
closeEvents: {
|
|
37
37
|
type: PropType<(keyof import("../../wiring/events.types").XEventsTypes)[]>;
|
|
@@ -16,18 +16,18 @@ Component for use as Layout to be filled with the rest of the Components.
|
|
|
16
16
|
```typescript
|
|
17
17
|
_default: import("vue").DefineComponent<{
|
|
18
18
|
asideAnimation: {
|
|
19
|
-
type:
|
|
19
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
20
20
|
default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
21
21
|
};
|
|
22
22
|
devMode: BooleanConstructor;
|
|
23
23
|
}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
24
24
|
asideAnimation: {
|
|
25
|
-
type:
|
|
25
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
26
|
default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
27
27
|
};
|
|
28
28
|
devMode: BooleanConstructor;
|
|
29
29
|
}>>, {
|
|
30
|
-
asideAnimation: string |
|
|
30
|
+
asideAnimation: string | Function | Record<string, any>;
|
|
31
31
|
devMode: boolean;
|
|
32
32
|
}, {}>
|
|
33
33
|
```
|
|
@@ -11,7 +11,7 @@ The component renders the full history of user searched queries grouped by the d
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
locale: {
|
|
@@ -26,7 +26,7 @@ _default: import("vue").DefineComponent<{
|
|
|
26
26
|
formatTime: (timestamp: number) => string;
|
|
27
27
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
28
28
|
animation: {
|
|
29
|
-
type:
|
|
29
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
30
30
|
default: string;
|
|
31
31
|
};
|
|
32
32
|
locale: {
|
|
@@ -35,7 +35,7 @@ _default: import("vue").DefineComponent<{
|
|
|
35
35
|
};
|
|
36
36
|
queriesListClass: StringConstructor;
|
|
37
37
|
}>>, {
|
|
38
|
-
animation: string |
|
|
38
|
+
animation: string | Function | Record<string, any>;
|
|
39
39
|
locale: string;
|
|
40
40
|
}, {}>
|
|
41
41
|
```
|
|
@@ -11,7 +11,7 @@ Component that inserts groups of next queries in different positions of the inje
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
offset: {
|
|
@@ -35,7 +35,7 @@ _default: import("vue").DefineComponent<{
|
|
|
35
35
|
[key: string]: any;
|
|
36
36
|
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
37
37
|
animation: {
|
|
38
|
-
type:
|
|
38
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
39
39
|
default: string;
|
|
40
40
|
};
|
|
41
41
|
offset: {
|
|
@@ -56,7 +56,7 @@ _default: import("vue").DefineComponent<{
|
|
|
56
56
|
default: boolean;
|
|
57
57
|
};
|
|
58
58
|
}>>, {
|
|
59
|
-
animation: string |
|
|
59
|
+
animation: string | Function | Record<string, any>;
|
|
60
60
|
offset: number;
|
|
61
61
|
frequency: number;
|
|
62
62
|
maxNextQueriesPerGroup: number;
|
|
@@ -11,7 +11,7 @@ It renders a list of partial results from [SearchState.partialResults](./x-compo
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
maxItemsToRender: {
|
|
@@ -22,7 +22,7 @@ _default: import("vue").DefineComponent<{
|
|
|
22
22
|
partialResults: ComputedRef<PartialResult[]>;
|
|
23
23
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
24
24
|
animation: {
|
|
25
|
-
type:
|
|
25
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
26
|
default: string;
|
|
27
27
|
};
|
|
28
28
|
maxItemsToRender: {
|
|
@@ -30,7 +30,7 @@ _default: import("vue").DefineComponent<{
|
|
|
30
30
|
default: number;
|
|
31
31
|
};
|
|
32
32
|
}>>, {
|
|
33
|
-
animation: string |
|
|
33
|
+
animation: string | Function | Record<string, any>;
|
|
34
34
|
maxItemsToRender: number;
|
|
35
35
|
}, {}>
|
|
36
36
|
```
|
|
@@ -15,17 +15,17 @@ It also provides the parent slots to customize the items.
|
|
|
15
15
|
```typescript
|
|
16
16
|
_default: import("vue").DefineComponent<{
|
|
17
17
|
animation: {
|
|
18
|
-
type:
|
|
18
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
19
19
|
default: string;
|
|
20
20
|
};
|
|
21
21
|
}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
22
22
|
[key: string]: any;
|
|
23
23
|
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
24
24
|
animation: {
|
|
25
|
-
type:
|
|
25
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
26
|
default: string;
|
|
27
27
|
};
|
|
28
28
|
}>>, {
|
|
29
|
-
animation: string |
|
|
29
|
+
animation: string | Function | Record<string, any>;
|
|
30
30
|
}, {}>
|
|
31
31
|
```
|
|
@@ -26,7 +26,7 @@ _default: import("vue").DefineComponent<{
|
|
|
26
26
|
};
|
|
27
27
|
persistInCache: BooleanConstructor;
|
|
28
28
|
animation: {
|
|
29
|
-
type:
|
|
29
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
30
30
|
default: string;
|
|
31
31
|
};
|
|
32
32
|
}, {
|
|
@@ -50,12 +50,12 @@ _default: import("vue").DefineComponent<{
|
|
|
50
50
|
};
|
|
51
51
|
persistInCache: BooleanConstructor;
|
|
52
52
|
animation: {
|
|
53
|
-
type:
|
|
53
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
54
54
|
default: string;
|
|
55
55
|
};
|
|
56
56
|
}>>, {
|
|
57
57
|
debounceTimeMs: number;
|
|
58
58
|
persistInCache: boolean;
|
|
59
|
-
animation: string |
|
|
59
|
+
animation: string | Function | Record<string, any>;
|
|
60
60
|
}, {}>
|
|
61
61
|
```
|
|
@@ -11,7 +11,7 @@ It renders a list of recommendations from the [RecommendationsState.recommendati
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
maxItemsToRender: NumberConstructor;
|
|
@@ -19,11 +19,11 @@ _default: import("vue").DefineComponent<{
|
|
|
19
19
|
recommendations: ComputedRef<Result[]>;
|
|
20
20
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
21
21
|
animation: {
|
|
22
|
-
type:
|
|
22
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
23
23
|
default: string;
|
|
24
24
|
};
|
|
25
25
|
maxItemsToRender: NumberConstructor;
|
|
26
26
|
}>>, {
|
|
27
|
-
animation: string |
|
|
27
|
+
animation: string | Function | Record<string, any>;
|
|
28
28
|
}, {}>
|
|
29
29
|
```
|
|
@@ -11,7 +11,7 @@ Component that inserts groups of related prompts in different positions of the i
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
offset: {
|
|
@@ -38,7 +38,7 @@ _default: import("vue").DefineComponent<{
|
|
|
38
38
|
[key: string]: any;
|
|
39
39
|
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
40
40
|
animation: {
|
|
41
|
-
type:
|
|
41
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
42
42
|
default: string;
|
|
43
43
|
};
|
|
44
44
|
offset: {
|
|
@@ -62,7 +62,7 @@ _default: import("vue").DefineComponent<{
|
|
|
62
62
|
default: boolean;
|
|
63
63
|
};
|
|
64
64
|
}>>, {
|
|
65
|
-
animation: string |
|
|
65
|
+
animation: string | Function | Record<string, any>;
|
|
66
66
|
offset: number;
|
|
67
67
|
frequency: number;
|
|
68
68
|
maxRelatedPromptsPerGroup: number;
|
|
@@ -20,4 +20,6 @@ export interface RelatedPromptsMutations extends StatusMutations, QueryMutations
|
|
|
20
20
|
| [resetRelatedPromptsState()](./x-components.relatedpromptsmutations.resetrelatedpromptsstate.md) | Resets the related prompts state. |
|
|
21
21
|
| [setParams(params)](./x-components.relatedpromptsmutations.setparams.md) | Sets the extra params of the module. |
|
|
22
22
|
| [setRelatedPromptsProducts(products)](./x-components.relatedpromptsmutations.setrelatedpromptsproducts.md) | Sets the related prompts of the module. |
|
|
23
|
+
| [setSelectedPrompt(index)](./x-components.relatedpromptsmutations.setselectedprompt.md) | Sets the selected related prompt. |
|
|
24
|
+
| [setSelectedQuery(index)](./x-components.relatedpromptsmutations.setselectedquery.md) | Sets the selected next query. |
|
|
23
25
|
|
|
@@ -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) > [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) > [setSelectedPrompt](./x-components.relatedpromptsmutations.setselectedprompt.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsMutations.setSelectedPrompt() method
|
|
6
|
+
|
|
7
|
+
Sets the selected related prompt.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setSelectedPrompt(index: number): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| index | number | The new selected related prompt. |
|
|
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) > [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) > [setSelectedQuery](./x-components.relatedpromptsmutations.setselectedquery.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsMutations.setSelectedQuery() method
|
|
6
|
+
|
|
7
|
+
Sets the selected next query.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setSelectedQuery(index: number): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| index | number | The new selected next query. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
void
|
|
24
|
+
|
|
@@ -19,4 +19,6 @@ export interface RelatedPromptsState extends StatusState, QueryState
|
|
|
19
19
|
| --- | --- | --- | --- |
|
|
20
20
|
| [params](./x-components.relatedpromptsstate.params.md) | | Dictionary<unknown> | The extra params property of the state. |
|
|
21
21
|
| [relatedPrompts](./x-components.relatedpromptsstate.relatedprompts.md) | | RelatedPrompt\[\] | The list of the related-prompts, related to the <code>query</code> property of the state. |
|
|
22
|
+
| [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md) | | number | The index of the selected related-prompt. |
|
|
23
|
+
| [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md) | | number | The index of the selected next query. |
|
|
22
24
|
|
|
@@ -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) > [RelatedPromptsState](./x-components.relatedpromptsstate.md) > [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsState.selectedPrompt property
|
|
6
|
+
|
|
7
|
+
The index of the selected related-prompt.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
selectedPrompt: number;
|
|
13
|
+
```
|
|
@@ -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) > [RelatedPromptsState](./x-components.relatedpromptsstate.md) > [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsState.selectedQuery property
|
|
6
|
+
|
|
7
|
+
The index of the selected next query.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
selectedQuery: number;
|
|
13
|
+
```
|
|
@@ -17,4 +17,6 @@ export interface RelatedPromptsXEvents
|
|
|
17
17
|
| Property | Modifiers | Type | Description |
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
19
|
| [RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md) | | RelatedPromptsRequest \| null | Any property of the related-prompts request has changed Payload: The new related-prompts request or <code>null</code> if there is not enough data in the state to conform a valid request. |
|
|
20
|
+
| [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md) | | number | The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection. |
|
|
21
|
+
| [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md) | | number | The selected next query of the selected prompt has changed. Payload: The index of the next query in the NextQueries list or -1 to remove selection. |
|
|
20
22
|
|
package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedprompt.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) > [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md) > [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsXEvents.UserSelectedARelatedPrompt property
|
|
6
|
+
|
|
7
|
+
The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
UserSelectedARelatedPrompt: number;
|
|
13
|
+
```
|
package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedpromptquery.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) > [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md) > [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsXEvents.UserSelectedARelatedPromptQuery property
|
|
6
|
+
|
|
7
|
+
The selected next query of the selected prompt has changed. Payload: The index of the next query in the NextQueries list or -1 to remove selection.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
UserSelectedARelatedPromptQuery: number;
|
|
13
|
+
```
|
|
@@ -11,7 +11,7 @@ This component renders a set of \[`RelatedTag`<!-- -->\](./x-components.related-
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: string;
|
|
16
16
|
};
|
|
17
17
|
maxItemsToRender: NumberConstructor;
|
|
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
|
|
|
24
24
|
relatedTags: ComputedRef<RelatedTagModel[]>;
|
|
25
25
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
26
26
|
animation: {
|
|
27
|
-
type:
|
|
27
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
28
28
|
default: string;
|
|
29
29
|
};
|
|
30
30
|
maxItemsToRender: NumberConstructor;
|
|
@@ -34,7 +34,7 @@ _default: import("vue").DefineComponent<{
|
|
|
34
34
|
};
|
|
35
35
|
itemClass: StringConstructor;
|
|
36
36
|
}>>, {
|
|
37
|
-
animation: string |
|
|
37
|
+
animation: string | Function | Record<string, any>;
|
|
38
38
|
highlightCurated: boolean;
|
|
39
39
|
}, {}>
|
|
40
40
|
```
|
|
@@ -15,19 +15,19 @@ It also provides the slot result to customize the item, which is within the defa
|
|
|
15
15
|
```typescript
|
|
16
16
|
_default: import("vue").DefineComponent<{
|
|
17
17
|
animation: {
|
|
18
|
-
type:
|
|
18
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
19
19
|
default: string;
|
|
20
20
|
};
|
|
21
21
|
}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
22
22
|
[key: string]: any;
|
|
23
23
|
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "UserReachedResultsListEnd"[], "UserReachedResultsListEnd", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
24
24
|
animation: {
|
|
25
|
-
type:
|
|
25
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
26
|
default: string;
|
|
27
27
|
};
|
|
28
28
|
}>> & {
|
|
29
29
|
onUserReachedResultsListEnd?: ((...args: any[]) => any) | undefined;
|
|
30
30
|
}, {
|
|
31
|
-
animation: string |
|
|
31
|
+
animation: string | Function | Record<string, any>;
|
|
32
32
|
}, {}>
|
|
33
33
|
```
|
|
@@ -11,7 +11,7 @@ The `ScrollToTop` component is a button that the user can click to make a contai
|
|
|
11
11
|
```typescript
|
|
12
12
|
_default: import("vue").DefineComponent<{
|
|
13
13
|
animation: {
|
|
14
|
-
type:
|
|
14
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
15
15
|
default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
16
16
|
};
|
|
17
17
|
thresholdPx: NumberConstructor;
|
|
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
|
|
|
24
24
|
isVisible: import("vue").ComputedRef<any>;
|
|
25
25
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
26
26
|
animation: {
|
|
27
|
-
type:
|
|
27
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
28
28
|
default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
29
29
|
};
|
|
30
30
|
thresholdPx: NumberConstructor;
|
|
@@ -33,7 +33,7 @@ _default: import("vue").DefineComponent<{
|
|
|
33
33
|
default: string;
|
|
34
34
|
};
|
|
35
35
|
}>>, {
|
|
36
|
-
animation: string |
|
|
36
|
+
animation: string | Function | Record<string, any>;
|
|
37
37
|
scrollId: string;
|
|
38
38
|
}, {}>
|
|
39
39
|
```
|
|
@@ -15,7 +15,7 @@ _default: import("vue").DefineComponent<{
|
|
|
15
15
|
required: true;
|
|
16
16
|
};
|
|
17
17
|
animation: {
|
|
18
|
-
type:
|
|
18
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
19
19
|
default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
20
20
|
};
|
|
21
21
|
animationIntervalMs: {
|
|
@@ -32,7 +32,7 @@ _default: import("vue").DefineComponent<{
|
|
|
32
32
|
required: true;
|
|
33
33
|
};
|
|
34
34
|
animation: {
|
|
35
|
-
type:
|
|
35
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
36
36
|
default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
37
37
|
};
|
|
38
38
|
animationIntervalMs: {
|
|
@@ -41,7 +41,7 @@ _default: import("vue").DefineComponent<{
|
|
|
41
41
|
};
|
|
42
42
|
animateOnlyOnHover: BooleanConstructor;
|
|
43
43
|
}>>, {
|
|
44
|
-
animation: string |
|
|
44
|
+
animation: string | Function | Record<string, any>;
|
|
45
45
|
animationIntervalMs: number;
|
|
46
46
|
animateOnlyOnHover: boolean;
|
|
47
47
|
}, {}>
|
|
@@ -17,7 +17,7 @@ _default: import("vue").DefineComponent<{
|
|
|
17
17
|
facetsIds: PropType<(string | number)[]>;
|
|
18
18
|
alwaysVisible: BooleanConstructor;
|
|
19
19
|
animation: {
|
|
20
|
-
type:
|
|
20
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
21
21
|
default: string;
|
|
22
22
|
};
|
|
23
23
|
}, {
|
|
@@ -28,11 +28,11 @@ _default: import("vue").DefineComponent<{
|
|
|
28
28
|
facetsIds: PropType<(string | number)[]>;
|
|
29
29
|
alwaysVisible: BooleanConstructor;
|
|
30
30
|
animation: {
|
|
31
|
-
type:
|
|
31
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
32
32
|
default: string;
|
|
33
33
|
};
|
|
34
34
|
}>>, {
|
|
35
35
|
alwaysVisible: boolean;
|
|
36
|
-
animation: string |
|
|
36
|
+
animation: string | Function | Record<string, any>;
|
|
37
37
|
}, {}>
|
|
38
38
|
```
|
|
@@ -181,6 +181,8 @@ _default: import("vue").DefineComponent<{
|
|
|
181
181
|
PushableUrlStateUpdated?: import("../../../..").UrlParams | undefined;
|
|
182
182
|
ReplaceableUrlStateUpdated?: import("../../../..").UrlParams | undefined;
|
|
183
183
|
RelatedPromptsRequestUpdated?: import("@empathyco/x-types").RelatedPromptsRequest | null | undefined;
|
|
184
|
+
UserSelectedARelatedPrompt?: number | undefined;
|
|
185
|
+
UserSelectedARelatedPromptQuery?: number | undefined;
|
|
184
186
|
}>;
|
|
185
187
|
innerCssClasses: import("vue").ComputedRef<(string | Dictionary<boolean>)[]>;
|
|
186
188
|
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -16,18 +16,18 @@ Component for use as Layout to be filled with the rest of the Components.
|
|
|
16
16
|
```typescript
|
|
17
17
|
_default: import("vue").DefineComponent<{
|
|
18
18
|
asideAnimation: {
|
|
19
|
-
type:
|
|
19
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
20
20
|
default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
21
21
|
};
|
|
22
22
|
devMode: BooleanConstructor;
|
|
23
23
|
}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
24
24
|
asideAnimation: {
|
|
25
|
-
type:
|
|
25
|
+
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
26
|
default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
|
27
27
|
};
|
|
28
28
|
devMode: BooleanConstructor;
|
|
29
29
|
}>>, {
|
|
30
|
-
asideAnimation: string |
|
|
30
|
+
asideAnimation: string | Function | Record<string, any>;
|
|
31
31
|
devMode: boolean;
|
|
32
32
|
}, {}>
|
|
33
33
|
```
|
|
@@ -171,6 +171,8 @@ _default: import("vue").DefineComponent<{}, {
|
|
|
171
171
|
PushableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
|
|
172
172
|
ReplaceableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
|
|
173
173
|
RelatedPromptsRequestUpdated: (payload: import("@empathyco/x-types").RelatedPromptsRequest | null, metadata: WireMetadata) => unknown;
|
|
174
|
+
UserSelectedARelatedPrompt: (payload: number, metadata: WireMetadata) => unknown;
|
|
175
|
+
UserSelectedARelatedPromptQuery: (payload: number, metadata: WireMetadata) => unknown;
|
|
174
176
|
}>>;
|
|
175
177
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
|
|
176
178
|
```
|
|
@@ -13,8 +13,8 @@ Component to be reused that renders an `<img>`.
|
|
|
13
13
|
| Name | Description | Type | Default |
|
|
14
14
|
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------ |
|
|
15
15
|
| <code>result</code> | (Required) The @empathyco/x-types#Result information. | <code>Result</code> | <code></code> |
|
|
16
|
-
| <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>
|
|
17
|
-
| <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>
|
|
16
|
+
| <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>AnimationProp</code> | <code>() => NoAnimation</code> |
|
|
17
|
+
| <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>AnimationProp</code> | <code></code> |
|
|
18
18
|
| <code>showNextImageOnHover</code> | Indicates if the next valid image should be displayed on hover. | <code>boolean</code> | <code>false</code> |
|
|
19
19
|
|
|
20
20
|
## Slots
|
|
@@ -13,7 +13,7 @@ It renders a list of ListItem providing a slot for each `slotName` which depends
|
|
|
13
13
|
|
|
14
14
|
| Name | Description | Type | Default |
|
|
15
15
|
| ---------------------- | ---------------------------------------------------------- | -------------------------- | ----------------- |
|
|
16
|
-
| <code>animation</code> | Animation component that will be used to animate the list. | <code>
|
|
16
|
+
| <code>animation</code> | Animation component that will be used to animate the list. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
17
17
|
| <code>items</code> | List of items. | <code>ListItem[]</code> | <code></code> |
|
|
18
18
|
| <code>itemClass</code> | Item's classes. | <code>string</code> | <code></code> |
|
|
19
19
|
|
|
@@ -19,7 +19,7 @@ differently based on their purpose and this can be achieved using the exposed sl
|
|
|
19
19
|
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------- |
|
|
20
20
|
| <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
|
|
21
21
|
| <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
|
|
22
|
-
| <code>animation</code> | Animation component that will be used to animate the facets. | <code>
|
|
22
|
+
| <code>animation</code> | Animation component that will be used to animate the facets. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
23
23
|
| <code>renderableFacets</code> | Discriminates the facets rendered by this component. It expects a string containing facets<br />ids, comma separated. This property will include or exclude facets based on its value.<br />The default value is an empty string and the component will render all existing facets. | <code>string</code> | <code></code> |
|
|
24
24
|
|
|
25
25
|
## Slots
|
|
@@ -20,7 +20,7 @@ The property "alwaysVisible" handles if the component is rendered if no filters
|
|
|
20
20
|
| -------------------------- | --------------------------------------------------------------------------- | ------------------------------- | ----------------- |
|
|
21
21
|
| <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
|
|
22
22
|
| <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
|
|
23
|
-
| <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>
|
|
23
|
+
| <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
24
24
|
|
|
25
25
|
## Slots
|
|
26
26
|
|