@watermarkinsights/ripple 3.4.0-1 → 3.4.0-2

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 (171) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/{functions-8fb310fe.js → functions-653e695c.js} +442 -442
  3. package/dist/cjs/{global-62b00020.js → global-ea9e87be.js} +65 -65
  4. package/dist/cjs/{http-service-9e8c4dd5.js → http-service-494d81de.js} +49 -49
  5. package/dist/cjs/{interfaces-30a74c1f.js → interfaces-a3338581.js} +29 -29
  6. package/dist/cjs/loader.cjs.js +1 -1
  7. package/dist/cjs/priv-chart-popover.cjs.entry.js +78 -78
  8. package/dist/cjs/priv-datepicker.cjs.entry.js +667 -667
  9. package/dist/cjs/priv-navigator-button.cjs.entry.js +18 -18
  10. package/dist/cjs/priv-navigator-item.cjs.entry.js +23 -23
  11. package/dist/cjs/ripple.cjs.js +1 -1
  12. package/dist/cjs/wm-action-menu_2.cjs.entry.js +341 -341
  13. package/dist/cjs/wm-button.cjs.entry.js +218 -218
  14. package/dist/cjs/wm-chart-slice.cjs.entry.js +13 -13
  15. package/dist/cjs/wm-chart.cjs.entry.js +516 -516
  16. package/dist/cjs/wm-datepicker.cjs.entry.js +256 -256
  17. package/dist/cjs/wm-input.cjs.entry.js +133 -133
  18. package/dist/cjs/wm-modal-footer.cjs.entry.js +31 -31
  19. package/dist/cjs/wm-modal-header.cjs.entry.js +34 -34
  20. package/dist/cjs/wm-modal.cjs.entry.js +161 -161
  21. package/dist/cjs/wm-navigator.cjs.entry.js +268 -268
  22. package/dist/cjs/wm-network-uploader.cjs.entry.js +420 -420
  23. package/dist/cjs/wm-option_2.cjs.entry.js +491 -491
  24. package/dist/cjs/wm-pagination.cjs.entry.js +167 -167
  25. package/dist/cjs/wm-search.cjs.entry.js +231 -231
  26. package/dist/cjs/wm-snackbar.cjs.entry.js +170 -170
  27. package/dist/cjs/wm-tab-item_3.cjs.entry.js +300 -300
  28. package/dist/cjs/wm-tag-input.cjs.entry.js +556 -556
  29. package/dist/cjs/wm-timepicker.cjs.entry.js +383 -383
  30. package/dist/cjs/wm-toggletip.cjs.entry.js +124 -124
  31. package/dist/cjs/wm-uploader.cjs.entry.js +346 -346
  32. package/dist/cjs/wm-wrapper.cjs.entry.js +12 -12
  33. package/dist/collection/components/wm-action-menu/wm-action-menu.js +460 -460
  34. package/dist/collection/components/wm-button/wm-button.js +485 -485
  35. package/dist/collection/components/wm-chart/priv-chart-popover/priv-chart-popover.js +232 -232
  36. package/dist/collection/components/wm-chart/wm-chart-slice.js +64 -64
  37. package/dist/collection/components/wm-chart/wm-chart.css +1 -1
  38. package/dist/collection/components/wm-chart/wm-chart.js +765 -765
  39. package/dist/collection/components/wm-datepicker/priv-datepicker/priv-datepicker.js +1015 -1015
  40. package/dist/collection/components/wm-datepicker/wm-datepicker.js +462 -462
  41. package/dist/collection/components/wm-input/wm-input.js +423 -423
  42. package/dist/collection/components/wm-menuitem/wm-menuitem.js +444 -444
  43. package/dist/collection/components/wm-modal/wm-modal-footer.js +141 -141
  44. package/dist/collection/components/wm-modal/wm-modal-header.js +92 -92
  45. package/dist/collection/components/wm-modal/wm-modal.js +459 -459
  46. package/dist/collection/components/wm-navigator/priv-navigator-button/priv-navigator-button.js +97 -97
  47. package/dist/collection/components/wm-navigator/priv-navigator-item/priv-navigator-item.js +114 -114
  48. package/dist/collection/components/wm-navigator/wm-navigator.js +468 -468
  49. package/dist/collection/components/wm-option/wm-option.js +422 -422
  50. package/dist/collection/components/wm-pagination/wm-pagination.js +368 -368
  51. package/dist/collection/components/wm-search/wm-search.js +479 -479
  52. package/dist/collection/components/wm-select/wm-select.js +717 -717
  53. package/dist/collection/components/wm-snackbar/wm-snackbar.js +297 -297
  54. package/dist/collection/components/wm-tabs/wm-tab-item/wm-tab-item.js +219 -219
  55. package/dist/collection/components/wm-tabs/wm-tab-list/wm-tab-list.js +331 -331
  56. package/dist/collection/components/wm-tabs/wm-tab-panel/wm-tab-panel.js +104 -104
  57. package/dist/collection/components/wm-tag-input/wm-tag-input.js +787 -787
  58. package/dist/collection/components/wm-timepicker/wm-timepicker.js +589 -589
  59. package/dist/collection/components/wm-toggletip/wm-toggletip.js +241 -241
  60. package/dist/collection/components/wm-uploader/wm-network-uploader/wm-network-uploader.js +753 -753
  61. package/dist/collection/components/wm-uploader/wm-uploader.js +748 -748
  62. package/dist/collection/components/wm-wrapper/wm-wrapper.js +27 -27
  63. package/dist/collection/dev/scripts.js +20 -20
  64. package/dist/collection/global/__mocks__/functions.js +6 -6
  65. package/dist/collection/global/functions.js +445 -445
  66. package/dist/collection/global/global.js +72 -72
  67. package/dist/collection/global/interfaces.js +49 -49
  68. package/dist/collection/global/services/__mocks__/http-service.js +130 -130
  69. package/dist/collection/global/services/http-service.js +50 -50
  70. package/dist/collection/lang/lang.js +5 -5
  71. package/dist/collection/lang/piglatin.js +93 -93
  72. package/dist/esm/{functions-c315390d.js → functions-e528c934.js} +442 -442
  73. package/dist/esm/{global-1de94d50.js → global-c7a1f76c.js} +65 -65
  74. package/dist/esm/{http-service-5d037e16.js → http-service-3dc3b3e7.js} +49 -49
  75. package/dist/esm/{interfaces-61c6305b.js → interfaces-2b97fab2.js} +29 -29
  76. package/dist/esm/loader.js +1 -1
  77. package/dist/esm/polyfills/core-js.js +0 -0
  78. package/dist/esm/polyfills/dom.js +0 -0
  79. package/dist/esm/polyfills/es5-html-element.js +0 -0
  80. package/dist/esm/polyfills/index.js +0 -0
  81. package/dist/esm/polyfills/system.js +0 -0
  82. package/dist/esm/priv-chart-popover.entry.js +78 -78
  83. package/dist/esm/priv-datepicker.entry.js +667 -667
  84. package/dist/esm/priv-navigator-button.entry.js +18 -18
  85. package/dist/esm/priv-navigator-item.entry.js +23 -23
  86. package/dist/esm/ripple.js +1 -1
  87. package/dist/esm/wm-action-menu_2.entry.js +341 -341
  88. package/dist/esm/wm-button.entry.js +218 -218
  89. package/dist/esm/wm-chart-slice.entry.js +13 -13
  90. package/dist/esm/wm-chart.entry.js +516 -516
  91. package/dist/esm/wm-datepicker.entry.js +256 -256
  92. package/dist/esm/wm-input.entry.js +133 -133
  93. package/dist/esm/wm-modal-footer.entry.js +31 -31
  94. package/dist/esm/wm-modal-header.entry.js +34 -34
  95. package/dist/esm/wm-modal.entry.js +161 -161
  96. package/dist/esm/wm-navigator.entry.js +268 -268
  97. package/dist/esm/wm-network-uploader.entry.js +420 -420
  98. package/dist/esm/wm-option_2.entry.js +491 -491
  99. package/dist/esm/wm-pagination.entry.js +167 -167
  100. package/dist/esm/wm-search.entry.js +231 -231
  101. package/dist/esm/wm-snackbar.entry.js +170 -170
  102. package/dist/esm/wm-tab-item_3.entry.js +300 -300
  103. package/dist/esm/wm-tag-input.entry.js +556 -556
  104. package/dist/esm/wm-timepicker.entry.js +383 -383
  105. package/dist/esm/wm-toggletip.entry.js +124 -124
  106. package/dist/esm/wm-uploader.entry.js +346 -346
  107. package/dist/esm/wm-wrapper.entry.js +12 -12
  108. package/dist/ripple/{p-c5e44367.entry.js → p-092b01f3.entry.js} +1 -1
  109. package/dist/ripple/{p-5ffa983b.entry.js → p-1e0c41a9.entry.js} +1 -1
  110. package/dist/ripple/{p-d5fafa9c.entry.js → p-3003d26d.entry.js} +1 -1
  111. package/dist/ripple/{p-374b4fa6.entry.js → p-33524565.entry.js} +1 -1
  112. package/dist/ripple/{p-888bec42.js → p-43f1298b.js} +0 -0
  113. package/dist/ripple/{p-dea72d46.entry.js → p-4cc71463.entry.js} +1 -1
  114. package/dist/ripple/{p-e60fe2f5.js → p-588b4475.js} +0 -0
  115. package/dist/ripple/{p-b03382ea.entry.js → p-65e3a656.entry.js} +1 -1
  116. package/dist/ripple/{p-7bbd123c.entry.js → p-8923b7d0.entry.js} +1 -1
  117. package/dist/ripple/{p-ba9d3069.entry.js → p-8cd1396e.entry.js} +1 -1
  118. package/dist/ripple/{p-e574fb73.entry.js → p-aa973691.entry.js} +1 -1
  119. package/dist/ripple/{p-b4a8c8d3.entry.js → p-b3d5ea85.entry.js} +1 -1
  120. package/dist/ripple/{p-9b4f222b.entry.js → p-b5189f72.entry.js} +1 -1
  121. package/dist/ripple/p-bc27b604.entry.js +1 -0
  122. package/dist/ripple/{p-5f19bcd1.entry.js → p-bcb41945.entry.js} +1 -1
  123. package/dist/ripple/{p-27d5255f.entry.js → p-cd58a15c.entry.js} +1 -1
  124. package/dist/ripple/{p-a4d95d60.js → p-d298bf82.js} +1 -1
  125. package/dist/ripple/{p-41f39509.entry.js → p-dc9c9fda.entry.js} +1 -1
  126. package/dist/ripple/{p-34694011.entry.js → p-e7616311.entry.js} +1 -1
  127. package/dist/ripple/{p-36da5d4a.entry.js → p-e9e8334e.entry.js} +1 -1
  128. package/dist/ripple/{p-ec5db255.entry.js → p-ec9697db.entry.js} +1 -1
  129. package/dist/ripple/{p-c724ce54.entry.js → p-efdaf3b6.entry.js} +1 -1
  130. package/dist/ripple/{p-042d6449.entry.js → p-fcdc6395.entry.js} +1 -1
  131. package/dist/ripple/{p-a6d6eae7.js → p-fd8070fb.js} +0 -0
  132. package/dist/ripple/ripple.esm.js +1 -1
  133. package/dist/types/components/wm-action-menu/wm-action-menu.d.ts +48 -48
  134. package/dist/types/components/wm-button/wm-button.d.ts +44 -44
  135. package/dist/types/components/wm-chart/priv-chart-popover/priv-chart-popover.d.ts +23 -23
  136. package/dist/types/components/wm-chart/wm-chart-slice.d.ts +8 -8
  137. package/dist/types/components/wm-chart/wm-chart.d.ts +80 -80
  138. package/dist/types/components/wm-datepicker/priv-datepicker/priv-datepicker.d.ts +76 -76
  139. package/dist/types/components/wm-datepicker/wm-datepicker.d.ts +41 -41
  140. package/dist/types/components/wm-input/wm-input.d.ts +46 -46
  141. package/dist/types/components/wm-menuitem/wm-menuitem.d.ts +34 -34
  142. package/dist/types/components/wm-modal/wm-modal-footer.d.ts +15 -15
  143. package/dist/types/components/wm-modal/wm-modal-header.d.ts +12 -12
  144. package/dist/types/components/wm-modal/wm-modal.d.ts +41 -41
  145. package/dist/types/components/wm-navigator/priv-navigator-button/priv-navigator-button.d.ts +10 -10
  146. package/dist/types/components/wm-navigator/priv-navigator-item/priv-navigator-item.d.ts +13 -13
  147. package/dist/types/components/wm-navigator/wm-navigator.d.ts +61 -61
  148. package/dist/types/components/wm-option/wm-option.d.ts +32 -32
  149. package/dist/types/components/wm-pagination/wm-pagination.d.ts +32 -32
  150. package/dist/types/components/wm-search/wm-search.d.ts +86 -86
  151. package/dist/types/components/wm-select/wm-select.d.ts +66 -66
  152. package/dist/types/components/wm-snackbar/wm-snackbar.d.ts +35 -35
  153. package/dist/types/components/wm-tabs/wm-tab-item/wm-tab-item.d.ts +38 -38
  154. package/dist/types/components/wm-tabs/wm-tab-list/wm-tab-list.d.ts +53 -53
  155. package/dist/types/components/wm-tabs/wm-tab-panel/wm-tab-panel.d.ts +20 -20
  156. package/dist/types/components/wm-tag-input/wm-tag-input.d.ts +91 -91
  157. package/dist/types/components/wm-timepicker/wm-timepicker.d.ts +62 -62
  158. package/dist/types/components/wm-toggletip/wm-toggletip.d.ts +27 -27
  159. package/dist/types/components/wm-uploader/wm-network-uploader/wm-network-uploader.d.ts +85 -85
  160. package/dist/types/components/wm-uploader/wm-uploader.d.ts +80 -80
  161. package/dist/types/components/wm-wrapper/wm-wrapper.d.ts +7 -7
  162. package/dist/types/components.d.ts +24 -24
  163. package/dist/types/global/__mocks__/functions.d.ts +6 -6
  164. package/dist/types/global/functions.d.ts +40 -40
  165. package/dist/types/global/global.d.ts +1 -1
  166. package/dist/types/global/interfaces.d.ts +34 -34
  167. package/dist/types/global/services/__mocks__/http-service.d.ts +6 -6
  168. package/dist/types/global/services/http-service.d.ts +4 -4
  169. package/dist/types/lang/lang.d.ts +5 -5
  170. package/package.json +46 -46
  171. package/dist/ripple/p-053e8324.entry.js +0 -1
@@ -1,459 +1,459 @@
1
- import { h, Component, Element, Listen, Host, Prop, Watch, Event, Method } from "@stencil/core";
2
- import { getFirstFocusableDescendant, checkForActiveElInShadow } from "../../global/functions";
3
- import { generateId } from "../../global/functions";
4
- export class Modal {
5
- constructor() {
6
- this.open = false;
7
- this.isOpen = false; // DEPRECATED in favor of open
8
- this.elementToFocus = "";
9
- this.modalType = null;
10
- this.isTypeDialog = null;
11
- this.bodyFocusListener = () => this.redirectFocusOnBody();
12
- }
13
- get tempOpen() {
14
- // instances of this.tempOpen should be replaced with this.open once isOpen is fully phased out
15
- return this.open || this.isOpen;
16
- }
17
- get tempModalType() {
18
- return this.modalType ? this.modalType : this.isTypeDialog ? "dialog" : "modal";
19
- }
20
- //App can open modal by toggling the prop
21
- toggleModal() {
22
- this.tempOpen ? this.showModal() : this.hideModal();
23
- }
24
- //The below not implemented in light of the fact that the app does often need to keep track of the modal's state itself so that it can update the data displayed in the body:
25
- //App can also open modal by emitting wmShowModal event. Event needs to include the modal's unique id as the event detail, or else all modals on the page will open when wmShowModal event is dispatched.
26
- // @Listen("wmShowModal", { target: "window" })
27
- // doesEventMatchId(ev: CustomEvent) {
28
- // ev.detail === this.uid && this.showModal();
29
- // }
30
- showModal() {
31
- this.setElToFocusOnClose(); //Record where the user was before the modal opened so that focus can return to it when the modal closes
32
- document.body.style.overflow = "hidden"; //Keeps the page below the modal from scrolling
33
- //Focus listeners as a general catch for keeping focus in case of errors in finding element with id passed in by dev (element is removed from DOM, etc.) or other scenarios
34
- document.body.tabIndex = 0;
35
- document.body.removeEventListener("focus", this.bodyFocusListener, true);
36
- document.body.addEventListener("focus", this.bodyFocusListener, true);
37
- window.requestAnimationFrame(() => {
38
- this.setElToFocusOnOpen();
39
- window.requestAnimationFrame(() => this.focusOnOpen.focus()); //Bring focus to element inside modal
40
- });
41
- }
42
- handleClick(ev) {
43
- this.tempOpen && ev.target === this.overlayEl && this.focusOnOpen.focus();
44
- }
45
- closeModalOnEscape(ev) {
46
- if (ev.key === "Escape") {
47
- this.wmModalCloseTriggered.emit();
48
- this.wmCloseTriggered.emit(); // deprecated
49
- this.open = false;
50
- }
51
- }
52
- //Close the modal and focus the triggering element when the modal buttons emit their events
53
- hideModal() {
54
- document.body.style.overflow = "visible";
55
- document.body.tabIndex = -1;
56
- document.body.removeEventListener("focus", this.bodyFocusListener, true);
57
- window.requestAnimationFrame(() => this.focusOnClose.focus()); //Return focus
58
- }
59
- componentWillLoad() {
60
- if (this.isOpen) {
61
- console.warn("wm-modal: is-open has been deprecated as of v3.1.0. Please use open instead.");
62
- }
63
- if (this.isTypeDialog) {
64
- console.warn("wm-modal: is-type-dialog has been deprecated as of v3.1.0. Please use modal-type instead.");
65
- }
66
- if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
67
- if (!this.el.id) {
68
- throw new Error("You are telling the modal to focus an element in the footer when it opens. That's fine! But when you do that, you also need to give the wm-modal-wrapper an ID and set the ID of the modal body to 'content-[id of wm-modal-wrapper]. This is for accessibility purposes.");
69
- }
70
- }
71
- this.uid = this.el.id ? this.el.id : generateId();
72
- }
73
- componentDidLoad() {
74
- if (this.tempOpen) {
75
- this.showModal();
76
- }
77
- }
78
- async emitCloseEvent() {
79
- this.wmModalCloseTriggered.emit();
80
- this.wmCloseTriggered.emit(); // deprecated
81
- }
82
- async emitPrimaryEvent() {
83
- this.wmModalPrimaryTriggered.emit();
84
- this.wmPrimaryTriggered.emit(); // deprecated
85
- }
86
- async emitSecondaryEvent() {
87
- this.wmModalSecondaryTriggered.emit();
88
- this.wmSecondaryTriggered.emit(); // deprecated
89
- }
90
- //If the dev hasn't specified an element to focus, element to focus first will be the close (X) button
91
- setElToFocusOnOpen() {
92
- const closeBtn = getFirstFocusableDescendant(this.el.querySelector(`#wm-modal-close-${this.uid}`));
93
- if (this.elementToFocus) {
94
- if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
95
- this.setAriaDescribedbyOnModal();
96
- this.elementToFocus = `wm-${this.elementToFocus}-${this.uid}`;
97
- }
98
- const elToFocus = this.el.querySelector(`#${this.elementToFocus}`);
99
- if (elToFocus) {
100
- const firstEl = getFirstFocusableDescendant(elToFocus);
101
- if (firstEl) {
102
- this.focusOnOpen = firstEl;
103
- }
104
- else {
105
- console.warn("Ripple Component Library: The modal component couldn't find an element matching the value you passed for 'elementToFocus'. It will fall back to the default and focus the close button when the modal opens.");
106
- this.focusOnOpen = closeBtn;
107
- }
108
- }
109
- else {
110
- console.warn("Ripple Component Library: The modal component couldn't find an element matching the value you passed for 'elementToFocus'. It will fall back to the default and focus the close button when the modal opens.");
111
- this.focusOnOpen = closeBtn;
112
- }
113
- }
114
- else {
115
- this.focusOnOpen = closeBtn;
116
- }
117
- }
118
- setAriaDescribedbyOnModal() {
119
- const modalBody = document.getElementById(`content-${this.uid}`);
120
- if (!modalBody) {
121
- console.warn("Ripple Component Library: The element containing the body of the modal must include an id in the format 'content-[id of modal]' for accessibility purposes.");
122
- }
123
- else {
124
- this.el.setAttribute("aria-describedby", `wm-modal-heading-text-${this.uid} content-${this.uid}`);
125
- }
126
- }
127
- setElToFocusOnClose() {
128
- const elToFocus = document.activeElement;
129
- if (elToFocus.tagName === "WM-MENUITEM") {
130
- this.focusOnClose = elToFocus.parentElement;
131
- }
132
- else {
133
- this.focusOnClose = checkForActiveElInShadow(elToFocus);
134
- }
135
- }
136
- redirectFocusOnBody() {
137
- if (document.activeElement.tagName === "BODY") {
138
- this.setElToFocusOnOpen();
139
- this.focusOnOpen.focus();
140
- }
141
- }
142
- render() {
143
- return (h(Host, { class: `${this.tempOpen ? "" : "hide "}${"wm-" + this.tempModalType}`, role: "dialog", "aria-describedby": `wm-modal-heading-text-${this.uid}`, "aria-modal": "true", tabindex: this.tempOpen ? 0 : null, onFocus: () => {
144
- this.focusLastElement.emit();
145
- } },
146
- h("div", { class: "overlay", ref: (el) => (this.overlayEl = el) }),
147
- h("div", { class: "sr-only", tabIndex: 0, onFocus: () => {
148
- this.focusFirstElement.emit();
149
- } })));
150
- }
151
- static get is() { return "wm-modal"; }
152
- static get originalStyleUrls() { return {
153
- "$": ["wm-modal.scss"]
154
- }; }
155
- static get styleUrls() { return {
156
- "$": ["wm-modal.css"]
157
- }; }
158
- static get properties() { return {
159
- "open": {
160
- "type": "boolean",
161
- "mutable": true,
162
- "complexType": {
163
- "original": "boolean",
164
- "resolved": "boolean",
165
- "references": {}
166
- },
167
- "required": false,
168
- "optional": false,
169
- "docs": {
170
- "tags": [],
171
- "text": ""
172
- },
173
- "attribute": "open",
174
- "reflect": true,
175
- "defaultValue": "false"
176
- },
177
- "isOpen": {
178
- "type": "boolean",
179
- "mutable": true,
180
- "complexType": {
181
- "original": "boolean",
182
- "resolved": "boolean",
183
- "references": {}
184
- },
185
- "required": false,
186
- "optional": false,
187
- "docs": {
188
- "tags": [],
189
- "text": ""
190
- },
191
- "attribute": "is-open",
192
- "reflect": true,
193
- "defaultValue": "false"
194
- },
195
- "elementToFocus": {
196
- "type": "string",
197
- "mutable": true,
198
- "complexType": {
199
- "original": "string",
200
- "resolved": "string",
201
- "references": {}
202
- },
203
- "required": false,
204
- "optional": false,
205
- "docs": {
206
- "tags": [],
207
- "text": ""
208
- },
209
- "attribute": "element-to-focus",
210
- "reflect": false,
211
- "defaultValue": "\"\""
212
- },
213
- "modalType": {
214
- "type": "string",
215
- "mutable": false,
216
- "complexType": {
217
- "original": "\"modal\" | \"dialog\" | null",
218
- "resolved": "\"dialog\" | \"modal\" | null",
219
- "references": {}
220
- },
221
- "required": false,
222
- "optional": false,
223
- "docs": {
224
- "tags": [],
225
- "text": ""
226
- },
227
- "attribute": "modal-type",
228
- "reflect": true,
229
- "defaultValue": "null"
230
- },
231
- "isTypeDialog": {
232
- "type": "boolean",
233
- "mutable": false,
234
- "complexType": {
235
- "original": "boolean | null",
236
- "resolved": "boolean | null",
237
- "references": {}
238
- },
239
- "required": false,
240
- "optional": false,
241
- "docs": {
242
- "tags": [],
243
- "text": ""
244
- },
245
- "attribute": "is-type-dialog",
246
- "reflect": true,
247
- "defaultValue": "null"
248
- },
249
- "uid": {
250
- "type": "string",
251
- "mutable": true,
252
- "complexType": {
253
- "original": "string",
254
- "resolved": "string",
255
- "references": {}
256
- },
257
- "required": true,
258
- "optional": false,
259
- "docs": {
260
- "tags": [],
261
- "text": ""
262
- },
263
- "attribute": "uid",
264
- "reflect": true
265
- }
266
- }; }
267
- static get events() { return [{
268
- "method": "focusLastElement",
269
- "name": "focusLastElement",
270
- "bubbles": true,
271
- "cancelable": true,
272
- "composed": true,
273
- "docs": {
274
- "tags": [],
275
- "text": ""
276
- },
277
- "complexType": {
278
- "original": "any",
279
- "resolved": "any",
280
- "references": {}
281
- }
282
- }, {
283
- "method": "focusFirstElement",
284
- "name": "focusFirstElement",
285
- "bubbles": true,
286
- "cancelable": true,
287
- "composed": true,
288
- "docs": {
289
- "tags": [],
290
- "text": ""
291
- },
292
- "complexType": {
293
- "original": "any",
294
- "resolved": "any",
295
- "references": {}
296
- }
297
- }, {
298
- "method": "wmModalCloseTriggered",
299
- "name": "wmModalCloseTriggered",
300
- "bubbles": true,
301
- "cancelable": true,
302
- "composed": true,
303
- "docs": {
304
- "tags": [],
305
- "text": ""
306
- },
307
- "complexType": {
308
- "original": "any",
309
- "resolved": "any",
310
- "references": {}
311
- }
312
- }, {
313
- "method": "wmCloseTriggered",
314
- "name": "wmCloseTriggered",
315
- "bubbles": true,
316
- "cancelable": true,
317
- "composed": true,
318
- "docs": {
319
- "tags": [],
320
- "text": ""
321
- },
322
- "complexType": {
323
- "original": "any",
324
- "resolved": "any",
325
- "references": {}
326
- }
327
- }, {
328
- "method": "wmModalPrimaryTriggered",
329
- "name": "wmModalPrimaryTriggered",
330
- "bubbles": true,
331
- "cancelable": true,
332
- "composed": true,
333
- "docs": {
334
- "tags": [],
335
- "text": ""
336
- },
337
- "complexType": {
338
- "original": "any",
339
- "resolved": "any",
340
- "references": {}
341
- }
342
- }, {
343
- "method": "wmPrimaryTriggered",
344
- "name": "wmPrimaryTriggered",
345
- "bubbles": true,
346
- "cancelable": true,
347
- "composed": true,
348
- "docs": {
349
- "tags": [],
350
- "text": ""
351
- },
352
- "complexType": {
353
- "original": "any",
354
- "resolved": "any",
355
- "references": {}
356
- }
357
- }, {
358
- "method": "wmModalSecondaryTriggered",
359
- "name": "wmModalSecondaryTriggered",
360
- "bubbles": true,
361
- "cancelable": true,
362
- "composed": true,
363
- "docs": {
364
- "tags": [],
365
- "text": ""
366
- },
367
- "complexType": {
368
- "original": "any",
369
- "resolved": "any",
370
- "references": {}
371
- }
372
- }, {
373
- "method": "wmSecondaryTriggered",
374
- "name": "wmSecondaryTriggered",
375
- "bubbles": true,
376
- "cancelable": true,
377
- "composed": true,
378
- "docs": {
379
- "tags": [],
380
- "text": ""
381
- },
382
- "complexType": {
383
- "original": "any",
384
- "resolved": "any",
385
- "references": {}
386
- }
387
- }]; }
388
- static get methods() { return {
389
- "emitCloseEvent": {
390
- "complexType": {
391
- "signature": "() => Promise<void>",
392
- "parameters": [],
393
- "references": {
394
- "Promise": {
395
- "location": "global"
396
- }
397
- },
398
- "return": "Promise<void>"
399
- },
400
- "docs": {
401
- "text": "",
402
- "tags": []
403
- }
404
- },
405
- "emitPrimaryEvent": {
406
- "complexType": {
407
- "signature": "() => Promise<void>",
408
- "parameters": [],
409
- "references": {
410
- "Promise": {
411
- "location": "global"
412
- }
413
- },
414
- "return": "Promise<void>"
415
- },
416
- "docs": {
417
- "text": "",
418
- "tags": []
419
- }
420
- },
421
- "emitSecondaryEvent": {
422
- "complexType": {
423
- "signature": "() => Promise<void>",
424
- "parameters": [],
425
- "references": {
426
- "Promise": {
427
- "location": "global"
428
- }
429
- },
430
- "return": "Promise<void>"
431
- },
432
- "docs": {
433
- "text": "",
434
- "tags": []
435
- }
436
- }
437
- }; }
438
- static get elementRef() { return "el"; }
439
- static get watchers() { return [{
440
- "propName": "open",
441
- "methodName": "toggleModal"
442
- }, {
443
- "propName": "isOpen",
444
- "methodName": "toggleModal"
445
- }]; }
446
- static get listeners() { return [{
447
- "name": "click",
448
- "method": "handleClick",
449
- "target": undefined,
450
- "capture": false,
451
- "passive": false
452
- }, {
453
- "name": "keydown",
454
- "method": "closeModalOnEscape",
455
- "target": undefined,
456
- "capture": false,
457
- "passive": false
458
- }]; }
459
- }
1
+ import { h, Component, Element, Listen, Host, Prop, Watch, Event, Method } from "@stencil/core";
2
+ import { getFirstFocusableDescendant, checkForActiveElInShadow } from "../../global/functions";
3
+ import { generateId } from "../../global/functions";
4
+ export class Modal {
5
+ constructor() {
6
+ this.open = false;
7
+ this.isOpen = false; // DEPRECATED in favor of open
8
+ this.elementToFocus = "";
9
+ this.modalType = null;
10
+ this.isTypeDialog = null;
11
+ this.bodyFocusListener = () => this.redirectFocusOnBody();
12
+ }
13
+ get tempOpen() {
14
+ // instances of this.tempOpen should be replaced with this.open once isOpen is fully phased out
15
+ return this.open || this.isOpen;
16
+ }
17
+ get tempModalType() {
18
+ return this.modalType ? this.modalType : this.isTypeDialog ? "dialog" : "modal";
19
+ }
20
+ //App can open modal by toggling the prop
21
+ toggleModal() {
22
+ this.tempOpen ? this.showModal() : this.hideModal();
23
+ }
24
+ //The below not implemented in light of the fact that the app does often need to keep track of the modal's state itself so that it can update the data displayed in the body:
25
+ //App can also open modal by emitting wmShowModal event. Event needs to include the modal's unique id as the event detail, or else all modals on the page will open when wmShowModal event is dispatched.
26
+ // @Listen("wmShowModal", { target: "window" })
27
+ // doesEventMatchId(ev: CustomEvent) {
28
+ // ev.detail === this.uid && this.showModal();
29
+ // }
30
+ showModal() {
31
+ this.setElToFocusOnClose(); //Record where the user was before the modal opened so that focus can return to it when the modal closes
32
+ document.body.style.overflow = "hidden"; //Keeps the page below the modal from scrolling
33
+ //Focus listeners as a general catch for keeping focus in case of errors in finding element with id passed in by dev (element is removed from DOM, etc.) or other scenarios
34
+ document.body.tabIndex = 0;
35
+ document.body.removeEventListener("focus", this.bodyFocusListener, true);
36
+ document.body.addEventListener("focus", this.bodyFocusListener, true);
37
+ window.requestAnimationFrame(() => {
38
+ this.setElToFocusOnOpen();
39
+ window.requestAnimationFrame(() => this.focusOnOpen.focus()); //Bring focus to element inside modal
40
+ });
41
+ }
42
+ handleClick(ev) {
43
+ this.tempOpen && ev.target === this.overlayEl && this.focusOnOpen.focus();
44
+ }
45
+ closeModalOnEscape(ev) {
46
+ if (ev.key === "Escape") {
47
+ this.wmModalCloseTriggered.emit();
48
+ this.wmCloseTriggered.emit(); // deprecated
49
+ this.open = false;
50
+ }
51
+ }
52
+ //Close the modal and focus the triggering element when the modal buttons emit their events
53
+ hideModal() {
54
+ document.body.style.overflow = "visible";
55
+ document.body.tabIndex = -1;
56
+ document.body.removeEventListener("focus", this.bodyFocusListener, true);
57
+ window.requestAnimationFrame(() => this.focusOnClose.focus()); //Return focus
58
+ }
59
+ componentWillLoad() {
60
+ if (this.isOpen) {
61
+ console.warn("wm-modal: is-open has been deprecated as of v3.1.0. Please use open instead.");
62
+ }
63
+ if (this.isTypeDialog) {
64
+ console.warn("wm-modal: is-type-dialog has been deprecated as of v3.1.0. Please use modal-type instead.");
65
+ }
66
+ if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
67
+ if (!this.el.id) {
68
+ throw new Error("You are telling the modal to focus an element in the footer when it opens. That's fine! But when you do that, you also need to give the wm-modal-wrapper an ID and set the ID of the modal body to 'content-[id of wm-modal-wrapper]. This is for accessibility purposes.");
69
+ }
70
+ }
71
+ this.uid = this.el.id ? this.el.id : generateId();
72
+ }
73
+ componentDidLoad() {
74
+ if (this.tempOpen) {
75
+ this.showModal();
76
+ }
77
+ }
78
+ async emitCloseEvent() {
79
+ this.wmModalCloseTriggered.emit();
80
+ this.wmCloseTriggered.emit(); // deprecated
81
+ }
82
+ async emitPrimaryEvent() {
83
+ this.wmModalPrimaryTriggered.emit();
84
+ this.wmPrimaryTriggered.emit(); // deprecated
85
+ }
86
+ async emitSecondaryEvent() {
87
+ this.wmModalSecondaryTriggered.emit();
88
+ this.wmSecondaryTriggered.emit(); // deprecated
89
+ }
90
+ //If the dev hasn't specified an element to focus, element to focus first will be the close (X) button
91
+ setElToFocusOnOpen() {
92
+ const closeBtn = getFirstFocusableDescendant(this.el.querySelector(`#wm-modal-close-${this.uid}`));
93
+ if (this.elementToFocus) {
94
+ if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
95
+ this.setAriaDescribedbyOnModal();
96
+ this.elementToFocus = `wm-${this.elementToFocus}-${this.uid}`;
97
+ }
98
+ const elToFocus = this.el.querySelector(`#${this.elementToFocus}`);
99
+ if (elToFocus) {
100
+ const firstEl = getFirstFocusableDescendant(elToFocus);
101
+ if (firstEl) {
102
+ this.focusOnOpen = firstEl;
103
+ }
104
+ else {
105
+ console.warn("Ripple Component Library: The modal component couldn't find an element matching the value you passed for 'elementToFocus'. It will fall back to the default and focus the close button when the modal opens.");
106
+ this.focusOnOpen = closeBtn;
107
+ }
108
+ }
109
+ else {
110
+ console.warn("Ripple Component Library: The modal component couldn't find an element matching the value you passed for 'elementToFocus'. It will fall back to the default and focus the close button when the modal opens.");
111
+ this.focusOnOpen = closeBtn;
112
+ }
113
+ }
114
+ else {
115
+ this.focusOnOpen = closeBtn;
116
+ }
117
+ }
118
+ setAriaDescribedbyOnModal() {
119
+ const modalBody = document.getElementById(`content-${this.uid}`);
120
+ if (!modalBody) {
121
+ console.warn("Ripple Component Library: The element containing the body of the modal must include an id in the format 'content-[id of modal]' for accessibility purposes.");
122
+ }
123
+ else {
124
+ this.el.setAttribute("aria-describedby", `wm-modal-heading-text-${this.uid} content-${this.uid}`);
125
+ }
126
+ }
127
+ setElToFocusOnClose() {
128
+ const elToFocus = document.activeElement;
129
+ if (elToFocus.tagName === "WM-MENUITEM") {
130
+ this.focusOnClose = elToFocus.parentElement;
131
+ }
132
+ else {
133
+ this.focusOnClose = checkForActiveElInShadow(elToFocus);
134
+ }
135
+ }
136
+ redirectFocusOnBody() {
137
+ if (document.activeElement.tagName === "BODY") {
138
+ this.setElToFocusOnOpen();
139
+ this.focusOnOpen.focus();
140
+ }
141
+ }
142
+ render() {
143
+ return (h(Host, { class: `${this.tempOpen ? "" : "hide "}${"wm-" + this.tempModalType}`, role: "dialog", "aria-describedby": `wm-modal-heading-text-${this.uid}`, "aria-modal": "true", tabindex: this.tempOpen ? 0 : null, onFocus: () => {
144
+ this.focusLastElement.emit();
145
+ } },
146
+ h("div", { class: "overlay", ref: (el) => (this.overlayEl = el) }),
147
+ h("div", { class: "sr-only", tabIndex: 0, onFocus: () => {
148
+ this.focusFirstElement.emit();
149
+ } })));
150
+ }
151
+ static get is() { return "wm-modal"; }
152
+ static get originalStyleUrls() { return {
153
+ "$": ["wm-modal.scss"]
154
+ }; }
155
+ static get styleUrls() { return {
156
+ "$": ["wm-modal.css"]
157
+ }; }
158
+ static get properties() { return {
159
+ "open": {
160
+ "type": "boolean",
161
+ "mutable": true,
162
+ "complexType": {
163
+ "original": "boolean",
164
+ "resolved": "boolean",
165
+ "references": {}
166
+ },
167
+ "required": false,
168
+ "optional": false,
169
+ "docs": {
170
+ "tags": [],
171
+ "text": ""
172
+ },
173
+ "attribute": "open",
174
+ "reflect": true,
175
+ "defaultValue": "false"
176
+ },
177
+ "isOpen": {
178
+ "type": "boolean",
179
+ "mutable": true,
180
+ "complexType": {
181
+ "original": "boolean",
182
+ "resolved": "boolean",
183
+ "references": {}
184
+ },
185
+ "required": false,
186
+ "optional": false,
187
+ "docs": {
188
+ "tags": [],
189
+ "text": ""
190
+ },
191
+ "attribute": "is-open",
192
+ "reflect": true,
193
+ "defaultValue": "false"
194
+ },
195
+ "elementToFocus": {
196
+ "type": "string",
197
+ "mutable": true,
198
+ "complexType": {
199
+ "original": "string",
200
+ "resolved": "string",
201
+ "references": {}
202
+ },
203
+ "required": false,
204
+ "optional": false,
205
+ "docs": {
206
+ "tags": [],
207
+ "text": ""
208
+ },
209
+ "attribute": "element-to-focus",
210
+ "reflect": false,
211
+ "defaultValue": "\"\""
212
+ },
213
+ "modalType": {
214
+ "type": "string",
215
+ "mutable": false,
216
+ "complexType": {
217
+ "original": "\"modal\" | \"dialog\" | null",
218
+ "resolved": "\"dialog\" | \"modal\" | null",
219
+ "references": {}
220
+ },
221
+ "required": false,
222
+ "optional": false,
223
+ "docs": {
224
+ "tags": [],
225
+ "text": ""
226
+ },
227
+ "attribute": "modal-type",
228
+ "reflect": true,
229
+ "defaultValue": "null"
230
+ },
231
+ "isTypeDialog": {
232
+ "type": "boolean",
233
+ "mutable": false,
234
+ "complexType": {
235
+ "original": "boolean | null",
236
+ "resolved": "boolean | null",
237
+ "references": {}
238
+ },
239
+ "required": false,
240
+ "optional": false,
241
+ "docs": {
242
+ "tags": [],
243
+ "text": ""
244
+ },
245
+ "attribute": "is-type-dialog",
246
+ "reflect": true,
247
+ "defaultValue": "null"
248
+ },
249
+ "uid": {
250
+ "type": "string",
251
+ "mutable": true,
252
+ "complexType": {
253
+ "original": "string",
254
+ "resolved": "string",
255
+ "references": {}
256
+ },
257
+ "required": true,
258
+ "optional": false,
259
+ "docs": {
260
+ "tags": [],
261
+ "text": ""
262
+ },
263
+ "attribute": "uid",
264
+ "reflect": true
265
+ }
266
+ }; }
267
+ static get events() { return [{
268
+ "method": "focusLastElement",
269
+ "name": "focusLastElement",
270
+ "bubbles": true,
271
+ "cancelable": true,
272
+ "composed": true,
273
+ "docs": {
274
+ "tags": [],
275
+ "text": ""
276
+ },
277
+ "complexType": {
278
+ "original": "any",
279
+ "resolved": "any",
280
+ "references": {}
281
+ }
282
+ }, {
283
+ "method": "focusFirstElement",
284
+ "name": "focusFirstElement",
285
+ "bubbles": true,
286
+ "cancelable": true,
287
+ "composed": true,
288
+ "docs": {
289
+ "tags": [],
290
+ "text": ""
291
+ },
292
+ "complexType": {
293
+ "original": "any",
294
+ "resolved": "any",
295
+ "references": {}
296
+ }
297
+ }, {
298
+ "method": "wmModalCloseTriggered",
299
+ "name": "wmModalCloseTriggered",
300
+ "bubbles": true,
301
+ "cancelable": true,
302
+ "composed": true,
303
+ "docs": {
304
+ "tags": [],
305
+ "text": ""
306
+ },
307
+ "complexType": {
308
+ "original": "any",
309
+ "resolved": "any",
310
+ "references": {}
311
+ }
312
+ }, {
313
+ "method": "wmCloseTriggered",
314
+ "name": "wmCloseTriggered",
315
+ "bubbles": true,
316
+ "cancelable": true,
317
+ "composed": true,
318
+ "docs": {
319
+ "tags": [],
320
+ "text": ""
321
+ },
322
+ "complexType": {
323
+ "original": "any",
324
+ "resolved": "any",
325
+ "references": {}
326
+ }
327
+ }, {
328
+ "method": "wmModalPrimaryTriggered",
329
+ "name": "wmModalPrimaryTriggered",
330
+ "bubbles": true,
331
+ "cancelable": true,
332
+ "composed": true,
333
+ "docs": {
334
+ "tags": [],
335
+ "text": ""
336
+ },
337
+ "complexType": {
338
+ "original": "any",
339
+ "resolved": "any",
340
+ "references": {}
341
+ }
342
+ }, {
343
+ "method": "wmPrimaryTriggered",
344
+ "name": "wmPrimaryTriggered",
345
+ "bubbles": true,
346
+ "cancelable": true,
347
+ "composed": true,
348
+ "docs": {
349
+ "tags": [],
350
+ "text": ""
351
+ },
352
+ "complexType": {
353
+ "original": "any",
354
+ "resolved": "any",
355
+ "references": {}
356
+ }
357
+ }, {
358
+ "method": "wmModalSecondaryTriggered",
359
+ "name": "wmModalSecondaryTriggered",
360
+ "bubbles": true,
361
+ "cancelable": true,
362
+ "composed": true,
363
+ "docs": {
364
+ "tags": [],
365
+ "text": ""
366
+ },
367
+ "complexType": {
368
+ "original": "any",
369
+ "resolved": "any",
370
+ "references": {}
371
+ }
372
+ }, {
373
+ "method": "wmSecondaryTriggered",
374
+ "name": "wmSecondaryTriggered",
375
+ "bubbles": true,
376
+ "cancelable": true,
377
+ "composed": true,
378
+ "docs": {
379
+ "tags": [],
380
+ "text": ""
381
+ },
382
+ "complexType": {
383
+ "original": "any",
384
+ "resolved": "any",
385
+ "references": {}
386
+ }
387
+ }]; }
388
+ static get methods() { return {
389
+ "emitCloseEvent": {
390
+ "complexType": {
391
+ "signature": "() => Promise<void>",
392
+ "parameters": [],
393
+ "references": {
394
+ "Promise": {
395
+ "location": "global"
396
+ }
397
+ },
398
+ "return": "Promise<void>"
399
+ },
400
+ "docs": {
401
+ "text": "",
402
+ "tags": []
403
+ }
404
+ },
405
+ "emitPrimaryEvent": {
406
+ "complexType": {
407
+ "signature": "() => Promise<void>",
408
+ "parameters": [],
409
+ "references": {
410
+ "Promise": {
411
+ "location": "global"
412
+ }
413
+ },
414
+ "return": "Promise<void>"
415
+ },
416
+ "docs": {
417
+ "text": "",
418
+ "tags": []
419
+ }
420
+ },
421
+ "emitSecondaryEvent": {
422
+ "complexType": {
423
+ "signature": "() => Promise<void>",
424
+ "parameters": [],
425
+ "references": {
426
+ "Promise": {
427
+ "location": "global"
428
+ }
429
+ },
430
+ "return": "Promise<void>"
431
+ },
432
+ "docs": {
433
+ "text": "",
434
+ "tags": []
435
+ }
436
+ }
437
+ }; }
438
+ static get elementRef() { return "el"; }
439
+ static get watchers() { return [{
440
+ "propName": "open",
441
+ "methodName": "toggleModal"
442
+ }, {
443
+ "propName": "isOpen",
444
+ "methodName": "toggleModal"
445
+ }]; }
446
+ static get listeners() { return [{
447
+ "name": "click",
448
+ "method": "handleClick",
449
+ "target": undefined,
450
+ "capture": false,
451
+ "passive": false
452
+ }, {
453
+ "name": "keydown",
454
+ "method": "closeModalOnEscape",
455
+ "target": undefined,
456
+ "capture": false,
457
+ "passive": false
458
+ }]; }
459
+ }