@skyux/a11y 8.0.0 → 8.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/documentation.json +73 -188
  2. package/package.json +3 -3
package/documentation.json CHANGED
@@ -20,17 +20,27 @@
20
20
  "kindString": "Class",
21
21
  "flags": {},
22
22
  "comment": {
23
- "summary": [
24
- {
25
- "kind": "text",
26
- "text": "The Angular module that enables \"skip links\" to be added to the page."
27
- }
28
- ]
23
+ "shortText": "The Angular module that enables \"skip links\" to be added to the page."
29
24
  },
25
+ "decorators": [
26
+ {
27
+ "name": "NgModule",
28
+ "type": {
29
+ "type": "reference",
30
+ "qualifiedName": "NgModuleDecorator",
31
+ "package": "@angular/core",
32
+ "name": "NgModule"
33
+ },
34
+ "arguments": {
35
+ "obj": "{\n declarations: [SkySkipLinkHostComponent],\n imports: [CommonModule, SkyI18nModule, SkyA11yResourcesModule],\n}"
36
+ }
37
+ }
38
+ ],
30
39
  "children": [],
31
40
  "groups": [
32
41
  {
33
42
  "title": "Constructors",
43
+ "kind": 512,
34
44
  "children": [
35
45
  6
36
46
  ]
@@ -40,8 +50,7 @@
40
50
  {
41
51
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.module.ts",
42
52
  "line": 16,
43
- "character": 13,
44
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.module.ts#L16"
53
+ "character": 13
45
54
  }
46
55
  ]
47
56
  },
@@ -52,19 +61,28 @@
52
61
  "kindString": "Class",
53
62
  "flags": {},
54
63
  "comment": {
55
- "summary": [
56
- {
57
- "kind": "text",
58
- "text": "An Angular service that adds \"skip links\" to the page. Skip links will only be displayed\nwhen the page initially loads and the user presses the Tab key, in which case the first link will\nbe displayed and focused. Clicking the button will skip to the specified element. Pressing\nthe Tab key again will move to the next skip link if more than one skip link is specified;\notherwise, focus will move to the first focusable element on the page."
59
- }
60
- ],
61
- "blockTags": [
64
+ "shortText": "An Angular service that adds \"skip links\" to the page. Skip links will only be displayed\nwhen the page initially loads and the user presses the Tab key, in which case the first link will\nbe displayed and focused. Clicking the button will skip to the specified element. Pressing\nthe Tab key again will move to the next skip link if more than one skip link is specified;\notherwise, focus will move to the first focusable element on the page.",
65
+ "tags": [
62
66
  {
63
- "tag": "@dynamic",
64
- "content": []
67
+ "tag": "dynamic",
68
+ "text": "\n"
65
69
  }
66
70
  ]
67
71
  },
72
+ "decorators": [
73
+ {
74
+ "name": "Injectable",
75
+ "type": {
76
+ "type": "reference",
77
+ "qualifiedName": "InjectableDecorator",
78
+ "package": "@angular/core",
79
+ "name": "Injectable"
80
+ },
81
+ "arguments": {
82
+ "options": "{\n // Must be 'any' so that the skip link component is created in the context of its module's injector.\n // If set to 'root', the component's dependency injections would only be derived from the root\n // injector and may loose context if the skip link was created from within a lazy-loaded module.\n providedIn: 'any',\n}"
83
+ }
84
+ }
85
+ ],
68
86
  "children": [
69
87
  {
70
88
  "id": 10,
@@ -76,8 +94,7 @@
76
94
  {
77
95
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.service.ts",
78
96
  "line": 30,
79
- "character": 2,
80
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.service.ts#L30"
97
+ "character": 2
81
98
  }
82
99
  ],
83
100
  "signatures": [
@@ -120,8 +137,7 @@
120
137
  {
121
138
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.service.ts",
122
139
  "line": 47,
123
- "character": 9,
124
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.service.ts#L47"
140
+ "character": 9
125
141
  }
126
142
  ],
127
143
  "signatures": [
@@ -150,8 +166,7 @@
150
166
  {
151
167
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.service.ts",
152
168
  "line": 34,
153
- "character": 9,
154
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.service.ts#L34"
169
+ "character": 9
155
170
  }
156
171
  ],
157
172
  "signatures": [
@@ -186,12 +201,14 @@
186
201
  "groups": [
187
202
  {
188
203
  "title": "Constructors",
204
+ "kind": 512,
189
205
  "children": [
190
206
  10
191
207
  ]
192
208
  },
193
209
  {
194
210
  "title": "Methods",
211
+ "kind": 2048,
195
212
  "children": [
196
213
  17,
197
214
  14
@@ -202,8 +219,7 @@
202
219
  {
203
220
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.service.ts",
204
221
  "line": 25,
205
- "character": 13,
206
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.service.ts#L25"
222
+ "character": 13
207
223
  }
208
224
  ]
209
225
  },
@@ -214,12 +230,7 @@
214
230
  "kindString": "Interface",
215
231
  "flags": {},
216
232
  "comment": {
217
- "summary": [
218
- {
219
- "kind": "text",
220
- "text": "A \"skip link\" that allows a user to skip parts of the page and go directly to the main content."
221
- }
222
- ]
233
+ "shortText": "A \"skip link\" that allows a user to skip parts of the page and go directly to the main content."
223
234
  },
224
235
  "children": [
225
236
  {
@@ -229,35 +240,13 @@
229
240
  "kindString": "Property",
230
241
  "flags": {},
231
242
  "comment": {
232
- "summary": [
233
- {
234
- "kind": "text",
235
- "text": "The element to scroll to and focus when the skip link is clicked. This element must\nallow focus, either by specifying an HTML element that allows focus by default (such\nas a "
236
- },
237
- {
238
- "kind": "code",
239
- "text": "`button`"
240
- },
241
- {
242
- "kind": "text",
243
- "text": " or "
244
- },
245
- {
246
- "kind": "code",
247
- "text": "`a`"
248
- },
249
- {
250
- "kind": "text",
251
- "text": " element) or by setting `tabindex=\"-1\" on the specified element."
252
- }
253
- ]
243
+ "shortText": "The element to scroll to and focus when the skip link is clicked. This element must\nallow focus, either by specifying an HTML element that allows focus by default (such\nas a `button` or `a` element) or by setting `tabindex=\"-1\" on the specified element."
254
244
  },
255
245
  "sources": [
256
246
  {
257
247
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.ts",
258
248
  "line": 17,
259
- "character": 2,
260
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.ts#L17"
249
+ "character": 2
261
250
  }
262
251
  ],
263
252
  "type": {
@@ -268,9 +257,9 @@
268
257
  "name": "any"
269
258
  }
270
259
  ],
271
- "name": "ElementRef",
272
260
  "qualifiedName": "ElementRef",
273
- "package": "@angular/core"
261
+ "package": "@angular/core",
262
+ "name": "ElementRef"
274
263
  }
275
264
  },
276
265
  {
@@ -280,19 +269,13 @@
280
269
  "kindString": "Property",
281
270
  "flags": {},
282
271
  "comment": {
283
- "summary": [
284
- {
285
- "kind": "text",
286
- "text": "The title of the skip link."
287
- }
288
- ]
272
+ "shortText": "The title of the skip link."
289
273
  },
290
274
  "sources": [
291
275
  {
292
276
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.ts",
293
277
  "line": 10,
294
- "character": 2,
295
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.ts#L10"
278
+ "character": 2
296
279
  }
297
280
  ],
298
281
  "type": {
@@ -304,6 +287,7 @@
304
287
  "groups": [
305
288
  {
306
289
  "title": "Properties",
290
+ "kind": 1024,
307
291
  "children": [
308
292
  23,
309
293
  22
@@ -314,8 +298,7 @@
314
298
  {
315
299
  "fileName": "projects/a11y/src/modules/skip-link/skip-link.ts",
316
300
  "line": 6,
317
- "character": 17,
318
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link.ts#L6"
301
+ "character": 17
319
302
  }
320
303
  ]
321
304
  },
@@ -326,12 +309,7 @@
326
309
  "kindString": "Interface",
327
310
  "flags": {},
328
311
  "comment": {
329
- "summary": [
330
- {
331
- "kind": "text",
332
- "text": "Options specified when setting the page's skip links."
333
- }
334
- ]
312
+ "shortText": "Options specified when setting the page's skip links."
335
313
  },
336
314
  "children": [
337
315
  {
@@ -341,19 +319,13 @@
341
319
  "kindString": "Property",
342
320
  "flags": {},
343
321
  "comment": {
344
- "summary": [
345
- {
346
- "kind": "text",
347
- "text": "The skip links to create."
348
- }
349
- ]
322
+ "shortText": "The skip links to create."
350
323
  },
351
324
  "sources": [
352
325
  {
353
326
  "fileName": "projects/a11y/src/modules/skip-link/skip-link-args.ts",
354
327
  "line": 13,
355
- "character": 2,
356
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link-args.ts#L13"
328
+ "character": 2
357
329
  }
358
330
  ],
359
331
  "type": {
@@ -369,6 +341,7 @@
369
341
  "groups": [
370
342
  {
371
343
  "title": "Properties",
344
+ "kind": 1024,
372
345
  "children": [
373
346
  4
374
347
  ]
@@ -378,8 +351,7 @@
378
351
  {
379
352
  "fileName": "projects/a11y/src/modules/skip-link/skip-link-args.ts",
380
353
  "line": 9,
381
- "character": 17,
382
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/src/lib/modules/skip-link/skip-link-args.ts#L9"
354
+ "character": 17
383
355
  }
384
356
  ]
385
357
  },
@@ -390,65 +362,9 @@
390
362
  "kindString": "Class",
391
363
  "flags": {},
392
364
  "comment": {
393
- "summary": [
394
- {
395
- "kind": "text",
396
- "text": "Harness for interacting with a skip link component in tests."
397
- }
398
- ]
365
+ "shortText": "Harness for interacting with a skip link component in tests."
399
366
  },
400
367
  "children": [
401
- {
402
- "id": 31,
403
- "name": "constructor",
404
- "kind": 512,
405
- "kindString": "Constructor",
406
- "flags": {},
407
- "sources": [
408
- {
409
- "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
410
- "line": 38,
411
- "character": 4
412
- }
413
- ],
414
- "signatures": [
415
- {
416
- "id": 32,
417
- "name": "new SkySkipLinksHarness",
418
- "kind": 16384,
419
- "kindString": "Constructor signature",
420
- "flags": {},
421
- "parameters": [
422
- {
423
- "id": 33,
424
- "name": "locatorFactory",
425
- "kind": 32768,
426
- "kindString": "Parameter",
427
- "flags": {},
428
- "type": {
429
- "type": "reference",
430
- "name": "LocatorFactory",
431
- "qualifiedName": "LocatorFactory",
432
- "package": "@angular/cdk"
433
- }
434
- }
435
- ],
436
- "type": {
437
- "type": "reference",
438
- "id": 24,
439
- "name": "SkySkipLinksHarness"
440
- },
441
- "inheritedFrom": {
442
- "type": "reference",
443
- "name": "SkyComponentHarness.constructor"
444
- }
445
- }
446
- ],
447
- "inheritedFrom": {
448
- "type": "reference",
449
- "name": "SkyComponentHarness.constructor"
450
- }
451
- },
452
368
  {
453
369
  "id": 38,
454
370
  "name": "clickSkipLink",
@@ -461,8 +377,7 @@
461
377
  {
462
378
  "fileName": "projects/a11y/src/testing/skip-link/skip-links-harness.ts",
463
379
  "line": 26,
464
- "character": 15,
465
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/testing/src/skip-link/skip-links-harness.ts#L26"
380
+ "character": 15
466
381
  }
467
382
  ],
468
383
  "signatures": [
@@ -473,12 +388,7 @@
473
388
  "kindString": "Call signature",
474
389
  "flags": {},
475
390
  "comment": {
476
- "summary": [
477
- {
478
- "kind": "text",
479
- "text": "Clicks the skip link at the given index."
480
- }
481
- ]
391
+ "shortText": "Clicks the skip link at the given index."
482
392
  },
483
393
  "parameters": [
484
394
  {
@@ -501,9 +411,9 @@
501
411
  "name": "void"
502
412
  }
503
413
  ],
504
- "name": "Promise",
505
414
  "qualifiedName": "Promise",
506
- "package": "typescript"
415
+ "package": "typescript",
416
+ "name": "Promise"
507
417
  }
508
418
  }
509
419
  ]
@@ -520,8 +430,7 @@
520
430
  {
521
431
  "fileName": "projects/a11y/src/testing/skip-link/skip-links-harness.ts",
522
432
  "line": 17,
523
- "character": 15,
524
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/testing/src/skip-link/skip-links-harness.ts#L17"
433
+ "character": 15
525
434
  }
526
435
  ],
527
436
  "signatures": [
@@ -532,12 +441,7 @@
532
441
  "kindString": "Call signature",
533
442
  "flags": {},
534
443
  "comment": {
535
- "summary": [
536
- {
537
- "kind": "text",
538
- "text": "Gets the text of the skip link at the given index."
539
- }
540
- ]
444
+ "shortText": "Gets the text of the skip link at the given index."
541
445
  },
542
446
  "parameters": [
543
447
  {
@@ -560,9 +464,9 @@
560
464
  "name": "string"
561
465
  }
562
466
  ],
563
- "name": "Promise",
564
467
  "qualifiedName": "Promise",
565
- "package": "typescript"
468
+ "package": "typescript",
469
+ "name": "Promise"
566
470
  }
567
471
  }
568
472
  ]
@@ -588,42 +492,21 @@
588
492
  "kindString": "Call signature",
589
493
  "flags": {},
590
494
  "comment": {
591
- "summary": [
592
- {
593
- "kind": "text",
594
- "text": "Gets a "
595
- },
596
- {
597
- "kind": "code",
598
- "text": "`Promise`"
599
- },
600
- {
601
- "kind": "text",
602
- "text": " for the "
603
- },
604
- {
605
- "kind": "code",
606
- "text": "`TestElement`"
607
- },
608
- {
609
- "kind": "text",
610
- "text": " representing the host element of the component."
611
- }
612
- ]
495
+ "shortText": "Gets a `Promise` for the `TestElement` representing the host element of the component."
613
496
  },
614
497
  "type": {
615
498
  "type": "reference",
616
499
  "typeArguments": [
617
500
  {
618
501
  "type": "reference",
619
- "name": "TestElement",
620
502
  "qualifiedName": "TestElement",
621
- "package": "@angular/cdk"
503
+ "package": "@angular/cdk",
504
+ "name": "TestElement"
622
505
  }
623
506
  ],
624
- "name": "Promise",
625
507
  "qualifiedName": "Promise",
626
- "package": "typescript"
508
+ "package": "typescript",
509
+ "name": "Promise"
627
510
  },
628
511
  "inheritedFrom": {
629
512
  "type": "reference",
@@ -640,12 +523,14 @@
640
523
  "groups": [
641
524
  {
642
525
  "title": "Constructors",
526
+ "kind": 512,
643
527
  "children": [
644
528
  31
645
529
  ]
646
530
  },
647
531
  {
648
532
  "title": "Methods",
533
+ "kind": 2048,
649
534
  "children": [
650
535
  38,
651
536
  35,
@@ -657,8 +542,7 @@
657
542
  {
658
543
  "fileName": "projects/a11y/src/testing/skip-link/skip-links-harness.ts",
659
544
  "line": 6,
660
- "character": 13,
661
- "url": "https://github.com/blackbaud/skyux/blob/84f2f13/libs/components/a11y/testing/src/skip-link/skip-links-harness.ts#L6"
545
+ "character": 13
662
546
  }
663
547
  ],
664
548
  "extendedTypes": [
@@ -672,6 +556,7 @@
672
556
  "groups": [
673
557
  {
674
558
  "title": "Modules",
559
+ "kind": 2,
675
560
  "children": [
676
561
  1,
677
562
  2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/a11y",
3
- "version": "8.0.0",
3
+ "version": "8.0.2",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -42,8 +42,8 @@
42
42
  "peerDependencies": {
43
43
  "@angular/common": "^15.2.9",
44
44
  "@angular/core": "^15.2.9",
45
- "@skyux/core": "8.0.0",
46
- "@skyux/i18n": "8.0.0"
45
+ "@skyux/core": "8.0.2",
46
+ "@skyux/i18n": "8.0.2"
47
47
  },
48
48
  "dependencies": {
49
49
  "tslib": "^2.5.0"