@skyux/flyout 5.0.4 → 5.1.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 (23) hide show
  1. package/bundles/skyux-flyout.umd.js +123 -31
  2. package/documentation.json +439 -150
  3. package/esm2015/modules/flyout/flyout-instance.js +13 -2
  4. package/esm2015/modules/flyout/flyout.component.js +67 -19
  5. package/esm2015/modules/flyout/flyout.module.js +6 -2
  6. package/esm2015/modules/flyout/flyout.service.js +21 -7
  7. package/esm2015/modules/flyout/types/flyout-before-close-handler.js +9 -0
  8. package/esm2015/modules/flyout/types/flyout-close-args.js +2 -0
  9. package/esm2015/modules/flyout/types/flyout-config.js +1 -1
  10. package/esm2015/modules/flyout/types/flyout-message.js +1 -1
  11. package/esm2015/public-api.js +3 -1
  12. package/fesm2015/skyux-flyout.js +110 -25
  13. package/fesm2015/skyux-flyout.js.map +1 -1
  14. package/modules/flyout/flyout-instance.d.ts +12 -2
  15. package/modules/flyout/flyout.component.d.ts +11 -2
  16. package/modules/flyout/flyout.module.d.ts +10 -9
  17. package/modules/flyout/flyout.service.d.ts +7 -3
  18. package/modules/flyout/types/flyout-before-close-handler.d.ts +10 -0
  19. package/modules/flyout/types/flyout-close-args.d.ts +9 -0
  20. package/modules/flyout/types/flyout-config.d.ts +10 -0
  21. package/modules/flyout/types/flyout-message.d.ts +3 -0
  22. package/package.json +2 -1
  23. package/public-api.d.ts +2 -0
package/documentation.json CHANGED
@@ -1,9 +1,11 @@
1
1
  {
2
2
  "anchorIds": {
3
+ "SkyFlyoutBeforeCloseHandler": "class-skyflyoutbeforeclosehandler",
3
4
  "SkyFlyoutInstance": "class-skyflyoutinstance",
4
5
  "SkyFlyoutModule": "class-skyflyoutmodule",
5
6
  "SkyFlyoutService": "class-skyflyoutservice",
6
7
  "SkyFlyoutAction": "interface-skyflyoutaction",
8
+ "SkyFlyoutCloseArgs": "interface-skyflyoutcloseargs",
7
9
  "SkyFlyoutConfig": "interface-skyflyoutconfig",
8
10
  "SkyFlyoutPermalink": "interface-skyflyoutpermalink"
9
11
  },
@@ -16,7 +18,107 @@
16
18
  "originalName": "",
17
19
  "children": [
18
20
  {
19
- "id": 110,
21
+ "id": 197,
22
+ "name": "SkyFlyoutBeforeCloseHandler",
23
+ "kind": 128,
24
+ "kindString": "Class",
25
+ "flags": {},
26
+ "comment": {
27
+ "shortText": "Handler for notifying the flyout when it is appropriate to close the flyout. This will be returned from the flyout instance's `beforeClose` observable."
28
+ },
29
+ "children": [
30
+ {
31
+ "id": 198,
32
+ "name": "constructor",
33
+ "kind": 512,
34
+ "kindString": "Constructor",
35
+ "flags": {},
36
+ "sources": [
37
+ {
38
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-before-close-handler.ts",
39
+ "line": 10,
40
+ "character": 2
41
+ }
42
+ ],
43
+ "signatures": [
44
+ {
45
+ "id": 199,
46
+ "name": "new SkyFlyoutBeforeCloseHandler",
47
+ "kind": 16384,
48
+ "kindString": "Constructor signature",
49
+ "flags": {},
50
+ "parameters": [
51
+ {
52
+ "id": 200,
53
+ "name": "closeFlyoutFunction",
54
+ "kind": 32768,
55
+ "kindString": "Parameter",
56
+ "flags": {},
57
+ "type": {
58
+ "type": "reference",
59
+ "name": "Function"
60
+ }
61
+ }
62
+ ],
63
+ "type": {
64
+ "type": "reference",
65
+ "id": 197,
66
+ "name": "SkyFlyoutBeforeCloseHandler"
67
+ }
68
+ }
69
+ ]
70
+ },
71
+ {
72
+ "id": 201,
73
+ "name": "closeFlyout",
74
+ "kind": 1024,
75
+ "kindString": "Property",
76
+ "flags": {
77
+ "isPublic": true,
78
+ "isReadonly": true
79
+ },
80
+ "comment": {
81
+ "shortText": "Function which should be called to close the flyout. This should be called once any intervening actions have completed."
82
+ },
83
+ "sources": [
84
+ {
85
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-before-close-handler.ts",
86
+ "line": 8,
87
+ "character": 18
88
+ }
89
+ ],
90
+ "type": {
91
+ "type": "reference",
92
+ "name": "Function"
93
+ }
94
+ }
95
+ ],
96
+ "groups": [
97
+ {
98
+ "title": "Constructors",
99
+ "kind": 512,
100
+ "children": [
101
+ 198
102
+ ]
103
+ },
104
+ {
105
+ "title": "Properties",
106
+ "kind": 1024,
107
+ "children": [
108
+ 201
109
+ ]
110
+ }
111
+ ],
112
+ "sources": [
113
+ {
114
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-before-close-handler.ts",
115
+ "line": 4,
116
+ "character": 13
117
+ }
118
+ ]
119
+ },
120
+ {
121
+ "id": 123,
20
122
  "name": "SkyFlyoutInstance",
21
123
  "kind": 128,
22
124
  "kindString": "Class",
@@ -26,7 +128,7 @@
26
128
  },
27
129
  "children": [
28
130
  {
29
- "id": 111,
131
+ "id": 124,
30
132
  "name": "constructor",
31
133
  "kind": 512,
32
134
  "kindString": "Constructor",
@@ -34,20 +136,20 @@
34
136
  "sources": [
35
137
  {
36
138
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
37
- "line": 103,
139
+ "line": 117,
38
140
  "character": 2
39
141
  }
40
142
  ],
41
143
  "signatures": [
42
144
  {
43
- "id": 112,
145
+ "id": 125,
44
146
  "name": "new SkyFlyoutInstance",
45
147
  "kind": 16384,
46
148
  "kindString": "Constructor signature",
47
149
  "flags": {},
48
150
  "typeParameter": [
49
151
  {
50
- "id": 113,
152
+ "id": 126,
51
153
  "name": "T",
52
154
  "kind": 131072,
53
155
  "kindString": "Type parameter",
@@ -56,11 +158,11 @@
56
158
  ],
57
159
  "type": {
58
160
  "type": "reference",
59
- "id": 110,
161
+ "id": 123,
60
162
  "typeArguments": [
61
163
  {
62
164
  "type": "reference",
63
- "id": 113,
165
+ "id": 126,
64
166
  "name": "T"
65
167
  }
66
168
  ],
@@ -70,7 +172,7 @@
70
172
  ]
71
173
  },
72
174
  {
73
- "id": 114,
175
+ "id": 129,
74
176
  "name": "closed",
75
177
  "kind": 1024,
76
178
  "kindString": "Property",
@@ -83,7 +185,7 @@
83
185
  "sources": [
84
186
  {
85
187
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
86
- "line": 16,
188
+ "line": 28,
87
189
  "character": 9
88
190
  }
89
191
  ],
@@ -100,7 +202,7 @@
100
202
  "defaultValue": "..."
101
203
  },
102
204
  {
103
- "id": 115,
205
+ "id": 130,
104
206
  "name": "componentInstance",
105
207
  "kind": 1024,
106
208
  "kindString": "Property",
@@ -113,18 +215,18 @@
113
215
  "sources": [
114
216
  {
115
217
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
116
- "line": 21,
218
+ "line": 33,
117
219
  "character": 9
118
220
  }
119
221
  ],
120
222
  "type": {
121
223
  "type": "reference",
122
- "id": 113,
224
+ "id": 126,
123
225
  "name": "T"
124
226
  }
125
227
  },
126
228
  {
127
- "id": 118,
229
+ "id": 133,
128
230
  "name": "isOpen",
129
231
  "kind": 1024,
130
232
  "kindString": "Property",
@@ -143,7 +245,7 @@
143
245
  "sources": [
144
246
  {
145
247
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
146
- "line": 35,
248
+ "line": 47,
147
249
  "character": 9
148
250
  }
149
251
  ],
@@ -154,7 +256,46 @@
154
256
  "defaultValue": "true"
155
257
  },
156
258
  {
157
- "id": 119,
259
+ "id": 127,
260
+ "name": "beforeClose",
261
+ "kind": 262144,
262
+ "kindString": "Accessor",
263
+ "flags": {
264
+ "isPublic": true
265
+ },
266
+ "sources": [
267
+ {
268
+ "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
269
+ "line": 21,
270
+ "character": 13
271
+ }
272
+ ],
273
+ "getSignature": [
274
+ {
275
+ "id": 128,
276
+ "name": "beforeClose",
277
+ "kind": 524288,
278
+ "kindString": "Get signature",
279
+ "flags": {},
280
+ "comment": {
281
+ "shortText": "An event that the modal instance emits when it is about to close.\nIf a subscription exists for this event,\nthe modal does not close until the subscriber calls the handler's `closeModal` method."
282
+ },
283
+ "type": {
284
+ "type": "reference",
285
+ "typeArguments": [
286
+ {
287
+ "type": "reference",
288
+ "id": 197,
289
+ "name": "SkyFlyoutBeforeCloseHandler"
290
+ }
291
+ ],
292
+ "name": "Observable"
293
+ }
294
+ }
295
+ ]
296
+ },
297
+ {
298
+ "id": 134,
158
299
  "name": "iteratorNextButtonClick",
159
300
  "kind": 262144,
160
301
  "kindString": "Accessor",
@@ -164,13 +305,13 @@
164
305
  "sources": [
165
306
  {
166
307
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
167
- "line": 40,
308
+ "line": 52,
168
309
  "character": 13
169
310
  }
170
311
  ],
171
312
  "getSignature": [
172
313
  {
173
- "id": 120,
314
+ "id": 135,
174
315
  "name": "iteratorNextButtonClick",
175
316
  "kind": 524288,
176
317
  "kindString": "Get signature",
@@ -192,7 +333,7 @@
192
333
  ]
193
334
  },
194
335
  {
195
- "id": 123,
336
+ "id": 138,
196
337
  "name": "iteratorNextButtonDisabled",
197
338
  "kind": 262144,
198
339
  "kindString": "Accessor",
@@ -202,13 +343,13 @@
202
343
  "sources": [
203
344
  {
204
345
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
205
- "line": 55,
346
+ "line": 67,
206
347
  "character": 13
207
348
  }
208
349
  ],
209
350
  "getSignature": [
210
351
  {
211
- "id": 124,
352
+ "id": 139,
212
353
  "name": "iteratorNextButtonDisabled",
213
354
  "kind": 524288,
214
355
  "kindString": "Get signature",
@@ -224,7 +365,7 @@
224
365
  ],
225
366
  "setSignature": [
226
367
  {
227
- "id": 125,
368
+ "id": 140,
228
369
  "name": "iteratorNextButtonDisabled",
229
370
  "kind": 1048576,
230
371
  "kindString": "Set signature",
@@ -240,7 +381,7 @@
240
381
  },
241
382
  "parameters": [
242
383
  {
243
- "id": 126,
384
+ "id": 141,
244
385
  "name": "newValue",
245
386
  "kind": 32768,
246
387
  "kindString": "Parameter",
@@ -259,7 +400,7 @@
259
400
  ]
260
401
  },
261
402
  {
262
- "id": 121,
403
+ "id": 136,
263
404
  "name": "iteratorPreviousButtonClick",
264
405
  "kind": 262144,
265
406
  "kindString": "Accessor",
@@ -269,13 +410,13 @@
269
410
  "sources": [
270
411
  {
271
412
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
272
- "line": 47,
413
+ "line": 59,
273
414
  "character": 13
274
415
  }
275
416
  ],
276
417
  "getSignature": [
277
418
  {
278
- "id": 122,
419
+ "id": 137,
279
420
  "name": "iteratorPreviousButtonClick",
280
421
  "kind": 524288,
281
422
  "kindString": "Get signature",
@@ -297,7 +438,7 @@
297
438
  ]
298
439
  },
299
440
  {
300
- "id": 127,
441
+ "id": 142,
301
442
  "name": "iteratorPreviousButtonDisabled",
302
443
  "kind": 262144,
303
444
  "kindString": "Accessor",
@@ -307,13 +448,13 @@
307
448
  "sources": [
308
449
  {
309
450
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
310
- "line": 76,
451
+ "line": 88,
311
452
  "character": 13
312
453
  }
313
454
  ],
314
455
  "getSignature": [
315
456
  {
316
- "id": 128,
457
+ "id": 143,
317
458
  "name": "iteratorPreviousButtonDisabled",
318
459
  "kind": 524288,
319
460
  "kindString": "Get signature",
@@ -329,7 +470,7 @@
329
470
  ],
330
471
  "setSignature": [
331
472
  {
332
- "id": 129,
473
+ "id": 144,
333
474
  "name": "iteratorPreviousButtonDisabled",
334
475
  "kind": 1048576,
335
476
  "kindString": "Set signature",
@@ -345,7 +486,7 @@
345
486
  },
346
487
  "parameters": [
347
488
  {
348
- "id": 130,
489
+ "id": 145,
349
490
  "name": "newValue",
350
491
  "kind": 32768,
351
492
  "kindString": "Parameter",
@@ -364,7 +505,7 @@
364
505
  ]
365
506
  },
366
507
  {
367
- "id": 136,
508
+ "id": 152,
368
509
  "name": "close",
369
510
  "kind": 2048,
370
511
  "kindString": "Method",
@@ -374,13 +515,13 @@
374
515
  "sources": [
375
516
  {
376
517
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
377
- "line": 112,
518
+ "line": 127,
378
519
  "character": 9
379
520
  }
380
521
  ],
381
522
  "signatures": [
382
523
  {
383
- "id": 137,
524
+ "id": 153,
384
525
  "name": "close",
385
526
  "kind": 4096,
386
527
  "kindString": "Call signature",
@@ -388,6 +529,25 @@
388
529
  "comment": {
389
530
  "shortText": "Closes the flyout instance and emits its `closed` event."
390
531
  },
532
+ "parameters": [
533
+ {
534
+ "id": 154,
535
+ "name": "args",
536
+ "kind": 32768,
537
+ "kindString": "Parameter",
538
+ "flags": {
539
+ "isOptional": true
540
+ },
541
+ "comment": {
542
+ "shortText": "Arguments used when closing the flyout.\n"
543
+ },
544
+ "type": {
545
+ "type": "reference",
546
+ "id": 202,
547
+ "name": "SkyFlyoutCloseArgs"
548
+ }
549
+ }
550
+ ],
391
551
  "type": {
392
552
  "type": "intrinsic",
393
553
  "name": "void"
@@ -401,46 +561,47 @@
401
561
  "title": "Constructors",
402
562
  "kind": 512,
403
563
  "children": [
404
- 111
564
+ 124
405
565
  ]
406
566
  },
407
567
  {
408
568
  "title": "Properties",
409
569
  "kind": 1024,
410
570
  "children": [
411
- 114,
412
- 115,
413
- 118
571
+ 129,
572
+ 130,
573
+ 133
414
574
  ]
415
575
  },
416
576
  {
417
577
  "title": "Accessors",
418
578
  "kind": 262144,
419
579
  "children": [
420
- 119,
421
- 123,
422
- 121,
423
- 127
580
+ 127,
581
+ 134,
582
+ 138,
583
+ 136,
584
+ 142
424
585
  ]
425
586
  },
426
587
  {
427
588
  "title": "Methods",
428
589
  "kind": 2048,
429
590
  "children": [
430
- 136
591
+ 152
431
592
  ]
432
593
  }
433
594
  ],
434
595
  "sources": [
435
596
  {
436
597
  "fileName": "projects/flyout/src/modules/flyout/flyout-instance.ts",
437
- "line": 12,
598
+ "line": 15,
438
599
  "character": 13
439
600
  }
440
601
  ],
441
602
  "typeParameter": [
442
603
  {
443
- "id": 138,
604
+ "id": 155,
444
605
  "name": "T",
445
606
  "kind": 131072,
446
607
  "kindString": "Type parameter",
@@ -449,7 +610,7 @@
449
610
  ]
450
611
  },
451
612
  {
452
- "id": 139,
613
+ "id": 156,
453
614
  "name": "SkyFlyoutModule",
454
615
  "kind": 128,
455
616
  "kindString": "Class",
@@ -462,27 +623,27 @@
462
623
  "name": "NgModule"
463
624
  },
464
625
  "arguments": {
465
- "obj": "{\n declarations: [SkyFlyoutComponent, SkyFlyoutIteratorComponent],\n imports: [\n CommonModule,\n FormsModule,\n RouterModule,\n SkyI18nModule,\n SkyIconModule,\n SkyFlyoutResourcesModule,\n SkyThemeModule,\n SkyHrefModule,\n ],\n exports: [SkyFlyoutComponent],\n entryComponents: [SkyFlyoutComponent],\n}"
626
+ "obj": "{\n declarations: [SkyFlyoutComponent, SkyFlyoutIteratorComponent],\n imports: [\n A11yModule,\n CommonModule,\n FormsModule,\n RouterModule,\n SkyI18nModule,\n SkyIconModule,\n SkyFlyoutResourcesModule,\n SkyThemeModule,\n SkyHrefModule,\n ],\n exports: [SkyFlyoutComponent],\n entryComponents: [SkyFlyoutComponent],\n}"
466
627
  }
467
628
  }
468
629
  ],
469
630
  "children": [
470
631
  {
471
- "id": 140,
632
+ "id": 157,
472
633
  "name": "constructor",
473
634
  "kind": 512,
474
635
  "kindString": "Constructor",
475
636
  "flags": {},
476
637
  "signatures": [
477
638
  {
478
- "id": 141,
639
+ "id": 158,
479
640
  "name": "new SkyFlyoutModule",
480
641
  "kind": 16384,
481
642
  "kindString": "Constructor signature",
482
643
  "flags": {},
483
644
  "type": {
484
645
  "type": "reference",
485
- "id": 139,
646
+ "id": 156,
486
647
  "name": "SkyFlyoutModule"
487
648
  }
488
649
  }
@@ -494,20 +655,20 @@
494
655
  "title": "Constructors",
495
656
  "kind": 512,
496
657
  "children": [
497
- 140
658
+ 157
498
659
  ]
499
660
  }
500
661
  ],
501
662
  "sources": [
502
663
  {
503
664
  "fileName": "projects/flyout/src/modules/flyout/flyout.module.ts",
504
- "line": 38,
665
+ "line": 41,
505
666
  "character": 13
506
667
  }
507
668
  ]
508
669
  },
509
670
  {
510
- "id": 142,
671
+ "id": 159,
511
672
  "name": "SkyFlyoutService",
512
673
  "kind": 128,
513
674
  "kindString": "Class",
@@ -529,7 +690,7 @@
529
690
  ],
530
691
  "children": [
531
692
  {
532
- "id": 143,
693
+ "id": 160,
533
694
  "name": "constructor",
534
695
  "kind": 512,
535
696
  "kindString": "Constructor",
@@ -537,20 +698,20 @@
537
698
  "sources": [
538
699
  {
539
700
  "fileName": "projects/flyout/src/modules/flyout/flyout.service.ts",
540
- "line": 39,
701
+ "line": 47,
541
702
  "character": 2
542
703
  }
543
704
  ],
544
705
  "signatures": [
545
706
  {
546
- "id": 144,
707
+ "id": 161,
547
708
  "name": "new SkyFlyoutService",
548
709
  "kind": 16384,
549
710
  "kindString": "Constructor signature",
550
711
  "flags": {},
551
712
  "parameters": [
552
713
  {
553
- "id": 145,
714
+ "id": 162,
554
715
  "name": "coreAdapter",
555
716
  "kind": 32768,
556
717
  "kindString": "Parameter",
@@ -561,7 +722,7 @@
561
722
  }
562
723
  },
563
724
  {
564
- "id": 146,
725
+ "id": 163,
565
726
  "name": "windowRef",
566
727
  "kind": 32768,
567
728
  "kindString": "Parameter",
@@ -572,7 +733,7 @@
572
733
  }
573
734
  },
574
735
  {
575
- "id": 147,
736
+ "id": 164,
576
737
  "name": "dynamicComponentService",
577
738
  "kind": 32768,
578
739
  "kindString": "Parameter",
@@ -583,7 +744,7 @@
583
744
  }
584
745
  },
585
746
  {
586
- "id": 148,
747
+ "id": 165,
587
748
  "name": "router",
588
749
  "kind": 32768,
589
750
  "kindString": "Parameter",
@@ -592,18 +753,40 @@
592
753
  "type": "reference",
593
754
  "name": "Router"
594
755
  }
756
+ },
757
+ {
758
+ "id": 166,
759
+ "name": "_ngZone",
760
+ "kind": 32768,
761
+ "kindString": "Parameter",
762
+ "flags": {},
763
+ "type": {
764
+ "type": "reference",
765
+ "name": "NgZone"
766
+ }
767
+ },
768
+ {
769
+ "id": 167,
770
+ "name": "applicationRef",
771
+ "kind": 32768,
772
+ "kindString": "Parameter",
773
+ "flags": {},
774
+ "type": {
775
+ "type": "reference",
776
+ "name": "ApplicationRef"
777
+ }
595
778
  }
596
779
  ],
597
780
  "type": {
598
781
  "type": "reference",
599
- "id": 142,
782
+ "id": 159,
600
783
  "name": "SkyFlyoutService"
601
784
  }
602
785
  }
603
786
  ]
604
787
  },
605
788
  {
606
- "id": 155,
789
+ "id": 174,
607
790
  "name": "close",
608
791
  "kind": 2048,
609
792
  "kindString": "Method",
@@ -613,13 +796,13 @@
613
796
  "sources": [
614
797
  {
615
798
  "fileName": "projects/flyout/src/modules/flyout/flyout.service.ts",
616
- "line": 56,
799
+ "line": 67,
617
800
  "character": 9
618
801
  }
619
802
  ],
620
803
  "signatures": [
621
804
  {
622
- "id": 156,
805
+ "id": 175,
623
806
  "name": "close",
624
807
  "kind": 4096,
625
808
  "kindString": "Call signature",
@@ -627,6 +810,25 @@
627
810
  "comment": {
628
811
  "shortText": "Closes the flyout. This method also removes the flyout's HTML elements from the DOM."
629
812
  },
813
+ "parameters": [
814
+ {
815
+ "id": 176,
816
+ "name": "args",
817
+ "kind": 32768,
818
+ "kindString": "Parameter",
819
+ "flags": {
820
+ "isOptional": true
821
+ },
822
+ "comment": {
823
+ "shortText": "Arguments used when closing the flyout.\n"
824
+ },
825
+ "type": {
826
+ "type": "reference",
827
+ "id": 202,
828
+ "name": "SkyFlyoutCloseArgs"
829
+ }
830
+ }
831
+ ],
630
832
  "type": {
631
833
  "type": "intrinsic",
632
834
  "name": "void"
@@ -635,7 +837,7 @@
635
837
  ]
636
838
  },
637
839
  {
638
- "id": 153,
840
+ "id": 172,
639
841
  "name": "ngOnDestroy",
640
842
  "kind": 2048,
641
843
  "kindString": "Method",
@@ -645,13 +847,13 @@
645
847
  "sources": [
646
848
  {
647
849
  "fileName": "projects/flyout/src/modules/flyout/flyout.service.ts",
648
- "line": 46,
850
+ "line": 56,
649
851
  "character": 9
650
852
  }
651
853
  ],
652
854
  "signatures": [
653
855
  {
654
- "id": 154,
856
+ "id": 173,
655
857
  "name": "ngOnDestroy",
656
858
  "kind": 4096,
657
859
  "kindString": "Call signature",
@@ -672,7 +874,7 @@
672
874
  }
673
875
  },
674
876
  {
675
- "id": 157,
877
+ "id": 177,
676
878
  "name": "open",
677
879
  "kind": 2048,
678
880
  "kindString": "Method",
@@ -682,13 +884,13 @@
682
884
  "sources": [
683
885
  {
684
886
  "fileName": "projects/flyout/src/modules/flyout/flyout.service.ts",
685
- "line": 70,
887
+ "line": 84,
686
888
  "character": 9
687
889
  }
688
890
  ],
689
891
  "signatures": [
690
892
  {
691
- "id": 158,
893
+ "id": 178,
692
894
  "name": "open",
693
895
  "kind": 4096,
694
896
  "kindString": "Call signature",
@@ -698,7 +900,7 @@
698
900
  },
699
901
  "typeParameter": [
700
902
  {
701
- "id": 159,
903
+ "id": 179,
702
904
  "name": "T",
703
905
  "kind": 131072,
704
906
  "kindString": "Type parameter",
@@ -707,7 +909,7 @@
707
909
  ],
708
910
  "parameters": [
709
911
  {
710
- "id": 160,
912
+ "id": 180,
711
913
  "name": "component",
712
914
  "kind": 32768,
713
915
  "kindString": "Parameter",
@@ -720,7 +922,7 @@
720
922
  "typeArguments": [
721
923
  {
722
924
  "type": "reference",
723
- "id": 159,
925
+ "id": 179,
724
926
  "name": "T"
725
927
  }
726
928
  ],
@@ -728,7 +930,7 @@
728
930
  }
729
931
  },
730
932
  {
731
- "id": 161,
933
+ "id": 181,
732
934
  "name": "config",
733
935
  "kind": 32768,
734
936
  "kindString": "Parameter",
@@ -740,18 +942,18 @@
740
942
  },
741
943
  "type": {
742
944
  "type": "reference",
743
- "id": 177,
945
+ "id": 204,
744
946
  "name": "SkyFlyoutConfig"
745
947
  }
746
948
  }
747
949
  ],
748
950
  "type": {
749
951
  "type": "reference",
750
- "id": 110,
952
+ "id": 123,
751
953
  "typeArguments": [
752
954
  {
753
955
  "type": "reference",
754
- "id": 159,
956
+ "id": 179,
755
957
  "name": "T"
756
958
  }
757
959
  ],
@@ -766,23 +968,23 @@
766
968
  "title": "Constructors",
767
969
  "kind": 512,
768
970
  "children": [
769
- 143
971
+ 160
770
972
  ]
771
973
  },
772
974
  {
773
975
  "title": "Methods",
774
976
  "kind": 2048,
775
977
  "children": [
776
- 155,
777
- 153,
778
- 157
978
+ 174,
979
+ 172,
980
+ 177
779
981
  ]
780
982
  }
781
983
  ],
782
984
  "sources": [
783
985
  {
784
986
  "fileName": "projects/flyout/src/modules/flyout/flyout.service.ts",
785
- "line": 33,
987
+ "line": 41,
786
988
  "character": 13
787
989
  }
788
990
  ],
@@ -794,14 +996,14 @@
794
996
  ]
795
997
  },
796
998
  {
797
- "id": 172,
999
+ "id": 192,
798
1000
  "name": "SkyFlyoutAction",
799
1001
  "kind": 256,
800
1002
  "kindString": "Interface",
801
1003
  "flags": {},
802
1004
  "children": [
803
1005
  {
804
- "id": 176,
1006
+ "id": 196,
805
1007
  "name": "closeAfterInvoking",
806
1008
  "kind": 1024,
807
1009
  "kindString": "Property",
@@ -824,7 +1026,7 @@
824
1026
  }
825
1027
  },
826
1028
  {
827
- "id": 173,
1029
+ "id": 193,
828
1030
  "name": "label",
829
1031
  "kind": 1024,
830
1032
  "kindString": "Property",
@@ -847,7 +1049,7 @@
847
1049
  }
848
1050
  },
849
1051
  {
850
- "id": 174,
1052
+ "id": 194,
851
1053
  "name": "callback",
852
1054
  "kind": 2048,
853
1055
  "kindString": "Method",
@@ -863,7 +1065,7 @@
863
1065
  ],
864
1066
  "signatures": [
865
1067
  {
866
- "id": 175,
1068
+ "id": 195,
867
1069
  "name": "callback",
868
1070
  "kind": 4096,
869
1071
  "kindString": "Call signature",
@@ -884,15 +1086,15 @@
884
1086
  "title": "Properties",
885
1087
  "kind": 1024,
886
1088
  "children": [
887
- 176,
888
- 173
1089
+ 196,
1090
+ 193
889
1091
  ]
890
1092
  },
891
1093
  {
892
1094
  "title": "Methods",
893
1095
  "kind": 2048,
894
1096
  "children": [
895
- 174
1097
+ 194
896
1098
  ]
897
1099
  }
898
1100
  ],
@@ -905,7 +1107,58 @@
905
1107
  ]
906
1108
  },
907
1109
  {
908
- "id": 177,
1110
+ "id": 202,
1111
+ "name": "SkyFlyoutCloseArgs",
1112
+ "kind": 256,
1113
+ "kindString": "Interface",
1114
+ "flags": {},
1115
+ "comment": {
1116
+ "shortText": "Arguments used when closing a flyout programatically."
1117
+ },
1118
+ "children": [
1119
+ {
1120
+ "id": 203,
1121
+ "name": "ignoreBeforeClose",
1122
+ "kind": 1024,
1123
+ "kindString": "Property",
1124
+ "flags": {
1125
+ "isOptional": true
1126
+ },
1127
+ "comment": {
1128
+ "shortText": "Indicates if the `SkyFlyoutBeforeCloseHandler` should be ignored when closing a flyout."
1129
+ },
1130
+ "sources": [
1131
+ {
1132
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-close-args.ts",
1133
+ "line": 8,
1134
+ "character": 2
1135
+ }
1136
+ ],
1137
+ "type": {
1138
+ "type": "intrinsic",
1139
+ "name": "boolean"
1140
+ }
1141
+ }
1142
+ ],
1143
+ "groups": [
1144
+ {
1145
+ "title": "Properties",
1146
+ "kind": 1024,
1147
+ "children": [
1148
+ 203
1149
+ ]
1150
+ }
1151
+ ],
1152
+ "sources": [
1153
+ {
1154
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-close-args.ts",
1155
+ "line": 4,
1156
+ "character": 17
1157
+ }
1158
+ ]
1159
+ },
1160
+ {
1161
+ "id": 204,
909
1162
  "name": "SkyFlyoutConfig",
910
1163
  "kind": 256,
911
1164
  "kindString": "Interface",
@@ -915,7 +1168,7 @@
915
1168
  },
916
1169
  "children": [
917
1170
  {
918
- "id": 178,
1171
+ "id": 205,
919
1172
  "name": "ariaDescribedBy",
920
1173
  "kind": 1024,
921
1174
  "kindString": "Property",
@@ -938,15 +1191,15 @@
938
1191
  }
939
1192
  },
940
1193
  {
941
- "id": 179,
942
- "name": "ariaLabelledBy",
1194
+ "id": 206,
1195
+ "name": "ariaLabel",
943
1196
  "kind": 1024,
944
1197
  "kindString": "Property",
945
1198
  "flags": {
946
1199
  "isOptional": true
947
1200
  },
948
1201
  "comment": {
949
- "shortText": "Specifies the HTML element ID (without the leading `#`) of the element that labels\nthe flyout. This sets the flyout's `aria-labelledby` attribute\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)."
1202
+ "shortText": "Specifies an ARIA label for the flyout. This sets the flyouts's `aria-label` attribute\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\nIf the flyout includes a visible label, use `ariaLabelledBy` instead."
950
1203
  },
951
1204
  "sources": [
952
1205
  {
@@ -961,7 +1214,30 @@
961
1214
  }
962
1215
  },
963
1216
  {
964
- "id": 180,
1217
+ "id": 207,
1218
+ "name": "ariaLabelledBy",
1219
+ "kind": 1024,
1220
+ "kindString": "Property",
1221
+ "flags": {
1222
+ "isOptional": true
1223
+ },
1224
+ "comment": {
1225
+ "shortText": "Specifies the HTML element ID (without the leading `#`) of the element that labels\nthe flyout. This sets the flyout's `aria-labelledby` attribute\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\nIf the flyout does not include a visible label, use `ariaLabel` instead."
1226
+ },
1227
+ "sources": [
1228
+ {
1229
+ "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1230
+ "line": 31,
1231
+ "character": 2
1232
+ }
1233
+ ],
1234
+ "type": {
1235
+ "type": "intrinsic",
1236
+ "name": "string"
1237
+ }
1238
+ },
1239
+ {
1240
+ "id": 208,
965
1241
  "name": "ariaRole",
966
1242
  "kind": 1024,
967
1243
  "kindString": "Property",
@@ -969,12 +1245,22 @@
969
1245
  "isOptional": true
970
1246
  },
971
1247
  "comment": {
972
- "shortText": "Specifies an ARIA role for the flyout\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)\nby indicating how the flyout functions and what it controls. For information about how\nan ARIA role indicates what an item represents on a web page,\nsee the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/roles)."
1248
+ "shortText": "Specifies an ARIA role for the flyout\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)\nby indicating how the flyout functions and what it controls. For information about how\nan ARIA role indicates what an item represents on a web page,\nsee the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/roles).",
1249
+ "tags": [
1250
+ {
1251
+ "tag": "default",
1252
+ "text": "dialog"
1253
+ },
1254
+ {
1255
+ "tag": "deprecated",
1256
+ "text": "Since version `5.1.0`. Consumers should use the default `dialog` role to ensure a\nproper accessibility implementation.\n"
1257
+ }
1258
+ ]
973
1259
  },
974
1260
  "sources": [
975
1261
  {
976
1262
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
977
- "line": 32,
1263
+ "line": 43,
978
1264
  "character": 2
979
1265
  }
980
1266
  ],
@@ -984,7 +1270,7 @@
984
1270
  }
985
1271
  },
986
1272
  {
987
- "id": 181,
1273
+ "id": 209,
988
1274
  "name": "defaultWidth",
989
1275
  "kind": 1024,
990
1276
  "kindString": "Property",
@@ -997,7 +1283,7 @@
997
1283
  "sources": [
998
1284
  {
999
1285
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1000
- "line": 38,
1286
+ "line": 49,
1001
1287
  "character": 2
1002
1288
  }
1003
1289
  ],
@@ -1007,7 +1293,7 @@
1007
1293
  }
1008
1294
  },
1009
1295
  {
1010
- "id": 189,
1296
+ "id": 217,
1011
1297
  "name": "iteratorNextButtonDisabled",
1012
1298
  "kind": 1024,
1013
1299
  "kindString": "Property",
@@ -1026,7 +1312,7 @@
1026
1312
  "sources": [
1027
1313
  {
1028
1314
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1029
- "line": 87,
1315
+ "line": 98,
1030
1316
  "character": 2
1031
1317
  }
1032
1318
  ],
@@ -1036,7 +1322,7 @@
1036
1322
  }
1037
1323
  },
1038
1324
  {
1039
- "id": 188,
1325
+ "id": 216,
1040
1326
  "name": "iteratorPreviousButtonDisabled",
1041
1327
  "kind": 1024,
1042
1328
  "kindString": "Property",
@@ -1055,7 +1341,7 @@
1055
1341
  "sources": [
1056
1342
  {
1057
1343
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1058
- "line": 80,
1344
+ "line": 91,
1059
1345
  "character": 2
1060
1346
  }
1061
1347
  ],
@@ -1065,7 +1351,7 @@
1065
1351
  }
1066
1352
  },
1067
1353
  {
1068
- "id": 183,
1354
+ "id": 211,
1069
1355
  "name": "maxWidth",
1070
1356
  "kind": 1024,
1071
1357
  "kindString": "Property",
@@ -1084,7 +1370,7 @@
1084
1370
  "sources": [
1085
1371
  {
1086
1372
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1087
- "line": 50,
1373
+ "line": 61,
1088
1374
  "character": 2
1089
1375
  }
1090
1376
  ],
@@ -1094,7 +1380,7 @@
1094
1380
  }
1095
1381
  },
1096
1382
  {
1097
- "id": 182,
1383
+ "id": 210,
1098
1384
  "name": "minWidth",
1099
1385
  "kind": 1024,
1100
1386
  "kindString": "Property",
@@ -1113,7 +1399,7 @@
1113
1399
  "sources": [
1114
1400
  {
1115
1401
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1116
- "line": 44,
1402
+ "line": 55,
1117
1403
  "character": 2
1118
1404
  }
1119
1405
  ],
@@ -1123,7 +1409,7 @@
1123
1409
  }
1124
1410
  },
1125
1411
  {
1126
- "id": 184,
1412
+ "id": 212,
1127
1413
  "name": "permalink",
1128
1414
  "kind": 1024,
1129
1415
  "kindString": "Property",
@@ -1136,18 +1422,18 @@
1136
1422
  "sources": [
1137
1423
  {
1138
1424
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1139
- "line": 56,
1425
+ "line": 67,
1140
1426
  "character": 2
1141
1427
  }
1142
1428
  ],
1143
1429
  "type": {
1144
1430
  "type": "reference",
1145
- "id": 200,
1431
+ "id": 231,
1146
1432
  "name": "SkyFlyoutPermalink"
1147
1433
  }
1148
1434
  },
1149
1435
  {
1150
- "id": 185,
1436
+ "id": 213,
1151
1437
  "name": "primaryAction",
1152
1438
  "kind": 1024,
1153
1439
  "kindString": "Property",
@@ -1160,18 +1446,18 @@
1160
1446
  "sources": [
1161
1447
  {
1162
1448
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1163
- "line": 61,
1449
+ "line": 72,
1164
1450
  "character": 2
1165
1451
  }
1166
1452
  ],
1167
1453
  "type": {
1168
1454
  "type": "reference",
1169
- "id": 172,
1455
+ "id": 192,
1170
1456
  "name": "SkyFlyoutAction"
1171
1457
  }
1172
1458
  },
1173
1459
  {
1174
- "id": 186,
1460
+ "id": 214,
1175
1461
  "name": "providers",
1176
1462
  "kind": 1024,
1177
1463
  "kindString": "Property",
@@ -1184,7 +1470,7 @@
1184
1470
  "sources": [
1185
1471
  {
1186
1472
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1187
- "line": 66,
1473
+ "line": 77,
1188
1474
  "character": 2
1189
1475
  }
1190
1476
  ],
@@ -1197,7 +1483,7 @@
1197
1483
  }
1198
1484
  },
1199
1485
  {
1200
- "id": 190,
1486
+ "id": 218,
1201
1487
  "name": "settingsKey",
1202
1488
  "kind": 1024,
1203
1489
  "kindString": "Property",
@@ -1210,7 +1496,7 @@
1210
1496
  "sources": [
1211
1497
  {
1212
1498
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1213
- "line": 95,
1499
+ "line": 106,
1214
1500
  "character": 2
1215
1501
  }
1216
1502
  ],
@@ -1220,7 +1506,7 @@
1220
1506
  }
1221
1507
  },
1222
1508
  {
1223
- "id": 187,
1509
+ "id": 215,
1224
1510
  "name": "showIterator",
1225
1511
  "kind": 1024,
1226
1512
  "kindString": "Property",
@@ -1239,7 +1525,7 @@
1239
1525
  "sources": [
1240
1526
  {
1241
1527
  "fileName": "projects/flyout/src/modules/flyout/types/flyout-config.ts",
1242
- "line": 73,
1528
+ "line": 84,
1243
1529
  "character": 2
1244
1530
  }
1245
1531
  ],
@@ -1254,19 +1540,20 @@
1254
1540
  "title": "Properties",
1255
1541
  "kind": 1024,
1256
1542
  "children": [
1257
- 178,
1258
- 179,
1259
- 180,
1260
- 181,
1261
- 189,
1262
- 188,
1263
- 183,
1264
- 182,
1265
- 184,
1266
- 185,
1267
- 186,
1268
- 190,
1269
- 187
1543
+ 205,
1544
+ 206,
1545
+ 207,
1546
+ 208,
1547
+ 209,
1548
+ 217,
1549
+ 216,
1550
+ 211,
1551
+ 210,
1552
+ 212,
1553
+ 213,
1554
+ 214,
1555
+ 218,
1556
+ 215
1270
1557
  ]
1271
1558
  }
1272
1559
  ],
@@ -1279,14 +1566,14 @@
1279
1566
  ]
1280
1567
  },
1281
1568
  {
1282
- "id": 200,
1569
+ "id": 231,
1283
1570
  "name": "SkyFlyoutPermalink",
1284
1571
  "kind": 256,
1285
1572
  "kindString": "Interface",
1286
1573
  "flags": {},
1287
1574
  "children": [
1288
1575
  {
1289
- "id": 201,
1576
+ "id": 232,
1290
1577
  "name": "label",
1291
1578
  "kind": 1024,
1292
1579
  "kindString": "Property",
@@ -1309,7 +1596,7 @@
1309
1596
  }
1310
1597
  },
1311
1598
  {
1312
- "id": 202,
1599
+ "id": 233,
1313
1600
  "name": "route",
1314
1601
  "kind": 1024,
1315
1602
  "kindString": "Property",
@@ -1329,14 +1616,14 @@
1329
1616
  "type": {
1330
1617
  "type": "reflection",
1331
1618
  "declaration": {
1332
- "id": 203,
1619
+ "id": 234,
1333
1620
  "name": "__type",
1334
1621
  "kind": 65536,
1335
1622
  "kindString": "Type literal",
1336
1623
  "flags": {},
1337
1624
  "children": [
1338
1625
  {
1339
- "id": 204,
1626
+ "id": 235,
1340
1627
  "name": "commands",
1341
1628
  "kind": 1024,
1342
1629
  "kindString": "Property",
@@ -1357,7 +1644,7 @@
1357
1644
  }
1358
1645
  },
1359
1646
  {
1360
- "id": 205,
1647
+ "id": 236,
1361
1648
  "name": "extras",
1362
1649
  "kind": 1024,
1363
1650
  "kindString": "Property",
@@ -1382,8 +1669,8 @@
1382
1669
  "title": "Properties",
1383
1670
  "kind": 1024,
1384
1671
  "children": [
1385
- 204,
1386
- 205
1672
+ 235,
1673
+ 236
1387
1674
  ]
1388
1675
  }
1389
1676
  ]
@@ -1391,7 +1678,7 @@
1391
1678
  }
1392
1679
  },
1393
1680
  {
1394
- "id": 206,
1681
+ "id": 237,
1395
1682
  "name": "url",
1396
1683
  "kind": 1024,
1397
1684
  "kindString": "Property",
@@ -1419,9 +1706,9 @@
1419
1706
  "title": "Properties",
1420
1707
  "kind": 1024,
1421
1708
  "children": [
1422
- 201,
1423
- 202,
1424
- 206
1709
+ 232,
1710
+ 233,
1711
+ 237
1425
1712
  ]
1426
1713
  }
1427
1714
  ],
@@ -1439,18 +1726,20 @@
1439
1726
  "title": "Classes",
1440
1727
  "kind": 128,
1441
1728
  "children": [
1442
- 110,
1443
- 139,
1444
- 142
1729
+ 197,
1730
+ 123,
1731
+ 156,
1732
+ 159
1445
1733
  ]
1446
1734
  },
1447
1735
  {
1448
1736
  "title": "Interfaces",
1449
1737
  "kind": 256,
1450
1738
  "children": [
1451
- 172,
1452
- 177,
1453
- 200
1739
+ 192,
1740
+ 202,
1741
+ 204,
1742
+ 231
1454
1743
  ]
1455
1744
  }
1456
1745
  ],