@watermarkinsights/ripple 3.5.2 → 3.6.0-0

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 (172) 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-fe8e4bb7.js → global-e676a97a.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 +2 -2
  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 +2 -2
  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 +474 -474
  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 +492 -492
  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 +379 -379
  30. package/dist/cjs/wm-toggletip.cjs.entry.js +124 -124
  31. package/dist/cjs/wm-uploader.cjs.entry.js +356 -347
  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.js +719 -719
  38. package/dist/collection/components/wm-datepicker/priv-datepicker/priv-datepicker.js +1015 -1015
  39. package/dist/collection/components/wm-datepicker/wm-datepicker.js +462 -462
  40. package/dist/collection/components/wm-input/wm-input.js +423 -423
  41. package/dist/collection/components/wm-menuitem/wm-menuitem.js +444 -444
  42. package/dist/collection/components/wm-modal/wm-modal-footer.js +141 -141
  43. package/dist/collection/components/wm-modal/wm-modal-header.js +92 -92
  44. package/dist/collection/components/wm-modal/wm-modal.js +459 -459
  45. package/dist/collection/components/wm-navigator/priv-navigator-button/priv-navigator-button.js +97 -97
  46. package/dist/collection/components/wm-navigator/priv-navigator-item/priv-navigator-item.js +114 -114
  47. package/dist/collection/components/wm-navigator/wm-navigator.js +468 -468
  48. package/dist/collection/components/wm-option/wm-option.js +422 -422
  49. package/dist/collection/components/wm-pagination/wm-pagination.js +368 -368
  50. package/dist/collection/components/wm-search/wm-search.js +479 -479
  51. package/dist/collection/components/wm-select/wm-select.js +718 -718
  52. package/dist/collection/components/wm-snackbar/wm-snackbar.js +297 -297
  53. package/dist/collection/components/wm-tabs/wm-tab-item/wm-tab-item.js +219 -219
  54. package/dist/collection/components/wm-tabs/wm-tab-list/wm-tab-list.js +331 -331
  55. package/dist/collection/components/wm-tabs/wm-tab-panel/wm-tab-panel.js +104 -104
  56. package/dist/collection/components/wm-tag-input/wm-tag-input.js +787 -787
  57. package/dist/collection/components/wm-timepicker/wm-timepicker.js +579 -579
  58. package/dist/collection/components/wm-toggletip/wm-toggletip.js +241 -241
  59. package/dist/collection/components/wm-uploader/wm-network-uploader/wm-network-uploader.js +753 -753
  60. package/dist/collection/components/wm-uploader/wm-uploader.css +16 -9
  61. package/dist/collection/components/wm-uploader/wm-uploader.js +790 -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-169de013.js → global-39a2f585.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 +2 -2
  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 +2 -2
  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 +474 -474
  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 +492 -492
  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 +379 -379
  105. package/dist/esm/wm-toggletip.entry.js +124 -124
  106. package/dist/esm/wm-uploader.entry.js +356 -347
  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-374b4fa6.entry.js → p-33524565.entry.js} +1 -1
  111. package/dist/ripple/{p-888bec42.js → p-43f1298b.js} +0 -0
  112. package/dist/ripple/{p-dea72d46.entry.js → p-4cc71463.entry.js} +1 -1
  113. package/dist/ripple/{p-e60fe2f5.js → p-588b4475.js} +0 -0
  114. package/dist/ripple/{p-b03382ea.entry.js → p-65e3a656.entry.js} +1 -1
  115. package/dist/ripple/{p-a50439f1.entry.js → p-67e288fe.entry.js} +1 -1
  116. package/dist/ripple/{p-31fde2c6.entry.js → p-690b4f41.entry.js} +1 -1
  117. package/dist/ripple/{p-75a9ba2f.entry.js → p-754d3d41.entry.js} +1 -1
  118. package/dist/ripple/{p-7bbd123c.entry.js → p-8923b7d0.entry.js} +1 -1
  119. package/dist/ripple/{p-ba9d3069.entry.js → p-8cd1396e.entry.js} +1 -1
  120. package/dist/ripple/p-a53165df.entry.js +1 -0
  121. package/dist/ripple/{p-e574fb73.entry.js → p-aa973691.entry.js} +1 -1
  122. package/dist/ripple/{p-b4a8c8d3.entry.js → p-b3d5ea85.entry.js} +1 -1
  123. package/dist/ripple/p-c9dcb2ef.js +1 -0
  124. package/dist/ripple/{p-d69c1688.entry.js → p-d8ecd974.entry.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 +82 -82
  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 +61 -61
  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 +82 -80
  161. package/dist/types/components/wm-wrapper/wm-wrapper.d.ts +7 -7
  162. package/dist/types/components.d.ts +28 -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-5ff97329.js +0 -1
  172. package/dist/ripple/p-d5fafa9c.entry.js +0 -1
@@ -1,479 +1,479 @@
1
- import { h, Component, Element, Prop, Watch, Host, Method, Listen, State, Event } from "@stencil/core";
2
- import { intl } from "../../global/functions";
3
- export class Search {
4
- constructor() {
5
- this.searchType = "basic";
6
- this.disabled = false;
7
- /**
8
- * Props required for both variants.
9
- */
10
- this.placeholder = "";
11
- this.label = "";
12
- this.numResults = 0;
13
- /**
14
- * This exposes the input's value on the host component so that the app can access it.
15
- */
16
- this.value = "";
17
- /**
18
- * If the user is tabbing, the search and find variant will display a link to jump to a search result.
19
- */
20
- this.isTabbing = false;
21
- /**
22
- * Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,
23
- * so that tabbing and screen reader users can jump to this option rather than tab through the list to find it.
24
- */
25
- this.highlightedId = "";
26
- this.highlightedName = null;
27
- /**
28
- * Indicates which of the search results is currently highlighted. It will be displayed as "[highlightedNum] of [numResults]" next to the input in the search and find variant.
29
- * This number updates as the user browses using the buttons.
30
- */
31
- this.highlightedNum = 0;
32
- this.previousBlurredValue = "";
33
- /**
34
- * Element refs
35
- */
36
- this.resultsLiveRegion = null;
37
- this.wrapperEl = null;
38
- this.linkEl = null;
39
- }
40
- toggleTabbingOn() {
41
- this.isTabbing = true;
42
- this.linkEl && this.linkEl.classList.remove("sr-only");
43
- this.linkEl && this.linkEl.classList.add("show-for-tabbers");
44
- }
45
- toggleTabbingOff() {
46
- this.isTabbing = false;
47
- this.linkEl && this.linkEl.classList.add("sr-only");
48
- this.linkEl && this.linkEl.classList.remove("show-for-tabbers");
49
- }
50
- componentWillLoad() {
51
- // replacing the prototype's focus event by our own
52
- // to delegate focus to the appropriate el in the shadow root
53
- // we could replace by ShadowRoot.delegatesFocus()
54
- // when there's enough support for it
55
- // @ts-ignore
56
- this.el.focus = function () {
57
- if (!this.disabled) {
58
- this.shadowRoot.querySelector("#wm-search-input").focus();
59
- // onFocus event doesn't run when focus is programmatic,
60
- // so we reproduce this.addFocusStyle here
61
- this.shadowRoot.querySelector("#wm-search-wrapper").classList.add("focus");
62
- }
63
- };
64
- if (this.placeholder === "") {
65
- console.error("You must set the placeholder property for the wm-search component.");
66
- }
67
- if (this.label === "") {
68
- console.error("You must set the label property for the wm-search component.");
69
- }
70
- this.hookToModal();
71
- }
72
- hookToModal() {
73
- // if the search is in a modal we want to clear the input when the modal closes
74
- let el = this.el;
75
- while (!!el) {
76
- if (el.tagName === "WM-MODAL") {
77
- this.parentModal = el;
78
- }
79
- el = el.parentElement;
80
- }
81
- if (this.parentModal) {
82
- const events = ["wmCloseTriggered", "wmPrimaryTriggered", "wmSecondaryTriggered"];
83
- events.map((event) => {
84
- this.parentModal.addEventListener(event, () => {
85
- this.updateValue("");
86
- });
87
- });
88
- }
89
- }
90
- async updateValue(value) {
91
- this.value = value;
92
- //For search-and-find, the results should always restart at "[1 or 0] of ..." after any new input.
93
- //Reset the highlight count here just in case the new value doesn't end up changing the number of results.
94
- this.resetHighlightCountToStart();
95
- }
96
- resetHighlightCountToStart() {
97
- if (this.searchType === "find") {
98
- if (this.numResults) {
99
- this.highlightedNum = 1;
100
- }
101
- else {
102
- this.highlightedNum = 0;
103
- }
104
- }
105
- }
106
- /**
107
- * Unfortunately, simply rendering the prop values for the number of results or highlighted option in the live regions, ideally so that the screen reader reads them when they change, does not work
108
- * ---NVDA in Firefox only reads the specific letters that change in the prop value. The innerHTML of the live region must be explicitly changed in order for the screen reader to read the words in full, i.e., coherently.
109
- *
110
- * An update of the props triggers a re-render, so setting the live region in componentDidRender ensures the screen reader announces any changes to the number of results/highlighted option.
111
- * Note: Updating the innerHTML of the live region does not cause the component to re-render so there's no performance hit here.
112
- */
113
- componentDidRender() {
114
- this.announceChanges();
115
- }
116
- /**
117
- * Set live region to blank and then update it with the message ensure the screen reader registers the changes.
118
- */
119
- announceChanges() {
120
- let message = this.getResultsMessage();
121
- if (this.searchType === "find" && this.highlightedName) {
122
- message += `, ${this.highlightedName}`;
123
- }
124
- this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = "");
125
- window.requestAnimationFrame(() => this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = message));
126
- }
127
- /**
128
- * Creates the message that should be announced by the screen reader.
129
- */
130
- getResultsMessage() {
131
- //If there's no text in the input, don't give any message
132
- if (this.value) {
133
- if (this.searchType === "basic") {
134
- return intl.formatMessage({
135
- id: "search.resultsFound",
136
- defaultMessage: "{numResults, plural, =0 {No results} one {1 result} other {# results}} found",
137
- }, { numResults: this.numResults });
138
- }
139
- else {
140
- return intl.formatMessage({
141
- id: "search.xOfYResults",
142
- defaultMessage: "{numResults, plural, =0 {No results found} other {{current} of {numResults} results}}",
143
- }, { numResults: this.numResults, current: this.highlightedNum });
144
- }
145
- }
146
- else {
147
- return "";
148
- }
149
- }
150
- changeHighlightedNum(newNum) {
151
- if (this.numResults) {
152
- if (newNum < 1) {
153
- // we were on the first item, going down: go to last item
154
- this.highlightedNum = this.numResults;
155
- }
156
- else if (newNum > this.numResults) {
157
- // we were on the last item, going up: go to first item
158
- this.highlightedNum = 1;
159
- }
160
- else {
161
- this.highlightedNum = newNum;
162
- }
163
- this.wmSearchBrowseResults.emit({ position: this.highlightedNum });
164
- this.wmBrowseSearchResults.emit({ position: this.highlightedNum });
165
- }
166
- }
167
- addFocusStyle() {
168
- if (this.wrapperEl) {
169
- this.wrapperEl.classList.add("focus");
170
- }
171
- }
172
- removeFocusStyle() {
173
- if (this.wrapperEl) {
174
- this.wrapperEl.classList.remove("focus");
175
- }
176
- }
177
- handleBlur() {
178
- this.removeFocusStyle();
179
- if (this.previousBlurredValue !== this.value) {
180
- this.wmSearchValueChanged.emit({ value: this.value });
181
- }
182
- this.previousBlurredValue = this.value;
183
- }
184
- /**
185
- * Functions that return elements specifically for search-and-find.
186
- */
187
- renderResultsAndBrowseButtons() {
188
- return (h("div", { class: "wm-find-elements" },
189
- h("div", { id: "results-display", class: "results" }, this.getResultsMessage()),
190
- h("div", { class: "wm-button-collection" },
191
- h("wm-button", { "button-type": "icononly", icon: "f05d", tooltip: intl.formatMessage({
192
- id: "global.previous",
193
- description: "button text",
194
- defaultMessage: "previous",
195
- }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum - 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
196
- id: "search.previousResult",
197
- defaultMessage: "Press to hear previous matching result",
198
- }) }),
199
- h("wm-button", { "button-type": "icononly", icon: "f045", tooltip: intl.formatMessage({
200
- id: "global.next",
201
- description: "button text",
202
- defaultMessage: "next",
203
- }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum + 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
204
- id: "search.nextResult",
205
- defaultMessage: "Press to hear next matching result",
206
- }) }))));
207
- }
208
- renderJumpToLink() {
209
- if (this.numResults && this.highlightedId) {
210
- return (h("a", { ref: (el) => (this.linkEl = el), href: `#${this.highlightedId}`, class: "sr-only" }, intl.formatMessage({
211
- id: "search.jumpToResult",
212
- defaultMessage: "Jump to search result in list",
213
- })));
214
- }
215
- else {
216
- return null;
217
- }
218
- }
219
- /**
220
- * End search and find render helpers
221
- */
222
- render() {
223
- return (h(Host, null,
224
- h("div", { id: "wm-search-wrapper", class: `wm-search-wrapper ${this.searchType}`, ref: (el) => (this.wrapperEl = el) },
225
- h("input", { disabled: this.disabled, id: "wm-search-input", placeholder: this.placeholder, "aria-label": `${this.label ? this.label + ". " : ""}${intl.formatMessage({
226
- id: "search.typeToFilterResults",
227
- defaultMessage: "Type to filter the results",
228
- })}`, onInput: (ev) => this.updateValue(ev.target.value), onFocus: () => this.addFocusStyle(), onBlur: () => this.handleBlur(), "aria-autocomplete": "none", autocomplete: "off", value: this.value }),
229
- h("span", { class: "mdi search-icon" }, String.fromCodePoint(parseInt(`0xf349`))),
230
- this.searchType === "find" && this.renderResultsAndBrowseButtons(),
231
- h("div", { id: "wm-search-live", class: "sr-only", "aria-live": "polite", "aria-atomic": "true", ref: (el) => (this.resultsLiveRegion = el) })),
232
- this.searchType === "find" && this.renderJumpToLink()));
233
- }
234
- static get is() { return "wm-search"; }
235
- static get encapsulation() { return "shadow"; }
236
- static get originalStyleUrls() { return {
237
- "$": ["wm-search.scss"]
238
- }; }
239
- static get styleUrls() { return {
240
- "$": ["wm-search.css"]
241
- }; }
242
- static get properties() { return {
243
- "searchType": {
244
- "type": "string",
245
- "mutable": true,
246
- "complexType": {
247
- "original": "\"basic\" | \"find\"",
248
- "resolved": "\"basic\" | \"find\"",
249
- "references": {}
250
- },
251
- "required": false,
252
- "optional": false,
253
- "docs": {
254
- "tags": [],
255
- "text": ""
256
- },
257
- "attribute": "search-type",
258
- "reflect": false,
259
- "defaultValue": "\"basic\""
260
- },
261
- "disabled": {
262
- "type": "boolean",
263
- "mutable": false,
264
- "complexType": {
265
- "original": "boolean",
266
- "resolved": "boolean",
267
- "references": {}
268
- },
269
- "required": false,
270
- "optional": false,
271
- "docs": {
272
- "tags": [],
273
- "text": ""
274
- },
275
- "attribute": "disabled",
276
- "reflect": true,
277
- "defaultValue": "false"
278
- },
279
- "placeholder": {
280
- "type": "string",
281
- "mutable": false,
282
- "complexType": {
283
- "original": "string",
284
- "resolved": "string",
285
- "references": {}
286
- },
287
- "required": false,
288
- "optional": false,
289
- "docs": {
290
- "tags": [],
291
- "text": "Props required for both variants."
292
- },
293
- "attribute": "placeholder",
294
- "reflect": false,
295
- "defaultValue": "\"\""
296
- },
297
- "label": {
298
- "type": "string",
299
- "mutable": false,
300
- "complexType": {
301
- "original": "string",
302
- "resolved": "string",
303
- "references": {}
304
- },
305
- "required": false,
306
- "optional": false,
307
- "docs": {
308
- "tags": [],
309
- "text": ""
310
- },
311
- "attribute": "label",
312
- "reflect": false,
313
- "defaultValue": "\"\""
314
- },
315
- "numResults": {
316
- "type": "number",
317
- "mutable": true,
318
- "complexType": {
319
- "original": "number",
320
- "resolved": "number",
321
- "references": {}
322
- },
323
- "required": false,
324
- "optional": false,
325
- "docs": {
326
- "tags": [],
327
- "text": ""
328
- },
329
- "attribute": "num-results",
330
- "reflect": false,
331
- "defaultValue": "0"
332
- },
333
- "value": {
334
- "type": "string",
335
- "mutable": true,
336
- "complexType": {
337
- "original": "string",
338
- "resolved": "string",
339
- "references": {}
340
- },
341
- "required": false,
342
- "optional": false,
343
- "docs": {
344
- "tags": [],
345
- "text": "This exposes the input's value on the host component so that the app can access it."
346
- },
347
- "attribute": "value",
348
- "reflect": true,
349
- "defaultValue": "\"\""
350
- },
351
- "highlightedId": {
352
- "type": "string",
353
- "mutable": false,
354
- "complexType": {
355
- "original": "string",
356
- "resolved": "string",
357
- "references": {}
358
- },
359
- "required": false,
360
- "optional": false,
361
- "docs": {
362
- "tags": [],
363
- "text": "Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,\nso that tabbing and screen reader users can jump to this option rather than tab through the list to find it."
364
- },
365
- "attribute": "highlighted-id",
366
- "reflect": false,
367
- "defaultValue": "\"\""
368
- },
369
- "highlightedName": {
370
- "type": "string",
371
- "mutable": false,
372
- "complexType": {
373
- "original": "string | null",
374
- "resolved": "null | string",
375
- "references": {}
376
- },
377
- "required": false,
378
- "optional": false,
379
- "docs": {
380
- "tags": [],
381
- "text": ""
382
- },
383
- "attribute": "highlighted-name",
384
- "reflect": false,
385
- "defaultValue": "null"
386
- }
387
- }; }
388
- static get states() { return {
389
- "isTabbing": {},
390
- "highlightedNum": {},
391
- "previousBlurredValue": {},
392
- "parentModal": {}
393
- }; }
394
- static get events() { return [{
395
- "method": "wmSearchBrowseResults",
396
- "name": "wmSearchBrowseResults",
397
- "bubbles": true,
398
- "cancelable": true,
399
- "composed": true,
400
- "docs": {
401
- "tags": [],
402
- "text": "Emitted when the buttons in the search-and-find variant are pressed."
403
- },
404
- "complexType": {
405
- "original": "{ position: number }",
406
- "resolved": "{ position: number; }",
407
- "references": {}
408
- }
409
- }, {
410
- "method": "wmBrowseSearchResults",
411
- "name": "wmBrowseSearchResults",
412
- "bubbles": true,
413
- "cancelable": true,
414
- "composed": true,
415
- "docs": {
416
- "tags": [],
417
- "text": ""
418
- },
419
- "complexType": {
420
- "original": "{ position: number }",
421
- "resolved": "{ position: number; }",
422
- "references": {}
423
- }
424
- }, {
425
- "method": "wmSearchValueChanged",
426
- "name": "wmSearchValueChanged",
427
- "bubbles": true,
428
- "cancelable": true,
429
- "composed": true,
430
- "docs": {
431
- "tags": [],
432
- "text": ""
433
- },
434
- "complexType": {
435
- "original": "{ value: string }",
436
- "resolved": "{ value: string; }",
437
- "references": {}
438
- }
439
- }]; }
440
- static get methods() { return {
441
- "updateValue": {
442
- "complexType": {
443
- "signature": "(value: string) => Promise<void>",
444
- "parameters": [{
445
- "tags": [],
446
- "text": ""
447
- }],
448
- "references": {
449
- "Promise": {
450
- "location": "global"
451
- }
452
- },
453
- "return": "Promise<void>"
454
- },
455
- "docs": {
456
- "text": "",
457
- "tags": []
458
- }
459
- }
460
- }; }
461
- static get elementRef() { return "el"; }
462
- static get watchers() { return [{
463
- "propName": "numResults",
464
- "methodName": "resetHighlightCountToStart"
465
- }]; }
466
- static get listeners() { return [{
467
- "name": "wmUserIsTabbing",
468
- "method": "toggleTabbingOn",
469
- "target": "window",
470
- "capture": false,
471
- "passive": false
472
- }, {
473
- "name": "wmUserIsNotTabbing",
474
- "method": "toggleTabbingOff",
475
- "target": "window",
476
- "capture": false,
477
- "passive": false
478
- }]; }
479
- }
1
+ import { h, Component, Element, Prop, Watch, Host, Method, Listen, State, Event } from "@stencil/core";
2
+ import { intl } from "../../global/functions";
3
+ export class Search {
4
+ constructor() {
5
+ this.searchType = "basic";
6
+ this.disabled = false;
7
+ /**
8
+ * Props required for both variants.
9
+ */
10
+ this.placeholder = "";
11
+ this.label = "";
12
+ this.numResults = 0;
13
+ /**
14
+ * This exposes the input's value on the host component so that the app can access it.
15
+ */
16
+ this.value = "";
17
+ /**
18
+ * If the user is tabbing, the search and find variant will display a link to jump to a search result.
19
+ */
20
+ this.isTabbing = false;
21
+ /**
22
+ * Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,
23
+ * so that tabbing and screen reader users can jump to this option rather than tab through the list to find it.
24
+ */
25
+ this.highlightedId = "";
26
+ this.highlightedName = null;
27
+ /**
28
+ * Indicates which of the search results is currently highlighted. It will be displayed as "[highlightedNum] of [numResults]" next to the input in the search and find variant.
29
+ * This number updates as the user browses using the buttons.
30
+ */
31
+ this.highlightedNum = 0;
32
+ this.previousBlurredValue = "";
33
+ /**
34
+ * Element refs
35
+ */
36
+ this.resultsLiveRegion = null;
37
+ this.wrapperEl = null;
38
+ this.linkEl = null;
39
+ }
40
+ toggleTabbingOn() {
41
+ this.isTabbing = true;
42
+ this.linkEl && this.linkEl.classList.remove("sr-only");
43
+ this.linkEl && this.linkEl.classList.add("show-for-tabbers");
44
+ }
45
+ toggleTabbingOff() {
46
+ this.isTabbing = false;
47
+ this.linkEl && this.linkEl.classList.add("sr-only");
48
+ this.linkEl && this.linkEl.classList.remove("show-for-tabbers");
49
+ }
50
+ componentWillLoad() {
51
+ // replacing the prototype's focus event by our own
52
+ // to delegate focus to the appropriate el in the shadow root
53
+ // we could replace by ShadowRoot.delegatesFocus()
54
+ // when there's enough support for it
55
+ // @ts-ignore
56
+ this.el.focus = function () {
57
+ if (!this.disabled) {
58
+ this.shadowRoot.querySelector("#wm-search-input").focus();
59
+ // onFocus event doesn't run when focus is programmatic,
60
+ // so we reproduce this.addFocusStyle here
61
+ this.shadowRoot.querySelector("#wm-search-wrapper").classList.add("focus");
62
+ }
63
+ };
64
+ if (this.placeholder === "") {
65
+ console.error("You must set the placeholder property for the wm-search component.");
66
+ }
67
+ if (this.label === "") {
68
+ console.error("You must set the label property for the wm-search component.");
69
+ }
70
+ this.hookToModal();
71
+ }
72
+ hookToModal() {
73
+ // if the search is in a modal we want to clear the input when the modal closes
74
+ let el = this.el;
75
+ while (!!el) {
76
+ if (el.tagName === "WM-MODAL") {
77
+ this.parentModal = el;
78
+ }
79
+ el = el.parentElement;
80
+ }
81
+ if (this.parentModal) {
82
+ const events = ["wmCloseTriggered", "wmPrimaryTriggered", "wmSecondaryTriggered"];
83
+ events.map((event) => {
84
+ this.parentModal.addEventListener(event, () => {
85
+ this.updateValue("");
86
+ });
87
+ });
88
+ }
89
+ }
90
+ async updateValue(value) {
91
+ this.value = value;
92
+ //For search-and-find, the results should always restart at "[1 or 0] of ..." after any new input.
93
+ //Reset the highlight count here just in case the new value doesn't end up changing the number of results.
94
+ this.resetHighlightCountToStart();
95
+ }
96
+ resetHighlightCountToStart() {
97
+ if (this.searchType === "find") {
98
+ if (this.numResults) {
99
+ this.highlightedNum = 1;
100
+ }
101
+ else {
102
+ this.highlightedNum = 0;
103
+ }
104
+ }
105
+ }
106
+ /**
107
+ * Unfortunately, simply rendering the prop values for the number of results or highlighted option in the live regions, ideally so that the screen reader reads them when they change, does not work
108
+ * ---NVDA in Firefox only reads the specific letters that change in the prop value. The innerHTML of the live region must be explicitly changed in order for the screen reader to read the words in full, i.e., coherently.
109
+ *
110
+ * An update of the props triggers a re-render, so setting the live region in componentDidRender ensures the screen reader announces any changes to the number of results/highlighted option.
111
+ * Note: Updating the innerHTML of the live region does not cause the component to re-render so there's no performance hit here.
112
+ */
113
+ componentDidRender() {
114
+ this.announceChanges();
115
+ }
116
+ /**
117
+ * Set live region to blank and then update it with the message ensure the screen reader registers the changes.
118
+ */
119
+ announceChanges() {
120
+ let message = this.getResultsMessage();
121
+ if (this.searchType === "find" && this.highlightedName) {
122
+ message += `, ${this.highlightedName}`;
123
+ }
124
+ this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = "");
125
+ window.requestAnimationFrame(() => this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = message));
126
+ }
127
+ /**
128
+ * Creates the message that should be announced by the screen reader.
129
+ */
130
+ getResultsMessage() {
131
+ //If there's no text in the input, don't give any message
132
+ if (this.value) {
133
+ if (this.searchType === "basic") {
134
+ return intl.formatMessage({
135
+ id: "search.resultsFound",
136
+ defaultMessage: "{numResults, plural, =0 {No results} one {1 result} other {# results}} found",
137
+ }, { numResults: this.numResults });
138
+ }
139
+ else {
140
+ return intl.formatMessage({
141
+ id: "search.xOfYResults",
142
+ defaultMessage: "{numResults, plural, =0 {No results found} other {{current} of {numResults} results}}",
143
+ }, { numResults: this.numResults, current: this.highlightedNum });
144
+ }
145
+ }
146
+ else {
147
+ return "";
148
+ }
149
+ }
150
+ changeHighlightedNum(newNum) {
151
+ if (this.numResults) {
152
+ if (newNum < 1) {
153
+ // we were on the first item, going down: go to last item
154
+ this.highlightedNum = this.numResults;
155
+ }
156
+ else if (newNum > this.numResults) {
157
+ // we were on the last item, going up: go to first item
158
+ this.highlightedNum = 1;
159
+ }
160
+ else {
161
+ this.highlightedNum = newNum;
162
+ }
163
+ this.wmSearchBrowseResults.emit({ position: this.highlightedNum });
164
+ this.wmBrowseSearchResults.emit({ position: this.highlightedNum });
165
+ }
166
+ }
167
+ addFocusStyle() {
168
+ if (this.wrapperEl) {
169
+ this.wrapperEl.classList.add("focus");
170
+ }
171
+ }
172
+ removeFocusStyle() {
173
+ if (this.wrapperEl) {
174
+ this.wrapperEl.classList.remove("focus");
175
+ }
176
+ }
177
+ handleBlur() {
178
+ this.removeFocusStyle();
179
+ if (this.previousBlurredValue !== this.value) {
180
+ this.wmSearchValueChanged.emit({ value: this.value });
181
+ }
182
+ this.previousBlurredValue = this.value;
183
+ }
184
+ /**
185
+ * Functions that return elements specifically for search-and-find.
186
+ */
187
+ renderResultsAndBrowseButtons() {
188
+ return (h("div", { class: "wm-find-elements" },
189
+ h("div", { id: "results-display", class: "results" }, this.getResultsMessage()),
190
+ h("div", { class: "wm-button-collection" },
191
+ h("wm-button", { "button-type": "icononly", icon: "f05d", tooltip: intl.formatMessage({
192
+ id: "global.previous",
193
+ description: "button text",
194
+ defaultMessage: "previous",
195
+ }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum - 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
196
+ id: "search.previousResult",
197
+ defaultMessage: "Press to hear previous matching result",
198
+ }) }),
199
+ h("wm-button", { "button-type": "icononly", icon: "f045", tooltip: intl.formatMessage({
200
+ id: "global.next",
201
+ description: "button text",
202
+ defaultMessage: "next",
203
+ }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum + 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
204
+ id: "search.nextResult",
205
+ defaultMessage: "Press to hear next matching result",
206
+ }) }))));
207
+ }
208
+ renderJumpToLink() {
209
+ if (this.numResults && this.highlightedId) {
210
+ return (h("a", { ref: (el) => (this.linkEl = el), href: `#${this.highlightedId}`, class: "sr-only" }, intl.formatMessage({
211
+ id: "search.jumpToResult",
212
+ defaultMessage: "Jump to search result in list",
213
+ })));
214
+ }
215
+ else {
216
+ return null;
217
+ }
218
+ }
219
+ /**
220
+ * End search and find render helpers
221
+ */
222
+ render() {
223
+ return (h(Host, null,
224
+ h("div", { id: "wm-search-wrapper", class: `wm-search-wrapper ${this.searchType}`, ref: (el) => (this.wrapperEl = el) },
225
+ h("input", { disabled: this.disabled, id: "wm-search-input", placeholder: this.placeholder, "aria-label": `${this.label ? this.label + ". " : ""}${intl.formatMessage({
226
+ id: "search.typeToFilterResults",
227
+ defaultMessage: "Type to filter the results",
228
+ })}`, onInput: (ev) => this.updateValue(ev.target.value), onFocus: () => this.addFocusStyle(), onBlur: () => this.handleBlur(), "aria-autocomplete": "none", autocomplete: "off", value: this.value }),
229
+ h("span", { class: "mdi search-icon" }, String.fromCodePoint(parseInt(`0xf349`))),
230
+ this.searchType === "find" && this.renderResultsAndBrowseButtons(),
231
+ h("div", { id: "wm-search-live", class: "sr-only", "aria-live": "polite", "aria-atomic": "true", ref: (el) => (this.resultsLiveRegion = el) })),
232
+ this.searchType === "find" && this.renderJumpToLink()));
233
+ }
234
+ static get is() { return "wm-search"; }
235
+ static get encapsulation() { return "shadow"; }
236
+ static get originalStyleUrls() { return {
237
+ "$": ["wm-search.scss"]
238
+ }; }
239
+ static get styleUrls() { return {
240
+ "$": ["wm-search.css"]
241
+ }; }
242
+ static get properties() { return {
243
+ "searchType": {
244
+ "type": "string",
245
+ "mutable": true,
246
+ "complexType": {
247
+ "original": "\"basic\" | \"find\"",
248
+ "resolved": "\"basic\" | \"find\"",
249
+ "references": {}
250
+ },
251
+ "required": false,
252
+ "optional": false,
253
+ "docs": {
254
+ "tags": [],
255
+ "text": ""
256
+ },
257
+ "attribute": "search-type",
258
+ "reflect": false,
259
+ "defaultValue": "\"basic\""
260
+ },
261
+ "disabled": {
262
+ "type": "boolean",
263
+ "mutable": false,
264
+ "complexType": {
265
+ "original": "boolean",
266
+ "resolved": "boolean",
267
+ "references": {}
268
+ },
269
+ "required": false,
270
+ "optional": false,
271
+ "docs": {
272
+ "tags": [],
273
+ "text": ""
274
+ },
275
+ "attribute": "disabled",
276
+ "reflect": true,
277
+ "defaultValue": "false"
278
+ },
279
+ "placeholder": {
280
+ "type": "string",
281
+ "mutable": false,
282
+ "complexType": {
283
+ "original": "string",
284
+ "resolved": "string",
285
+ "references": {}
286
+ },
287
+ "required": false,
288
+ "optional": false,
289
+ "docs": {
290
+ "tags": [],
291
+ "text": "Props required for both variants."
292
+ },
293
+ "attribute": "placeholder",
294
+ "reflect": false,
295
+ "defaultValue": "\"\""
296
+ },
297
+ "label": {
298
+ "type": "string",
299
+ "mutable": false,
300
+ "complexType": {
301
+ "original": "string",
302
+ "resolved": "string",
303
+ "references": {}
304
+ },
305
+ "required": false,
306
+ "optional": false,
307
+ "docs": {
308
+ "tags": [],
309
+ "text": ""
310
+ },
311
+ "attribute": "label",
312
+ "reflect": false,
313
+ "defaultValue": "\"\""
314
+ },
315
+ "numResults": {
316
+ "type": "number",
317
+ "mutable": true,
318
+ "complexType": {
319
+ "original": "number",
320
+ "resolved": "number",
321
+ "references": {}
322
+ },
323
+ "required": false,
324
+ "optional": false,
325
+ "docs": {
326
+ "tags": [],
327
+ "text": ""
328
+ },
329
+ "attribute": "num-results",
330
+ "reflect": false,
331
+ "defaultValue": "0"
332
+ },
333
+ "value": {
334
+ "type": "string",
335
+ "mutable": true,
336
+ "complexType": {
337
+ "original": "string",
338
+ "resolved": "string",
339
+ "references": {}
340
+ },
341
+ "required": false,
342
+ "optional": false,
343
+ "docs": {
344
+ "tags": [],
345
+ "text": "This exposes the input's value on the host component so that the app can access it."
346
+ },
347
+ "attribute": "value",
348
+ "reflect": true,
349
+ "defaultValue": "\"\""
350
+ },
351
+ "highlightedId": {
352
+ "type": "string",
353
+ "mutable": false,
354
+ "complexType": {
355
+ "original": "string",
356
+ "resolved": "string",
357
+ "references": {}
358
+ },
359
+ "required": false,
360
+ "optional": false,
361
+ "docs": {
362
+ "tags": [],
363
+ "text": "Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,\r\nso that tabbing and screen reader users can jump to this option rather than tab through the list to find it."
364
+ },
365
+ "attribute": "highlighted-id",
366
+ "reflect": false,
367
+ "defaultValue": "\"\""
368
+ },
369
+ "highlightedName": {
370
+ "type": "string",
371
+ "mutable": false,
372
+ "complexType": {
373
+ "original": "string | null",
374
+ "resolved": "null | string",
375
+ "references": {}
376
+ },
377
+ "required": false,
378
+ "optional": false,
379
+ "docs": {
380
+ "tags": [],
381
+ "text": ""
382
+ },
383
+ "attribute": "highlighted-name",
384
+ "reflect": false,
385
+ "defaultValue": "null"
386
+ }
387
+ }; }
388
+ static get states() { return {
389
+ "isTabbing": {},
390
+ "highlightedNum": {},
391
+ "previousBlurredValue": {},
392
+ "parentModal": {}
393
+ }; }
394
+ static get events() { return [{
395
+ "method": "wmSearchBrowseResults",
396
+ "name": "wmSearchBrowseResults",
397
+ "bubbles": true,
398
+ "cancelable": true,
399
+ "composed": true,
400
+ "docs": {
401
+ "tags": [],
402
+ "text": "Emitted when the buttons in the search-and-find variant are pressed."
403
+ },
404
+ "complexType": {
405
+ "original": "{ position: number }",
406
+ "resolved": "{ position: number; }",
407
+ "references": {}
408
+ }
409
+ }, {
410
+ "method": "wmBrowseSearchResults",
411
+ "name": "wmBrowseSearchResults",
412
+ "bubbles": true,
413
+ "cancelable": true,
414
+ "composed": true,
415
+ "docs": {
416
+ "tags": [],
417
+ "text": ""
418
+ },
419
+ "complexType": {
420
+ "original": "{ position: number }",
421
+ "resolved": "{ position: number; }",
422
+ "references": {}
423
+ }
424
+ }, {
425
+ "method": "wmSearchValueChanged",
426
+ "name": "wmSearchValueChanged",
427
+ "bubbles": true,
428
+ "cancelable": true,
429
+ "composed": true,
430
+ "docs": {
431
+ "tags": [],
432
+ "text": ""
433
+ },
434
+ "complexType": {
435
+ "original": "{ value: string }",
436
+ "resolved": "{ value: string; }",
437
+ "references": {}
438
+ }
439
+ }]; }
440
+ static get methods() { return {
441
+ "updateValue": {
442
+ "complexType": {
443
+ "signature": "(value: string) => Promise<void>",
444
+ "parameters": [{
445
+ "tags": [],
446
+ "text": ""
447
+ }],
448
+ "references": {
449
+ "Promise": {
450
+ "location": "global"
451
+ }
452
+ },
453
+ "return": "Promise<void>"
454
+ },
455
+ "docs": {
456
+ "text": "",
457
+ "tags": []
458
+ }
459
+ }
460
+ }; }
461
+ static get elementRef() { return "el"; }
462
+ static get watchers() { return [{
463
+ "propName": "numResults",
464
+ "methodName": "resetHighlightCountToStart"
465
+ }]; }
466
+ static get listeners() { return [{
467
+ "name": "wmUserIsTabbing",
468
+ "method": "toggleTabbingOn",
469
+ "target": "window",
470
+ "capture": false,
471
+ "passive": false
472
+ }, {
473
+ "name": "wmUserIsNotTabbing",
474
+ "method": "toggleTabbingOff",
475
+ "target": "window",
476
+ "capture": false,
477
+ "passive": false
478
+ }]; }
479
+ }