@internetarchive/modal-manager 2.0.4 → 2.0.5-webdev-8155.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 (101) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +40 -30
  3. package/.github/workflows/gh-pages-main.yml +42 -42
  4. package/.github/workflows/pr-preview.yml +40 -40
  5. package/.prettierrc +4 -0
  6. package/.vscode/extensions.json +10 -0
  7. package/.vscode/tasks.json +12 -0
  8. package/LICENSE +661 -661
  9. package/README.md +139 -139
  10. package/custom-elements.json +170 -170
  11. package/demo/app-root.ts +366 -0
  12. package/dist/demo/app-root.d.ts +22 -0
  13. package/dist/demo/app-root.js +338 -0
  14. package/dist/demo/app-root.js.map +1 -0
  15. package/dist/index.d.ts +7 -7
  16. package/dist/index.js +5 -5
  17. package/dist/src/assets/arrow-left-icon.d.ts +2 -2
  18. package/dist/src/assets/arrow-left-icon.js +2 -2
  19. package/dist/src/assets/ia-logo-icon.d.ts +2 -2
  20. package/dist/src/assets/ia-logo-icon.js +2 -2
  21. package/dist/src/modal-config.d.ts +104 -104
  22. package/dist/src/modal-config.js +23 -24
  23. package/dist/src/modal-config.js.map +1 -1
  24. package/dist/src/modal-manager-host-bridge-interface.d.ts +12 -12
  25. package/dist/src/modal-manager-host-bridge-interface.js +1 -1
  26. package/dist/src/modal-manager-host-bridge.d.ts +34 -34
  27. package/dist/src/modal-manager-host-bridge.js +62 -62
  28. package/dist/src/modal-manager-host-bridge.js.map +1 -1
  29. package/dist/src/modal-manager-interface.d.ts +27 -27
  30. package/dist/src/modal-manager-interface.js +1 -1
  31. package/dist/src/modal-manager-mode.d.ts +10 -10
  32. package/dist/src/modal-manager-mode.js +11 -11
  33. package/dist/src/modal-manager.d.ts +137 -137
  34. package/dist/src/modal-manager.js +243 -249
  35. package/dist/src/modal-manager.js.map +1 -1
  36. package/dist/src/modal-template.d.ts +41 -41
  37. package/dist/src/modal-template.js +119 -118
  38. package/dist/src/modal-template.js.map +1 -1
  39. package/dist/src/shoelace/active-elements.d.ts +15 -15
  40. package/dist/src/shoelace/active-elements.js +28 -27
  41. package/dist/src/shoelace/active-elements.js.map +1 -1
  42. package/dist/src/shoelace/modal.d.ts +24 -24
  43. package/dist/src/shoelace/modal.js +130 -131
  44. package/dist/src/shoelace/modal.js.map +1 -1
  45. package/dist/src/shoelace/tabbable.d.ts +9 -9
  46. package/dist/src/shoelace/tabbable.js +168 -169
  47. package/dist/src/shoelace/tabbable.js.map +1 -1
  48. package/dist/test/modal-config.test.d.ts +1 -1
  49. package/dist/test/modal-config.test.js +68 -69
  50. package/dist/test/modal-config.test.js.map +1 -1
  51. package/dist/test/modal-manager.test.d.ts +1 -1
  52. package/dist/test/modal-manager.test.js +306 -309
  53. package/dist/test/modal-manager.test.js.map +1 -1
  54. package/dist/test/modal-template.test.d.ts +1 -1
  55. package/dist/test/modal-template.test.js +158 -167
  56. package/dist/test/modal-template.test.js.map +1 -1
  57. package/dist/vite.config.d.ts +2 -2
  58. package/dist/vite.config.js +22 -22
  59. package/dist/vitest.config.ci.d.ts +2 -0
  60. package/dist/vitest.config.ci.js +24 -0
  61. package/dist/vitest.config.ci.js.map +1 -0
  62. package/docs/assets/css/main.css +2678 -2678
  63. package/docs/classes/_src_modal_config_.modalconfig.html +429 -429
  64. package/docs/classes/_src_modal_manager_.modalmanager.html +7702 -7702
  65. package/docs/classes/_src_modal_manager_host_bridge_.modalmanagerhostbridge.html +409 -409
  66. package/docs/classes/_src_modal_template_.modaltemplate.html +7096 -7096
  67. package/docs/enums/_src_modal_manager_mode_.modalmanagermode.html +196 -196
  68. package/docs/globals.html +150 -150
  69. package/docs/index.html +252 -252
  70. package/docs/interfaces/_src_modal_manager_host_bridge_interface_.modalmanagerhostbridgeinterface.html +210 -210
  71. package/docs/interfaces/_src_modal_manager_interface_.modalmanagerinterface.html +7095 -7095
  72. package/docs/modules/_index_.html +208 -208
  73. package/docs/modules/_src_modal_config_.html +146 -146
  74. package/docs/modules/_src_modal_manager_.html +146 -146
  75. package/docs/modules/_src_modal_manager_host_bridge_.html +146 -146
  76. package/docs/modules/_src_modal_manager_host_bridge_interface_.html +146 -146
  77. package/docs/modules/_src_modal_manager_interface_.html +146 -146
  78. package/docs/modules/_src_modal_manager_mode_.html +146 -146
  79. package/docs/modules/_src_modal_template_.html +146 -146
  80. package/docs/modules/_test_modal_config_test_.html +106 -106
  81. package/docs/modules/_test_modal_manager_test_.html +106 -106
  82. package/docs/modules/_test_modal_template_test_.html +106 -106
  83. package/eslint.config.mjs +53 -0
  84. package/index.html +33 -300
  85. package/package.json +73 -85
  86. package/renovate.json +7 -7
  87. package/src/modal-config.ts +14 -14
  88. package/src/modal-manager-host-bridge.ts +2 -2
  89. package/src/modal-manager.ts +305 -305
  90. package/src/modal-template.ts +4 -2
  91. package/src/shoelace/LICENSE.md +6 -6
  92. package/src/shoelace/active-elements.ts +3 -2
  93. package/src/shoelace/modal.ts +5 -5
  94. package/src/shoelace/tabbable.ts +4 -3
  95. package/test/modal-config.test.ts +4 -4
  96. package/test/modal-manager.test.ts +402 -393
  97. package/test/modal-template.test.ts +42 -35
  98. package/tsconfig.json +25 -21
  99. package/vitest.config.ci.ts +27 -0
  100. package/.eslintrc.js +0 -14
  101. package/karma.conf.js +0 -24
@@ -1,393 +1,402 @@
1
- import {
2
- fixture,
3
- expect,
4
- oneEvent,
5
- elementUpdated,
6
- nextFrame,
7
- } from '@open-wc/testing';
8
- import { TemplateResult, html } from 'lit';
9
-
10
- import '../src/modal-manager';
11
- import { ModalConfig } from '../src/modal-config';
12
- import { ModalManager } from '../src/modal-manager';
13
- import { ModalManagerMode } from '../src/modal-manager-mode';
14
- import { ModalManagerInterface } from '../src/modal-manager-interface';
15
-
16
- import { getTabbableElements } from '../src/shoelace/tabbable';
17
-
18
- describe('Modal Manager', () => {
19
- it('defaults to closed', async () => {
20
- const el = (await fixture(html`
21
- <modal-manager></modal-manager>
22
- `)) as ModalManager;
23
-
24
- expect(el.mode).to.equal('closed');
25
- });
26
-
27
- it('can be closed by calling closeModal', async () => {
28
- const el = (await fixture(html`
29
- <modal-manager .mode=${ModalManagerMode.Open}></modal-manager>
30
- `)) as ModalManager;
31
-
32
- el.customModalContent = 'foo' as unknown as TemplateResult;
33
- await elementUpdated(el);
34
-
35
- expect(el.customModalContent).to.equal('foo');
36
- el.closeModal();
37
- await elementUpdated(el);
38
-
39
- expect(el.mode).to.equal('closed');
40
- expect(el.customModalContent).to.equal(undefined);
41
- });
42
-
43
- it('can be closed by clicking on the backdrop', async () => {
44
- const el = (await fixture(html`
45
- <modal-manager .mode=${ModalManagerMode.Open}></modal-manager>
46
- `)) as ModalManager;
47
-
48
- const backdrop = el.shadowRoot?.querySelector('.backdrop');
49
- const clickEvent = new MouseEvent('click');
50
-
51
- backdrop?.dispatchEvent(clickEvent);
52
- await elementUpdated(el);
53
-
54
- expect(el.mode).to.equal('closed');
55
- });
56
-
57
- it('emits a modeChanged event when opening', async () => {
58
- const el = (await fixture(html`
59
- <modal-manager></modal-manager>
60
- `)) as ModalManager;
61
-
62
- const config = new ModalConfig();
63
-
64
- setTimeout(() => {
65
- el.showModal({ config });
66
- });
67
- const response = await oneEvent(el, 'modeChanged', false);
68
- expect(response.detail.mode).to.equal(ModalManagerMode.Open);
69
- });
70
-
71
- it('emits a modeChanged event when closing', async () => {
72
- const el = (await fixture(html`
73
- <modal-manager></modal-manager>
74
- `)) as ModalManager;
75
-
76
- const config = new ModalConfig();
77
- el.showModal({ config });
78
- await elementUpdated(el);
79
-
80
- setTimeout(() => {
81
- el.closeModal();
82
- });
83
- const response = await oneEvent(el, 'modeChanged', false);
84
- expect(response.detail.mode).to.equal(ModalManagerMode.Closed);
85
- });
86
-
87
- it('can show a modal', async () => {
88
- const el = (await fixture(html`
89
- <modal-manager></modal-manager>
90
- `)) as ModalManager;
91
-
92
- const config = new ModalConfig();
93
- el.showModal({ config });
94
- await elementUpdated(el);
95
- expect(el.mode).to.equal(ModalManagerMode.Open);
96
- });
97
-
98
- it('sets the --containerHeight CSS property when the window resizes', async () => {
99
- const el = (await fixture(html`
100
- <modal-manager></modal-manager>
101
- `)) as ModalManager;
102
-
103
- const config = new ModalConfig();
104
- el.showModal({ config });
105
- await elementUpdated(el);
106
- const event = new Event('resize');
107
- const propBefore = el.style.getPropertyValue('--containerHeight');
108
- expect(propBefore).to.equal('');
109
- window.dispatchEvent(event);
110
- await elementUpdated(el);
111
- const propAfter = el.style.getPropertyValue('--containerHeight');
112
- expect(propAfter).to.not.equal('');
113
- });
114
-
115
- it('calls the userClosedModalCallback when the user taps the backdrop', async () => {
116
- const el = (await fixture(html`
117
- <modal-manager></modal-manager>
118
- `)) as ModalManager;
119
-
120
- const config = new ModalConfig();
121
- let callbackCalled = false;
122
- const callback = (): void => {
123
- callbackCalled = true;
124
- };
125
- el.showModal({
126
- config,
127
- userClosedModalCallback: callback,
128
- });
129
- await elementUpdated(el);
130
-
131
- const backdrop = el.shadowRoot?.querySelector('.backdrop');
132
- const clickEvent = new MouseEvent('click');
133
- backdrop?.dispatchEvent(clickEvent);
134
-
135
- await elementUpdated(el);
136
-
137
- expect(callbackCalled).to.equal(true);
138
- });
139
-
140
- it('does not call the userClosedModalCallback when the modal just closes', async () => {
141
- const el = (await fixture(html`
142
- <modal-manager></modal-manager>
143
- `)) as ModalManager;
144
-
145
- const config = new ModalConfig();
146
- let callbackCalled = false;
147
- const callback = (): void => {
148
- callbackCalled = true;
149
- };
150
- el.showModal({
151
- config,
152
- userClosedModalCallback: callback,
153
- });
154
- await elementUpdated(el);
155
- el.closeModal();
156
- await elementUpdated(el);
157
- expect(callbackCalled).to.equal(false);
158
- });
159
-
160
- it('calls the userPressedLeftNavButtonCallback when the user clicks the left nav button', async () => {
161
- const el = (await fixture(html`
162
- <modal-manager></modal-manager>
163
- `)) as ModalManager;
164
-
165
- const config = new ModalConfig();
166
- config.showLeftNavButton = true;
167
-
168
- let callbackCalled = false;
169
- const callback = (): void => {
170
- callbackCalled = true;
171
- };
172
- el.showModal({
173
- config,
174
- userPressedLeftNavButtonCallback: callback,
175
- });
176
- await elementUpdated(el);
177
-
178
- const modalTemplate = el.shadowRoot?.querySelector('modal-template');
179
- expect(modalTemplate).to.exist;
180
-
181
- modalTemplate?.dispatchEvent(new Event('leftNavButtonPressed'));
182
-
183
- await elementUpdated(el);
184
-
185
- expect(callbackCalled).to.equal(true);
186
- });
187
-
188
- it('mode is set to closed when close button is pressed', async () => {
189
- const el = (await fixture(html`
190
- <modal-manager></modal-manager>
191
- `)) as ModalManager;
192
-
193
- const config = new ModalConfig();
194
- el.showModal({ config });
195
- await elementUpdated(el);
196
-
197
- expect(el.mode).to.equal('open');
198
-
199
- const modal = el.shadowRoot?.querySelector('modal-template');
200
- const closeButton = modal?.shadowRoot?.querySelector('.close-button');
201
- const clickEvent = new MouseEvent('click');
202
- closeButton?.dispatchEvent(clickEvent);
203
-
204
- await elementUpdated(el);
205
-
206
- expect(el.mode).to.equal('closed');
207
- });
208
-
209
- it('mode is set to closed when close button gets spacebar pressed', async () => {
210
- const el = (await fixture(html`
211
- <modal-manager></modal-manager>
212
- `)) as ModalManager;
213
-
214
- const config = new ModalConfig();
215
- el.showModal({ config });
216
- await elementUpdated(el);
217
-
218
- expect(el.mode).to.equal('open');
219
-
220
- const modal = el.shadowRoot?.querySelector('modal-template');
221
- const closeButton = modal?.shadowRoot?.querySelector('.close-button');
222
-
223
- // Close with keyboard
224
- const spacebarEvent = new KeyboardEvent('keydown', { key: ' ' });
225
- closeButton?.dispatchEvent(spacebarEvent);
226
-
227
- await elementUpdated(el);
228
-
229
- expect(el.mode).to.equal('closed');
230
- });
231
-
232
- it('mode remains open when close button gets non-button keypress', async () => {
233
- const el = (await fixture(html`
234
- <modal-manager></modal-manager>
235
- `)) as ModalManager;
236
-
237
- const config = new ModalConfig();
238
- el.showModal({ config });
239
- await elementUpdated(el);
240
-
241
- expect(el.mode).to.equal('open');
242
-
243
- const modal = el.shadowRoot?.querySelector('modal-template');
244
- const closeButton = modal?.shadowRoot?.querySelector('.close-button');
245
-
246
- // Close with keyboard
247
- const keyboardEvent = new KeyboardEvent('keydown', { key: '.' });
248
- closeButton?.dispatchEvent(keyboardEvent);
249
-
250
- await elementUpdated(el);
251
-
252
- expect(el.mode).to.equal('open');
253
- });
254
-
255
- it('allows the user to close by clicking on the backdrop if configured to', async () => {
256
- const el = (await fixture(html`
257
- <modal-manager></modal-manager>
258
- `)) as ModalManager;
259
-
260
- const config = new ModalConfig();
261
- config.closeOnBackdropClick = true;
262
- el.showModal({ config });
263
- await elementUpdated(el);
264
-
265
- const backdrop = el.shadowRoot?.querySelector('.backdrop');
266
- const clickEvent = new MouseEvent('click');
267
- backdrop?.dispatchEvent(clickEvent);
268
-
269
- await elementUpdated(el);
270
-
271
- expect(el.mode).to.equal('closed');
272
- });
273
-
274
- it("doesn't allow the user to close by clicking on the backdrop if configured to", async () => {
275
- const el = (await fixture(html`
276
- <modal-manager></modal-manager>
277
- `)) as ModalManagerInterface;
278
-
279
- const config = new ModalConfig();
280
- config.closeOnBackdropClick = false;
281
- el.showModal({ config });
282
- await elementUpdated(el);
283
-
284
- const backdrop = el.shadowRoot?.querySelector('.backdrop');
285
- const clickEvent = new MouseEvent('click');
286
- backdrop?.dispatchEvent(clickEvent);
287
-
288
- await elementUpdated(el);
289
-
290
- expect(el.getMode()).to.equal('open');
291
- });
292
-
293
- it('ia logo should not visible on modal', async () => {
294
- const el = (await fixture(html`
295
- <modal-manager></modal-manager>
296
- `)) as ModalManagerInterface;
297
-
298
- const config = new ModalConfig();
299
- config.showHeaderLogo = false;
300
- el.showModal({ config });
301
- await elementUpdated(el);
302
-
303
- const logoIcon = el.shadowRoot?.querySelector('.logo-icon');
304
- expect(logoIcon).to.not.exist;
305
- });
306
-
307
- it('should trap Tab key', async () => {
308
- const el = (await fixture(html`
309
- <modal-manager></modal-manager>
310
- `)) as ModalManager;
311
-
312
- const config = new ModalConfig();
313
- el.showModal({ config });
314
- await elementUpdated(el);
315
-
316
- expect(el.mode).to.equal('open');
317
-
318
- // Tab once to focus
319
- const tabEvent = new KeyboardEvent('keydown', { key: 'Tab' });
320
- document.dispatchEvent(tabEvent);
321
- await elementUpdated(el);
322
-
323
- // Should be only one tabbable element
324
- const modal = el.shadowRoot?.querySelector('modal-template') as HTMLElement;
325
- const tabbableElements = getTabbableElements(modal);
326
- expect(tabbableElements?.length).to.equal(1);
327
-
328
- const closeButton = modal?.shadowRoot?.querySelector(
329
- '.close-button'
330
- ) as HTMLElement;
331
- expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
332
-
333
- // Tab again
334
- el.dispatchEvent(tabEvent);
335
- await elementUpdated(el);
336
-
337
- // Should be only one tabbable element
338
- expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
339
-
340
- // Shift + Tab
341
- const shiftTabEvent = new KeyboardEvent('keydown', {
342
- key: 'Tab',
343
- shiftKey: true,
344
- });
345
- document.dispatchEvent(shiftTabEvent);
346
- await elementUpdated(el);
347
-
348
- // Should be only one tabbable element
349
- expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
350
- });
351
-
352
- it('returns keyboard focus to the triggering element on close', async () => {
353
- const config = new ModalConfig();
354
- const el = (await fixture(html`
355
- <div>
356
- <button>Another button</button>
357
- <button
358
- id="open-modal-btn"
359
- @click=${() => {
360
- const modal = el.querySelector('modal-manager') as ModalManager;
361
- modal.showModal({ config });
362
- }}
363
- >
364
- Open modal
365
- </button>
366
- <modal-manager></modal-manager>
367
- </div>
368
- `)) as HTMLDivElement;
369
-
370
- const openBtn = el.querySelector('#open-modal-btn') as HTMLButtonElement;
371
- const modal = el.querySelector('modal-manager') as ModalManager;
372
-
373
- // Focus is initially on the Open button
374
- openBtn.focus();
375
- expect(document.activeElement).to.equal(openBtn);
376
-
377
- // Focus enters the modal when it is opened
378
- openBtn.click();
379
- await nextFrame();
380
- expect(document.activeElement).to.equal(modal);
381
-
382
- // With the modal already open, simulate showing different content.
383
- // This step is to ensure that even if showModal is called multiple times, we still
384
- // maintain the originally-focused element (subsequent calls do not overwrite it).
385
- modal.showModal({ config: new ModalConfig() });
386
- await nextFrame();
387
-
388
- // Focus returns to the Open button when the modal closes
389
- modal.closeModal();
390
- await modal.updateComplete;
391
- expect(document.activeElement).to.equal(openBtn);
392
- });
393
- });
1
+ import {
2
+ fixture,
3
+ oneEvent,
4
+ elementUpdated,
5
+ nextFrame,
6
+ fixtureCleanup,
7
+ } from '@open-wc/testing-helpers';
8
+ import { describe, test, expect, afterEach } from 'vitest';
9
+ import { TemplateResult, html } from 'lit';
10
+
11
+ import '../src/modal-manager';
12
+ import { ModalConfig } from '../src/modal-config';
13
+ import { ModalManager } from '../src/modal-manager';
14
+ import { ModalManagerMode } from '../src/modal-manager-mode';
15
+ import { ModalManagerInterface } from '../src/modal-manager-interface';
16
+
17
+ import { getTabbableElements } from '../src/shoelace/tabbable';
18
+
19
+ describe('Modal Manager', () => {
20
+ afterEach(() => {
21
+ fixtureCleanup();
22
+ });
23
+
24
+ test('defaults to closed', async () => {
25
+ const el = (await fixture(html`
26
+ <modal-manager></modal-manager>
27
+ `)) as ModalManager;
28
+
29
+ expect(el.mode).to.equal('closed');
30
+ });
31
+
32
+ test('can be closed by calling closeModal', async () => {
33
+ const el = (await fixture(html`
34
+ <modal-manager .mode=${ModalManagerMode.Open}></modal-manager>
35
+ `)) as ModalManager;
36
+
37
+ el.customModalContent = 'foo' as unknown as TemplateResult;
38
+ await elementUpdated(el);
39
+
40
+ expect(el.customModalContent).to.equal('foo');
41
+ el.closeModal();
42
+ await elementUpdated(el);
43
+
44
+ expect(el.mode).to.equal('closed');
45
+ expect(el.customModalContent).to.equal(undefined);
46
+ });
47
+
48
+ test('can be closed by clicking on the backdrop', async () => {
49
+ const el = (await fixture(html`
50
+ <modal-manager .mode=${ModalManagerMode.Open}></modal-manager>
51
+ `)) as ModalManager;
52
+
53
+ const backdrop = el.shadowRoot?.querySelector('.backdrop');
54
+ const clickEvent = new MouseEvent('click');
55
+
56
+ backdrop?.dispatchEvent(clickEvent);
57
+ await elementUpdated(el);
58
+
59
+ expect(el.mode).to.equal('closed');
60
+ });
61
+
62
+ test('emits a modeChanged event when opening', async () => {
63
+ const el = (await fixture(html`
64
+ <modal-manager></modal-manager>
65
+ `)) as ModalManager;
66
+
67
+ const config = new ModalConfig();
68
+
69
+ setTimeout(() => {
70
+ el.showModal({ config });
71
+ });
72
+ const response = await oneEvent(el, 'modeChanged');
73
+ expect(response.detail.mode).to.equal(ModalManagerMode.Open);
74
+ });
75
+
76
+ test('emits a modeChanged event when closing', async () => {
77
+ const el = (await fixture(html`
78
+ <modal-manager></modal-manager>
79
+ `)) as ModalManager;
80
+
81
+ const config = new ModalConfig();
82
+ await el.showModal({ config });
83
+ await elementUpdated(el);
84
+ await nextFrame();
85
+
86
+ setTimeout(() => {
87
+ el.closeModal();
88
+ });
89
+ const response = await oneEvent(el, 'modeChanged');
90
+ expect(response.detail.mode).to.equal(ModalManagerMode.Closed);
91
+ });
92
+
93
+ test('can show a modal', async () => {
94
+ const el = (await fixture(html`
95
+ <modal-manager></modal-manager>
96
+ `)) as ModalManager;
97
+
98
+ const config = new ModalConfig();
99
+ el.showModal({ config });
100
+ await elementUpdated(el);
101
+ expect(el.mode).to.equal(ModalManagerMode.Open);
102
+ });
103
+
104
+ test('sets the --containerHeight CSS property when the window resizes', async () => {
105
+ const el = (await fixture(html`
106
+ <modal-manager></modal-manager>
107
+ `)) as ModalManager;
108
+
109
+ const config = new ModalConfig();
110
+ el.showModal({ config });
111
+ await elementUpdated(el);
112
+ const event = new Event('resize');
113
+ const propBefore = el.style.getPropertyValue('--containerHeight');
114
+ expect(propBefore).to.equal('');
115
+ window.dispatchEvent(event);
116
+ await elementUpdated(el);
117
+ const propAfter = el.style.getPropertyValue('--containerHeight');
118
+ expect(propAfter).to.not.equal('');
119
+ });
120
+
121
+ test('calls the userClosedModalCallback when the user taps the backdrop', async () => {
122
+ const el = (await fixture(html`
123
+ <modal-manager></modal-manager>
124
+ `)) as ModalManager;
125
+
126
+ const config = new ModalConfig();
127
+ let callbackCalled = false;
128
+ const callback = (): void => {
129
+ callbackCalled = true;
130
+ };
131
+ el.showModal({
132
+ config,
133
+ userClosedModalCallback: callback,
134
+ });
135
+ await elementUpdated(el);
136
+
137
+ const backdrop = el.shadowRoot?.querySelector('.backdrop');
138
+ const clickEvent = new MouseEvent('click');
139
+ backdrop?.dispatchEvent(clickEvent);
140
+
141
+ await elementUpdated(el);
142
+
143
+ expect(callbackCalled).to.equal(true);
144
+ });
145
+
146
+ test('does not call the userClosedModalCallback when the modal just closes', async () => {
147
+ const el = (await fixture(html`
148
+ <modal-manager></modal-manager>
149
+ `)) as ModalManager;
150
+
151
+ const config = new ModalConfig();
152
+ let callbackCalled = false;
153
+ const callback = (): void => {
154
+ callbackCalled = true;
155
+ };
156
+ el.showModal({
157
+ config,
158
+ userClosedModalCallback: callback,
159
+ });
160
+ await elementUpdated(el);
161
+ el.closeModal();
162
+ await elementUpdated(el);
163
+ expect(callbackCalled).to.equal(false);
164
+ });
165
+
166
+ test('calls the userPressedLeftNavButtonCallback when the user clicks the left nav button', async () => {
167
+ const el = (await fixture(html`
168
+ <modal-manager></modal-manager>
169
+ `)) as ModalManager;
170
+
171
+ const config = new ModalConfig();
172
+ config.showLeftNavButton = true;
173
+
174
+ let callbackCalled = false;
175
+ const callback = (): void => {
176
+ callbackCalled = true;
177
+ };
178
+ el.showModal({
179
+ config,
180
+ userPressedLeftNavButtonCallback: callback,
181
+ });
182
+ await elementUpdated(el);
183
+
184
+ const modalTemplate = el.shadowRoot?.querySelector('modal-template');
185
+ expect(modalTemplate).to.exist;
186
+
187
+ modalTemplate?.dispatchEvent(new Event('leftNavButtonPressed'));
188
+
189
+ await elementUpdated(el);
190
+
191
+ expect(callbackCalled).to.equal(true);
192
+ });
193
+
194
+ test('mode is set to closed when close button is pressed', async () => {
195
+ const el = (await fixture(html`
196
+ <modal-manager></modal-manager>
197
+ `)) as ModalManager;
198
+
199
+ const config = new ModalConfig();
200
+ el.showModal({ config });
201
+ await elementUpdated(el);
202
+
203
+ expect(el.mode).to.equal('open');
204
+
205
+ const modal = el.shadowRoot?.querySelector('modal-template');
206
+ const closeButton = modal?.shadowRoot?.querySelector('.close-button');
207
+ const clickEvent = new MouseEvent('click');
208
+ closeButton?.dispatchEvent(clickEvent);
209
+
210
+ await elementUpdated(el);
211
+
212
+ expect(el.mode).to.equal('closed');
213
+ });
214
+
215
+ test('mode is set to closed when close button gets spacebar pressed', async () => {
216
+ const el = (await fixture(html`
217
+ <modal-manager></modal-manager>
218
+ `)) as ModalManager;
219
+
220
+ const config = new ModalConfig();
221
+ el.showModal({ config });
222
+ await elementUpdated(el);
223
+
224
+ expect(el.mode).to.equal('open');
225
+
226
+ const modal = el.shadowRoot?.querySelector('modal-template');
227
+ const closeButton = modal?.shadowRoot?.querySelector('.close-button');
228
+
229
+ // Close with keyboard
230
+ const spacebarEvent = new KeyboardEvent('keydown', { key: ' ' });
231
+ closeButton?.dispatchEvent(spacebarEvent);
232
+
233
+ await elementUpdated(el);
234
+
235
+ expect(el.mode).to.equal('closed');
236
+ });
237
+
238
+ test('mode remains open when close button gets non-button keypress', async () => {
239
+ const el = (await fixture(html`
240
+ <modal-manager></modal-manager>
241
+ `)) as ModalManager;
242
+
243
+ const config = new ModalConfig();
244
+ el.showModal({ config });
245
+ await elementUpdated(el);
246
+
247
+ expect(el.mode).to.equal('open');
248
+
249
+ const modal = el.shadowRoot?.querySelector('modal-template');
250
+ const closeButton = modal?.shadowRoot?.querySelector('.close-button');
251
+
252
+ // Close with keyboard
253
+ const keyboardEvent = new KeyboardEvent('keydown', { key: '.' });
254
+ closeButton?.dispatchEvent(keyboardEvent);
255
+
256
+ await elementUpdated(el);
257
+
258
+ expect(el.mode).to.equal('open');
259
+ });
260
+
261
+ test('allows the user to close by clicking on the backdrop if configured to', async () => {
262
+ const el = (await fixture(html`
263
+ <modal-manager></modal-manager>
264
+ `)) as ModalManager;
265
+
266
+ const config = new ModalConfig();
267
+ config.closeOnBackdropClick = true;
268
+ el.showModal({ config });
269
+ await elementUpdated(el);
270
+
271
+ const backdrop = el.shadowRoot?.querySelector('.backdrop');
272
+ const clickEvent = new MouseEvent('click');
273
+ backdrop?.dispatchEvent(clickEvent);
274
+
275
+ await elementUpdated(el);
276
+
277
+ expect(el.mode).to.equal('closed');
278
+ });
279
+
280
+ test("doesn't allow the user to close by clicking on the backdrop if configured to", async () => {
281
+ const el = (await fixture(html`
282
+ <modal-manager></modal-manager>
283
+ `)) as ModalManagerInterface;
284
+
285
+ const config = new ModalConfig();
286
+ config.closeOnBackdropClick = false;
287
+ el.showModal({ config });
288
+ await elementUpdated(el);
289
+
290
+ const backdrop = el.shadowRoot?.querySelector('.backdrop');
291
+ const clickEvent = new MouseEvent('click');
292
+ backdrop?.dispatchEvent(clickEvent);
293
+
294
+ await elementUpdated(el);
295
+
296
+ expect(el.getMode()).to.equal('open');
297
+ });
298
+
299
+ test('ia logo should not visible on modal', async () => {
300
+ const el = (await fixture(html`
301
+ <modal-manager></modal-manager>
302
+ `)) as ModalManagerInterface;
303
+
304
+ const config = new ModalConfig();
305
+ config.showHeaderLogo = false;
306
+ el.showModal({ config });
307
+ await elementUpdated(el);
308
+
309
+ const logoIcon = el.shadowRoot?.querySelector('.logo-icon');
310
+ expect(logoIcon).to.not.exist;
311
+ });
312
+
313
+ test('should trap Tab key', async () => {
314
+ const el = (await fixture(html`
315
+ <modal-manager></modal-manager>
316
+ `)) as ModalManager;
317
+
318
+ const config = new ModalConfig();
319
+ el.showModal({ config });
320
+ await elementUpdated(el);
321
+
322
+ expect(el.mode).to.equal('open');
323
+
324
+ // Tab once to focus
325
+ const tabEvent = new KeyboardEvent('keydown', { key: 'Tab' });
326
+ document.dispatchEvent(tabEvent);
327
+ await elementUpdated(el);
328
+ await nextFrame();
329
+
330
+ // Should be only one tabbable element
331
+ const modal = el.shadowRoot?.querySelector('modal-template') as HTMLElement;
332
+ const tabbableElements = getTabbableElements(modal);
333
+ expect(tabbableElements?.length).to.equal(1);
334
+
335
+ const closeButton = modal?.shadowRoot?.querySelector(
336
+ '.close-button',
337
+ ) as HTMLElement;
338
+ expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
339
+
340
+ // Tab again
341
+ el.dispatchEvent(tabEvent);
342
+ await elementUpdated(el);
343
+ await nextFrame();
344
+
345
+ // Should be only one tabbable element
346
+ expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
347
+
348
+ // Shift + Tab
349
+ const shiftTabEvent = new KeyboardEvent('keydown', {
350
+ key: 'Tab',
351
+ shiftKey: true,
352
+ });
353
+ document.dispatchEvent(shiftTabEvent);
354
+ await elementUpdated(el);
355
+ await nextFrame();
356
+
357
+ // Should be only one tabbable element
358
+ expect(modal?.shadowRoot?.activeElement).to.equal(closeButton);
359
+ });
360
+
361
+ test('returns keyboard focus to the triggering element on close', async () => {
362
+ const config = new ModalConfig();
363
+ const el = (await fixture(html`
364
+ <div>
365
+ <button>Another button</button>
366
+ <button
367
+ id="open-modal-btn"
368
+ @click=${() => {
369
+ const modal = el.querySelector('modal-manager') as ModalManager;
370
+ modal.showModal({ config });
371
+ }}
372
+ >
373
+ Open modal
374
+ </button>
375
+ <modal-manager></modal-manager>
376
+ </div>
377
+ `)) as HTMLDivElement;
378
+
379
+ const openBtn = el.querySelector('#open-modal-btn') as HTMLButtonElement;
380
+ const modal = el.querySelector('modal-manager') as ModalManager;
381
+
382
+ // Focus is initially on the Open button
383
+ openBtn.focus();
384
+ expect(document.activeElement).to.equal(openBtn);
385
+
386
+ // Focus enters the modal when it is opened
387
+ openBtn.click();
388
+ await nextFrame();
389
+ expect(document.activeElement).to.equal(modal);
390
+
391
+ // With the modal already open, simulate showing different content.
392
+ // This step is to ensure that even if showModal is called multiple times, we still
393
+ // maintain the originally-focused element (subsequent calls do not overwrite it).
394
+ modal.showModal({ config: new ModalConfig() });
395
+ await nextFrame();
396
+
397
+ // Focus returns to the Open button when the modal closes
398
+ modal.closeModal();
399
+ await modal.updateComplete;
400
+ expect(document.activeElement).to.equal(openBtn);
401
+ });
402
+ });