@empathyco/x-components 3.0.0-alpha.415 → 3.0.0-alpha.417

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.
Files changed (77) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/core/index.js.map +1 -1
  3. package/design-system/deprecated-full-theme.css +44 -44
  4. package/docs/API-reference/api/x-components.cancelfetchandsavecontrols.md +13 -0
  5. package/docs/API-reference/api/x-components.experiencecontrols.md +22 -0
  6. package/docs/API-reference/api/x-components.experiencecontrols.oneventschanged.md +24 -0
  7. package/docs/API-reference/api/x-components.experiencecontrols.render.md +15 -0
  8. package/docs/API-reference/api/x-components.experiencecontrolsactioncontext.md +15 -0
  9. package/docs/API-reference/api/x-components.experiencecontrolsactions.fetchandsaveexperiencecontrolsresponse.md +24 -0
  10. package/docs/API-reference/api/x-components.experiencecontrolsactions.fetchexperiencecontrolsresponse.md +26 -0
  11. package/docs/API-reference/api/x-components.experiencecontrolsactions.md +21 -0
  12. package/docs/API-reference/api/x-components.experiencecontrolsgetters.experiencecontrolsrequest.md +13 -0
  13. package/docs/API-reference/api/x-components.experiencecontrolsgetters.md +20 -0
  14. package/docs/API-reference/api/x-components.experiencecontrolsmutations.md +23 -0
  15. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setcontrols.md +24 -0
  16. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setevents.md +24 -0
  17. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setparams.md +24 -0
  18. package/docs/API-reference/api/x-components.experiencecontrolsrequest.md +13 -0
  19. package/docs/API-reference/api/x-components.experiencecontrolsstate.controls.md +13 -0
  20. package/docs/API-reference/api/x-components.experiencecontrolsstate.events.md +11 -0
  21. package/docs/API-reference/api/x-components.experiencecontrolsstate.md +23 -0
  22. package/docs/API-reference/api/x-components.experiencecontrolsstate.params.md +11 -0
  23. package/docs/API-reference/api/x-components.experiencecontrolsxevents.experiencecontrolseventschanged.md +11 -0
  24. package/docs/API-reference/api/x-components.experiencecontrolsxevents.experiencecontrolsrequestupdated.md +11 -0
  25. package/docs/API-reference/api/x-components.experiencecontrolsxevents.md +21 -0
  26. package/docs/API-reference/api/x-components.experiencecontrolsxmodule.md +13 -0
  27. package/docs/API-reference/api/x-components.experiencecontrolsxstoremodule.md +15 -0
  28. package/docs/API-reference/api/x-components.fetchandsaveexperiencecontrolsresponse.md +13 -0
  29. package/docs/API-reference/api/x-components.fetchandsaveexperiencecontrolswire.md +13 -0
  30. package/docs/API-reference/api/x-components.fetchexperiencecontrolsresponse.md +13 -0
  31. package/docs/API-reference/api/x-components.md +15 -0
  32. package/docs/API-reference/api/x-components.xeventstypes.md +1 -1
  33. package/docs/API-reference/api/x-components.xmodulestree.md +1 -1
  34. package/experience-controls/index.d.ts +1 -0
  35. package/experience-controls/index.js +8 -0
  36. package/js/index.js +8 -0
  37. package/js/index.js.map +1 -1
  38. package/js/x-modules/experience-controls/components/experience-controls.vue.js +39 -0
  39. package/js/x-modules/experience-controls/components/experience-controls.vue.js.map +1 -0
  40. package/js/x-modules/experience-controls/components/experience-controls.vue_rollup-plugin-vue_script.vue.js +39 -0
  41. package/js/x-modules/experience-controls/components/experience-controls.vue_rollup-plugin-vue_script.vue.js.map +1 -0
  42. package/js/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.js +26 -0
  43. package/js/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.js.map +1 -0
  44. package/js/x-modules/experience-controls/store/actions/fetch-experience-controls.action.js +21 -0
  45. package/js/x-modules/experience-controls/store/actions/fetch-experience-controls.action.js.map +1 -0
  46. package/js/x-modules/experience-controls/store/emitters.js +17 -0
  47. package/js/x-modules/experience-controls/store/emitters.js.map +1 -0
  48. package/js/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.js +19 -0
  49. package/js/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.js.map +1 -0
  50. package/js/x-modules/experience-controls/store/module.js +43 -0
  51. package/js/x-modules/experience-controls/store/module.js.map +1 -0
  52. package/js/x-modules/experience-controls/wiring.js +44 -0
  53. package/js/x-modules/experience-controls/wiring.js.map +1 -0
  54. package/js/x-modules/experience-controls/x-module.js +19 -0
  55. package/js/x-modules/experience-controls/x-module.js.map +1 -0
  56. package/package.json +2 -2
  57. package/report/x-components.api.json +1083 -2
  58. package/report/x-components.api.md +95 -4
  59. package/types/index.d.ts +1 -0
  60. package/types/index.d.ts.map +1 -1
  61. package/types/store/utils/config-store.utils.d.ts +45 -0
  62. package/types/store/utils/config-store.utils.d.ts.map +1 -0
  63. package/types/x-modules/experience-controls/components/experience-controls.vue.d.ts +18 -0
  64. package/types/x-modules/experience-controls/components/experience-controls.vue.d.ts.map +1 -0
  65. package/types/x-modules/experience-controls/components/index.d.ts +2 -0
  66. package/types/x-modules/experience-controls/components/index.d.ts.map +1 -0
  67. package/types/x-modules/experience-controls/index.d.ts +6 -0
  68. package/types/x-modules/experience-controls/index.d.ts.map +1 -0
  69. package/types/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.d.ts +2 -2
  70. package/types/x-modules/experience-controls/store/actions/index.d.ts +3 -0
  71. package/types/x-modules/experience-controls/store/actions/index.d.ts.map +1 -0
  72. package/types/x-modules/experience-controls/store/getters/index.d.ts +2 -0
  73. package/types/x-modules/experience-controls/store/getters/index.d.ts.map +1 -0
  74. package/types/x-modules/experience-controls/store/index.d.ts +6 -0
  75. package/types/x-modules/experience-controls/store/index.d.ts.map +1 -0
  76. package/types/x-modules/experience-controls/store/types.d.ts +5 -0
  77. package/types/x-modules/experience-controls/store/types.d.ts.map +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,24 @@
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
+ ## [3.0.0-alpha.417](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.416...@empathyco/x-components@3.0.0-alpha.417) (2023-10-05)
7
+
8
+
9
+ ### Features
10
+
11
+ * utils for the mutation of states with config (#1313) ([97dfb3e](https://github.com/empathyco/x/commit/97dfb3e2d37f6ec037f55ccc3279b9427d90d1c5))
12
+
13
+
14
+
15
+ ## [3.0.0-alpha.416](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.415...@empathyco/x-components@3.0.0-alpha.416) (2023-10-05)
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * exports for experience controls (#1312) ([3f02cea](https://github.com/empathyco/x/commit/3f02cea34463b2fe13b539f348c4f42af1f2dc71))
21
+
22
+
23
+
6
24
  ## [3.0.0-alpha.415](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.414...@empathyco/x-components@3.0.0-alpha.415) (2023-10-04)
7
25
 
8
26
 
package/core/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  .x-uppercase {
4
3
  text-transform: uppercase;
5
4
  }
@@ -34,6 +33,7 @@
34
33
  -webkit-text-decoration-line: none;
35
34
  text-decoration-line: none;
36
35
  }
36
+
37
37
  .x-static {
38
38
  position: static !important;
39
39
  }
@@ -6761,49 +6761,6 @@
6761
6761
  --x-size-border-width-bottom-input-group-line: var(--x-size-border-width-input-group-line);
6762
6762
  --x-size-border-width-left-input-group-line: 0;
6763
6763
  }
6764
- :root {
6765
- --x-color-background-input-group-default: var(--x-color-background-input-default);
6766
- --x-color-border-input-group-default: var(--x-color-border-input-default);
6767
- --x-color-border-input-group-default-focus: var(--x-color-border-input-default-focus);
6768
- --x-color-text-input-group-default: var(--x-color-text-input-default);
6769
- --x-color-text-input-group-placeholder-default: var(--x-color-text-input-placeholder-default);
6770
- --x-size-height-input-group-default: var(--x-size-height-input-default);
6771
- --x-size-gap-input-group-default: var(--x-size-base-03);
6772
- --x-size-padding-left-input-group-default: var(--x-size-base-06);
6773
- --x-size-padding-right-input-group-default: var(--x-size-padding-left-input-group-default);
6774
- --x-size-padding-input-group-default-action: var(--x-size-base-03);
6775
- --x-size-border-width-input-group-default: var(--x-size-border-width-input-default);
6776
- --x-size-border-width-top-input-group-default: var(--x-size-border-width-input-group-default);
6777
- --x-size-border-width-right-input-group-default: var(--x-size-border-width-input-group-default);
6778
- --x-size-border-width-bottom-input-group-default: var(--x-size-border-width-input-group-default);
6779
- --x-size-border-width-left-input-group-default: var(--x-size-border-width-input-group-default);
6780
- --x-size-border-radius-input-group-default: var(--x-size-border-radius-input-default);
6781
- --x-size-border-radius-top-left-input-group-default: var(
6782
- --x-size-border-radius-input-group-default
6783
- );
6784
- --x-size-border-radius-top-right-input-group-default: var(
6785
- --x-size-border-radius-input-group-default
6786
- );
6787
- --x-size-border-radius-bottom-right-input-group-default: var(
6788
- --x-size-border-radius-input-group-default
6789
- );
6790
- --x-size-border-radius-bottom-left-input-group-default: var(
6791
- --x-size-border-radius-input-group-default
6792
- );
6793
- --x-font-family-input-group-default: var(--x-font-family-input-default);
6794
- --x-size-font-input-group-default: var(--x-size-font-input-default);
6795
- --x-size-line-height-input-group-default: var(--x-size-line-height-input-default);
6796
- --x-number-font-weight-input-group-default: var(--x-number-font-weight-input-default);
6797
- --x-font-family-input-group-placeholder-default: var(--x-font-family-input-group-default);
6798
- --x-size-font-input-group-placeholder-default: var(--x-size-font-input-group-default);
6799
- --x-size-line-height-input-group-placeholder-default: var(
6800
- --x-size-line-height-input-group-default
6801
- );
6802
- --x-number-font-weight-input-group-placeholder-default: var(
6803
- --x-number-font-weight-input-group-default
6804
- );
6805
- --x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
6806
- }
6807
6764
  :root {
6808
6765
  --x-size-padding-left-input-group-line: 0;
6809
6766
  --x-size-padding-right-input-group-line: 0;
@@ -6898,6 +6855,49 @@
6898
6855
  );
6899
6856
  --x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
6900
6857
  }
6858
+ :root {
6859
+ --x-color-background-input-group-default: var(--x-color-background-input-default);
6860
+ --x-color-border-input-group-default: var(--x-color-border-input-default);
6861
+ --x-color-border-input-group-default-focus: var(--x-color-border-input-default-focus);
6862
+ --x-color-text-input-group-default: var(--x-color-text-input-default);
6863
+ --x-color-text-input-group-placeholder-default: var(--x-color-text-input-placeholder-default);
6864
+ --x-size-height-input-group-default: var(--x-size-height-input-default);
6865
+ --x-size-gap-input-group-default: var(--x-size-base-03);
6866
+ --x-size-padding-left-input-group-default: var(--x-size-base-06);
6867
+ --x-size-padding-right-input-group-default: var(--x-size-padding-left-input-group-default);
6868
+ --x-size-padding-input-group-default-action: var(--x-size-base-03);
6869
+ --x-size-border-width-input-group-default: var(--x-size-border-width-input-default);
6870
+ --x-size-border-width-top-input-group-default: var(--x-size-border-width-input-group-default);
6871
+ --x-size-border-width-right-input-group-default: var(--x-size-border-width-input-group-default);
6872
+ --x-size-border-width-bottom-input-group-default: var(--x-size-border-width-input-group-default);
6873
+ --x-size-border-width-left-input-group-default: var(--x-size-border-width-input-group-default);
6874
+ --x-size-border-radius-input-group-default: var(--x-size-border-radius-input-default);
6875
+ --x-size-border-radius-top-left-input-group-default: var(
6876
+ --x-size-border-radius-input-group-default
6877
+ );
6878
+ --x-size-border-radius-top-right-input-group-default: var(
6879
+ --x-size-border-radius-input-group-default
6880
+ );
6881
+ --x-size-border-radius-bottom-right-input-group-default: var(
6882
+ --x-size-border-radius-input-group-default
6883
+ );
6884
+ --x-size-border-radius-bottom-left-input-group-default: var(
6885
+ --x-size-border-radius-input-group-default
6886
+ );
6887
+ --x-font-family-input-group-default: var(--x-font-family-input-default);
6888
+ --x-size-font-input-group-default: var(--x-size-font-input-default);
6889
+ --x-size-line-height-input-group-default: var(--x-size-line-height-input-default);
6890
+ --x-number-font-weight-input-group-default: var(--x-number-font-weight-input-default);
6891
+ --x-font-family-input-group-placeholder-default: var(--x-font-family-input-group-default);
6892
+ --x-size-font-input-group-placeholder-default: var(--x-size-font-input-group-default);
6893
+ --x-size-line-height-input-group-placeholder-default: var(
6894
+ --x-size-line-height-input-group-default
6895
+ );
6896
+ --x-number-font-weight-input-group-placeholder-default: var(
6897
+ --x-number-font-weight-input-group-default
6898
+ );
6899
+ --x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
6900
+ }
6901
6901
 
6902
6902
  [dir="ltr"] .x-input-group {
6903
6903
  border-right-width: var(--x-size-border-width-right-input-group-default);
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [cancelFetchAndSaveControls](./x-components.cancelfetchandsavecontrols.md)
4
+
5
+ ## cancelFetchAndSaveControls variable
6
+
7
+ Default implementation for fetchAndSaveExperienceControls action.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ cancelFetchAndSaveControls: () => void
13
+ ```
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControls](./x-components.experiencecontrols.md)
4
+
5
+ ## ExperienceControls class
6
+
7
+ This component subscribes to changes in the ExperienceControls module to fire the events that propagate the configuration.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export default class ExperienceControls extends Vue
13
+ ```
14
+ **Extends:** Vue
15
+
16
+ ## Methods
17
+
18
+ | Method | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [onEventsChanged(events)](./x-components.experiencecontrols.oneventschanged.md) | | . Iterates the list of XEvents received and emits them |
21
+ | [render()](./x-components.experiencecontrols.render.md) | | |
22
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControls](./x-components.experiencecontrols.md) &gt; [onEventsChanged](./x-components.experiencecontrols.oneventschanged.md)
4
+
5
+ ## ExperienceControls.onEventsChanged() method
6
+
7
+ . Iterates the list of XEvents received and emits them
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ onEventsChanged(events: Partial<XEventsTypes>): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | events | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; | events to be emitted |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControls](./x-components.experiencecontrols.md) &gt; [render](./x-components.experiencecontrols.render.md)
4
+
5
+ ## ExperienceControls.render() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ render(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsActionContext](./x-components.experiencecontrolsactioncontext.md)
4
+
5
+ ## ExperienceControlsActionContext type
6
+
7
+ Alias type for actions context of the [ExperienceControlsXStoreModule](./x-components.experiencecontrolsxstoremodule.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ExperienceControlsActionContext = XActionContext<ExperienceControlsState, ExperienceControlsGetters, ExperienceControlsMutations, ExperienceControlsActions>;
13
+ ```
14
+ **References:** [XActionContext](./x-components.xactioncontext.md)<!-- -->, [ExperienceControlsState](./x-components.experiencecontrolsstate.md)<!-- -->, [ExperienceControlsGetters](./x-components.experiencecontrolsgetters.md)<!-- -->, [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md)<!-- -->, [ExperienceControlsActions](./x-components.experiencecontrolsactions.md)
15
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsActions](./x-components.experiencecontrolsactions.md) &gt; [fetchAndSaveExperienceControlsResponse](./x-components.experiencecontrolsactions.fetchandsaveexperiencecontrolsresponse.md)
4
+
5
+ ## ExperienceControlsActions.fetchAndSaveExperienceControlsResponse() method
6
+
7
+ Requests the experience controls and saves them in the module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchAndSaveExperienceControlsResponse(request: ExperienceControlsRequest | null): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | request | ExperienceControlsRequest \| null | The request to fetch the experience controls. |
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) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsActions](./x-components.experiencecontrolsactions.md) &gt; [fetchExperienceControlsResponse](./x-components.experiencecontrolsactions.fetchexperiencecontrolsresponse.md)
4
+
5
+ ## ExperienceControlsActions.fetchExperienceControlsResponse() method
6
+
7
+ . Requests the experience controls
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchExperienceControlsResponse(request: ExperienceControlsRequest | null): ExperienceControlsResponse;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | request | ExperienceControlsRequest \| null | The request to fetch the experience controls. |
20
+
21
+ **Returns:**
22
+
23
+ ExperienceControlsResponse
24
+
25
+ the experience controls.
26
+
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsActions](./x-components.experiencecontrolsactions.md)
4
+
5
+ ## ExperienceControlsActions interface
6
+
7
+ Experience Controls store actions.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface ExperienceControlsActions
13
+ ```
14
+
15
+ ## Methods
16
+
17
+ | Method | Description |
18
+ | --- | --- |
19
+ | [fetchAndSaveExperienceControlsResponse(request)](./x-components.experiencecontrolsactions.fetchandsaveexperiencecontrolsresponse.md) | Requests the experience controls and saves them in the module. |
20
+ | [fetchExperienceControlsResponse(request)](./x-components.experiencecontrolsactions.fetchexperiencecontrolsresponse.md) | . Requests the experience controls |
21
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsGetters](./x-components.experiencecontrolsgetters.md) &gt; [experienceControlsRequest](./x-components.experiencecontrolsgetters.experiencecontrolsrequest.md)
4
+
5
+ ## ExperienceControlsGetters.experienceControlsRequest property
6
+
7
+ The adapter request object for retrieving the controls request, or null if there is not valid data to create a request.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ experienceControlsRequest: ExperienceControlsRequest | null;
13
+ ```
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsGetters](./x-components.experiencecontrolsgetters.md)
4
+
5
+ ## ExperienceControlsGetters interface
6
+
7
+ Experience Controls store getters.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface ExperienceControlsGetters
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [experienceControlsRequest](./x-components.experiencecontrolsgetters.experiencecontrolsrequest.md) | | ExperienceControlsRequest \| null | The adapter request object for retrieving the controls request, or null if there is not valid data to create a request. |
20
+
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md)
4
+
5
+ ## ExperienceControlsMutations interface
6
+
7
+ Experience Controls store mutations.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface ExperienceControlsMutations extends StatusMutations
13
+ ```
14
+ **Extends:** [StatusMutations](./x-components.statusmutations.md)
15
+
16
+ ## Methods
17
+
18
+ | Method | Description |
19
+ | --- | --- |
20
+ | [setControls(controls)](./x-components.experiencecontrolsmutations.setcontrols.md) | Sets the [ExperienceControlsState.controls](./x-components.experiencecontrolsstate.controls.md) property. |
21
+ | [setEvents(events)](./x-components.experiencecontrolsmutations.setevents.md) | Sets the [ExperienceControlsState.events](./x-components.experiencecontrolsstate.events.md) property. |
22
+ | [setParams(params)](./x-components.experiencecontrolsmutations.setparams.md) | Sets the extra params of the module. |
23
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md) &gt; [setControls](./x-components.experiencecontrolsmutations.setcontrols.md)
4
+
5
+ ## ExperienceControlsMutations.setControls() method
6
+
7
+ Sets the [ExperienceControlsState.controls](./x-components.experiencecontrolsstate.controls.md) property.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setControls(controls: Dictionary<unknown>): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | controls | Dictionary&lt;unknown&gt; | The new [ExperienceControlsState.controls](./x-components.experiencecontrolsstate.controls.md)<!-- -->. |
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) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md) &gt; [setEvents](./x-components.experiencecontrolsmutations.setevents.md)
4
+
5
+ ## ExperienceControlsMutations.setEvents() method
6
+
7
+ Sets the [ExperienceControlsState.events](./x-components.experiencecontrolsstate.events.md) property.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setEvents(events: Partial<XEventsTypes>): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | events | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; | The new [ExperienceControlsState.events](./x-components.experiencecontrolsstate.events.md)<!-- -->. |
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) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md) &gt; [setParams](./x-components.experiencecontrolsmutations.setparams.md)
4
+
5
+ ## ExperienceControlsMutations.setParams() method
6
+
7
+ Sets the extra params of the module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setParams(params: Dictionary<unknown>): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | params | Dictionary&lt;unknown&gt; | The new extra params. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [experienceControlsRequest](./x-components.experiencecontrolsrequest.md)
4
+
5
+ ## experienceControlsRequest variable
6
+
7
+ Default implementation for the [ExperienceControlsGetters.experienceControlsRequest](./x-components.experiencecontrolsgetters.experiencecontrolsrequest.md) getter.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ experienceControlsRequest: ExperienceControlsXStoreModule['getters']['experienceControlsRequest']
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsState](./x-components.experiencecontrolsstate.md) &gt; [controls](./x-components.experiencecontrolsstate.controls.md)
4
+
5
+ ## ExperienceControlsState.controls property
6
+
7
+ Configuration for the `ExperienceControls` module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ controls: Dictionary<unknown>;
13
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsState](./x-components.experiencecontrolsstate.md) &gt; [events](./x-components.experiencecontrolsstate.events.md)
4
+
5
+ ## ExperienceControlsState.events property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ events: Partial<XEventsTypes>;
11
+ ```
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsState](./x-components.experiencecontrolsstate.md)
4
+
5
+ ## ExperienceControlsState interface
6
+
7
+ Experience Controls store state.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface ExperienceControlsState extends StatusState
13
+ ```
14
+ **Extends:** [StatusState](./x-components.statusstate.md)
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [controls](./x-components.experiencecontrolsstate.controls.md) | | Dictionary&lt;unknown&gt; | Configuration for the <code>ExperienceControls</code> module. |
21
+ | [events](./x-components.experiencecontrolsstate.events.md) | | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; | |
22
+ | [params](./x-components.experiencecontrolsstate.params.md) | | Dictionary&lt;unknown&gt; | |
23
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsState](./x-components.experiencecontrolsstate.md) &gt; [params](./x-components.experiencecontrolsstate.params.md)
4
+
5
+ ## ExperienceControlsState.params property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ params: Dictionary<unknown>;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md) &gt; [ExperienceControlsEventsChanged](./x-components.experiencecontrolsxevents.experiencecontrolseventschanged.md)
4
+
5
+ ## ExperienceControlsXEvents.ExperienceControlsEventsChanged property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ ExperienceControlsEventsChanged: Partial<XEventsTypes>;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md) &gt; [ExperienceControlsRequestUpdated](./x-components.experiencecontrolsxevents.experiencecontrolsrequestupdated.md)
4
+
5
+ ## ExperienceControlsXEvents.ExperienceControlsRequestUpdated property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ ExperienceControlsRequestUpdated: ExperienceControlsRequest | null;
11
+ ```
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)
4
+
5
+ ## ExperienceControlsXEvents interface
6
+
7
+ Dictionary of the events of Experience Controls XModule.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface ExperienceControlsXEvents
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [ExperienceControlsEventsChanged](./x-components.experiencecontrolsxevents.experiencecontrolseventschanged.md) | | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; | |
20
+ | [ExperienceControlsRequestUpdated](./x-components.experiencecontrolsxevents.experiencecontrolsrequestupdated.md) | | ExperienceControlsRequest \| null | |
21
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [experienceControlsXModule](./x-components.experiencecontrolsxmodule.md)
4
+
5
+ ## experienceControlsXModule variable
6
+
7
+ Search [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `x-controls` entry point.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ experienceControlsXModule: ExperienceControlsXModule
13
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ExperienceControlsXStoreModule](./x-components.experiencecontrolsxstoremodule.md)
4
+
5
+ ## ExperienceControlsXStoreModule type
6
+
7
+ Experience Controls type safe store module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ExperienceControlsXStoreModule = XStoreModule<ExperienceControlsState, ExperienceControlsGetters, ExperienceControlsMutations, ExperienceControlsActions>;
13
+ ```
14
+ **References:** [XStoreModule](./x-components.xstoremodule.md)<!-- -->, [ExperienceControlsState](./x-components.experiencecontrolsstate.md)<!-- -->, [ExperienceControlsGetters](./x-components.experiencecontrolsgetters.md)<!-- -->, [ExperienceControlsMutations](./x-components.experiencecontrolsmutations.md)<!-- -->, [ExperienceControlsActions](./x-components.experiencecontrolsactions.md)
15
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveExperienceControlsResponse](./x-components.fetchandsaveexperiencecontrolsresponse.md)
4
+
5
+ ## fetchAndSaveExperienceControlsResponse variable
6
+
7
+ Default implementation for fetchAndSaveExperienceControls action.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchAndSaveExperienceControlsResponse: (context: ExperienceControlsActionContext, request: ExperienceControlsRequest | null) => void | Promise<void>
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveExperienceControlsWire](./x-components.fetchandsaveexperiencecontrolswire.md)
4
+
5
+ ## fetchAndSaveExperienceControlsWire variable
6
+
7
+ Requests and stores a new set of controls results.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchAndSaveExperienceControlsWire: import("../..").Wire<import("@empathyco/x-types").ExperienceControlsRequest | null>
13
+ ```