@skyux/layout 7.20.0 → 7.21.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 (2) hide show
  1. package/documentation.json +405 -4
  2. package/package.json +9 -9
package/documentation.json CHANGED
@@ -65,7 +65,9 @@
65
65
  "SkyDescriptionListModeType": "type-alias-skydescriptionlistmodetype",
66
66
  "SkyFluidGridGutterSizeType": "type-alias-skyfluidgridguttersizetype",
67
67
  "SkyPageLayoutType": "type-alias-skypagelayouttype",
68
- "SkyTextExpandRepeaterListStyleType": "type-alias-skytextexpandrepeaterliststyletype"
68
+ "SkyTextExpandRepeaterListStyleType": "type-alias-skytextexpandrepeaterliststyletype",
69
+ "SkyBoxHarness": "class-skyboxharness",
70
+ "SkyBoxHarnessFilters": "interface-skyboxharnessfilters"
69
71
  },
70
72
  "typedoc": {
71
73
  "id": 0,
@@ -8950,7 +8952,7 @@
8950
8952
  },
8951
8953
  "sources": [
8952
8954
  {
8953
- "fileName": "src/lib/modules/action-button/action-button-permalink.ts",
8955
+ "fileName": "libs/components/layout/src/lib/modules/action-button/action-button-permalink.ts",
8954
8956
  "line": 25,
8955
8957
  "character": 4
8956
8958
  }
@@ -8982,7 +8984,7 @@
8982
8984
  },
8983
8985
  "sources": [
8984
8986
  {
8985
- "fileName": "src/lib/modules/action-button/action-button-permalink.ts",
8987
+ "fileName": "libs/components/layout/src/lib/modules/action-button/action-button-permalink.ts",
8986
8988
  "line": 26,
8987
8989
  "character": 4
8988
8990
  }
@@ -9308,6 +9310,400 @@
9308
9310
  }
9309
9311
  ]
9310
9312
  }
9313
+ },
9314
+ {
9315
+ "id": 639,
9316
+ "name": "SkyBoxHarness",
9317
+ "kind": 128,
9318
+ "kindString": "Class",
9319
+ "flags": {},
9320
+ "children": [
9321
+ {
9322
+ "id": 653,
9323
+ "name": "getAriaLabel",
9324
+ "kind": 2048,
9325
+ "kindString": "Method",
9326
+ "flags": {
9327
+ "isPublic": true
9328
+ },
9329
+ "sources": [
9330
+ {
9331
+ "fileName": "projects/layout/src/testing/box/box-harness.ts",
9332
+ "line": 27,
9333
+ "character": 15
9334
+ }
9335
+ ],
9336
+ "signatures": [
9337
+ {
9338
+ "id": 654,
9339
+ "name": "getAriaLabel",
9340
+ "kind": 4096,
9341
+ "kindString": "Call signature",
9342
+ "flags": {},
9343
+ "comment": {
9344
+ "shortText": "Gets the aria-label property of the box"
9345
+ },
9346
+ "type": {
9347
+ "type": "reference",
9348
+ "typeArguments": [
9349
+ {
9350
+ "type": "intrinsic",
9351
+ "name": "string"
9352
+ }
9353
+ ],
9354
+ "qualifiedName": "Promise",
9355
+ "package": "typescript",
9356
+ "name": "Promise"
9357
+ }
9358
+ }
9359
+ ]
9360
+ },
9361
+ {
9362
+ "id": 655,
9363
+ "name": "getAriaLabelledby",
9364
+ "kind": 2048,
9365
+ "kindString": "Method",
9366
+ "flags": {
9367
+ "isPublic": true
9368
+ },
9369
+ "sources": [
9370
+ {
9371
+ "fileName": "projects/layout/src/testing/box/box-harness.ts",
9372
+ "line": 34,
9373
+ "character": 15
9374
+ }
9375
+ ],
9376
+ "signatures": [
9377
+ {
9378
+ "id": 656,
9379
+ "name": "getAriaLabelledby",
9380
+ "kind": 4096,
9381
+ "kindString": "Call signature",
9382
+ "flags": {},
9383
+ "comment": {
9384
+ "shortText": "Gets the aria-labelledby property of the box"
9385
+ },
9386
+ "type": {
9387
+ "type": "reference",
9388
+ "typeArguments": [
9389
+ {
9390
+ "type": "intrinsic",
9391
+ "name": "string"
9392
+ }
9393
+ ],
9394
+ "qualifiedName": "Promise",
9395
+ "package": "typescript",
9396
+ "name": "Promise"
9397
+ }
9398
+ }
9399
+ ]
9400
+ },
9401
+ {
9402
+ "id": 657,
9403
+ "name": "getAriaRole",
9404
+ "kind": 2048,
9405
+ "kindString": "Method",
9406
+ "flags": {
9407
+ "isPublic": true
9408
+ },
9409
+ "sources": [
9410
+ {
9411
+ "fileName": "projects/layout/src/testing/box/box-harness.ts",
9412
+ "line": 41,
9413
+ "character": 15
9414
+ }
9415
+ ],
9416
+ "signatures": [
9417
+ {
9418
+ "id": 658,
9419
+ "name": "getAriaRole",
9420
+ "kind": 4096,
9421
+ "kindString": "Call signature",
9422
+ "flags": {},
9423
+ "comment": {
9424
+ "shortText": "Gets the aria-role property of the box"
9425
+ },
9426
+ "type": {
9427
+ "type": "reference",
9428
+ "typeArguments": [
9429
+ {
9430
+ "type": "intrinsic",
9431
+ "name": "string"
9432
+ }
9433
+ ],
9434
+ "qualifiedName": "Promise",
9435
+ "package": "typescript",
9436
+ "name": "Promise"
9437
+ }
9438
+ }
9439
+ ]
9440
+ },
9441
+ {
9442
+ "id": 662,
9443
+ "name": "host",
9444
+ "kind": 2048,
9445
+ "kindString": "Method",
9446
+ "flags": {},
9447
+ "sources": [
9448
+ {
9449
+ "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
9450
+ "line": 40,
9451
+ "character": 4
9452
+ }
9453
+ ],
9454
+ "signatures": [
9455
+ {
9456
+ "id": 663,
9457
+ "name": "host",
9458
+ "kind": 4096,
9459
+ "kindString": "Call signature",
9460
+ "flags": {},
9461
+ "comment": {
9462
+ "shortText": "Gets a `Promise` for the `TestElement` representing the host element of the component."
9463
+ },
9464
+ "type": {
9465
+ "type": "reference",
9466
+ "typeArguments": [
9467
+ {
9468
+ "type": "reference",
9469
+ "qualifiedName": "TestElement",
9470
+ "package": "@angular/cdk",
9471
+ "name": "TestElement"
9472
+ }
9473
+ ],
9474
+ "qualifiedName": "Promise",
9475
+ "package": "typescript",
9476
+ "name": "Promise"
9477
+ },
9478
+ "inheritedFrom": {
9479
+ "type": "reference",
9480
+ "name": "SkyComponentHarness.host"
9481
+ }
9482
+ }
9483
+ ],
9484
+ "inheritedFrom": {
9485
+ "type": "reference",
9486
+ "name": "SkyComponentHarness.host"
9487
+ }
9488
+ },
9489
+ {
9490
+ "id": 641,
9491
+ "name": "with",
9492
+ "kind": 2048,
9493
+ "kindString": "Method",
9494
+ "flags": {
9495
+ "isPublic": true,
9496
+ "isStatic": true
9497
+ },
9498
+ "sources": [
9499
+ {
9500
+ "fileName": "projects/layout/src/testing/box/box-harness.ts",
9501
+ "line": 18,
9502
+ "character": 16
9503
+ }
9504
+ ],
9505
+ "signatures": [
9506
+ {
9507
+ "id": 642,
9508
+ "name": "with",
9509
+ "kind": 4096,
9510
+ "kindString": "Call signature",
9511
+ "flags": {},
9512
+ "comment": {
9513
+ "shortText": "Gets a `HarnessPredicate` that can be used to search for a\n`SkyBoxHarness` that meets certain criteria"
9514
+ },
9515
+ "parameters": [
9516
+ {
9517
+ "id": 643,
9518
+ "name": "filters",
9519
+ "kind": 32768,
9520
+ "kindString": "Parameter",
9521
+ "flags": {},
9522
+ "type": {
9523
+ "type": "reference",
9524
+ "id": 682,
9525
+ "name": "SkyBoxHarnessFilters"
9526
+ }
9527
+ }
9528
+ ],
9529
+ "type": {
9530
+ "type": "reference",
9531
+ "typeArguments": [
9532
+ {
9533
+ "type": "reference",
9534
+ "id": 639,
9535
+ "name": "SkyBoxHarness"
9536
+ }
9537
+ ],
9538
+ "qualifiedName": "HarnessPredicate",
9539
+ "package": "@angular/cdk",
9540
+ "name": "HarnessPredicate"
9541
+ }
9542
+ }
9543
+ ]
9544
+ }
9545
+ ],
9546
+ "groups": [
9547
+ {
9548
+ "title": "Constructors",
9549
+ "kind": 512,
9550
+ "children": [
9551
+ 649
9552
+ ]
9553
+ },
9554
+ {
9555
+ "title": "Methods",
9556
+ "kind": 2048,
9557
+ "children": [
9558
+ 653,
9559
+ 655,
9560
+ 657,
9561
+ 662,
9562
+ 641
9563
+ ]
9564
+ }
9565
+ ],
9566
+ "sources": [
9567
+ {
9568
+ "fileName": "projects/layout/src/testing/box/box-harness.ts",
9569
+ "line": 6,
9570
+ "character": 13
9571
+ }
9572
+ ],
9573
+ "extendedTypes": [
9574
+ {
9575
+ "type": "reference",
9576
+ "name": "SkyComponentHarness"
9577
+ }
9578
+ ]
9579
+ },
9580
+ {
9581
+ "id": 682,
9582
+ "name": "SkyBoxHarnessFilters",
9583
+ "kind": 256,
9584
+ "kindString": "Interface",
9585
+ "flags": {},
9586
+ "comment": {
9587
+ "shortText": "A set of criteria that can be used to filter a list of `SkyBoxHarness` instances."
9588
+ },
9589
+ "children": [
9590
+ {
9591
+ "id": 685,
9592
+ "name": "ancestor",
9593
+ "kind": 1024,
9594
+ "kindString": "Property",
9595
+ "flags": {
9596
+ "isOptional": true
9597
+ },
9598
+ "comment": {
9599
+ "shortText": "Only find instances that are nested under an element with the given selector."
9600
+ },
9601
+ "sources": [
9602
+ {
9603
+ "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
9604
+ "line": 28,
9605
+ "character": 4
9606
+ }
9607
+ ],
9608
+ "type": {
9609
+ "type": "intrinsic",
9610
+ "name": "string"
9611
+ },
9612
+ "inheritedFrom": {
9613
+ "type": "reference",
9614
+ "name": "SkyHarnessFilters.ancestor"
9615
+ }
9616
+ },
9617
+ {
9618
+ "id": 683,
9619
+ "name": "dataSkyId",
9620
+ "kind": 1024,
9621
+ "kindString": "Property",
9622
+ "flags": {
9623
+ "isOptional": true
9624
+ },
9625
+ "comment": {
9626
+ "shortText": "Only find instances whose `data-sky-id` attribute matches the given value."
9627
+ },
9628
+ "sources": [
9629
+ {
9630
+ "fileName": "libs/components/core/testing/src/shared/harness-filters.ts",
9631
+ "line": 11,
9632
+ "character": 2
9633
+ }
9634
+ ],
9635
+ "type": {
9636
+ "type": "union",
9637
+ "types": [
9638
+ {
9639
+ "type": "intrinsic",
9640
+ "name": "string"
9641
+ },
9642
+ {
9643
+ "type": "reference",
9644
+ "qualifiedName": "RegExp",
9645
+ "package": "typescript",
9646
+ "name": "RegExp"
9647
+ }
9648
+ ]
9649
+ },
9650
+ "inheritedFrom": {
9651
+ "type": "reference",
9652
+ "name": "SkyHarnessFilters.dataSkyId"
9653
+ }
9654
+ },
9655
+ {
9656
+ "id": 684,
9657
+ "name": "selector",
9658
+ "kind": 1024,
9659
+ "kindString": "Property",
9660
+ "flags": {
9661
+ "isOptional": true
9662
+ },
9663
+ "comment": {
9664
+ "shortText": "Only find instances whose host element matches the given selector."
9665
+ },
9666
+ "sources": [
9667
+ {
9668
+ "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
9669
+ "line": 26,
9670
+ "character": 4
9671
+ }
9672
+ ],
9673
+ "type": {
9674
+ "type": "intrinsic",
9675
+ "name": "string"
9676
+ },
9677
+ "inheritedFrom": {
9678
+ "type": "reference",
9679
+ "name": "SkyHarnessFilters.selector"
9680
+ }
9681
+ }
9682
+ ],
9683
+ "groups": [
9684
+ {
9685
+ "title": "Properties",
9686
+ "kind": 1024,
9687
+ "children": [
9688
+ 685,
9689
+ 683,
9690
+ 684
9691
+ ]
9692
+ }
9693
+ ],
9694
+ "sources": [
9695
+ {
9696
+ "fileName": "projects/layout/src/testing/box/box-harness.filters.ts",
9697
+ "line": 7,
9698
+ "character": 17
9699
+ }
9700
+ ],
9701
+ "extendedTypes": [
9702
+ {
9703
+ "type": "reference",
9704
+ "name": "SkyHarnessFilters"
9705
+ }
9706
+ ]
9311
9707
  }
9312
9708
  ],
9313
9709
  "groups": [
@@ -9390,7 +9786,12 @@
9390
9786
  {
9391
9787
  "fileName": "box-demo.component.html",
9392
9788
  "filePath": "/projects/layout/documentation/code-examples/box/basic/box-demo.component.html",
9393
- "rawContents": "<sky-box>\n <sky-box-header>\n <h2 class=\"sky-font-heading-2\">Box header</h2>\n </sky-box-header>\n <sky-box-controls>\n <sky-dropdown buttonType=\"context-menu\" label=\"Box demo context menu\">\n <sky-dropdown-menu>\n <sky-dropdown-item>\n <button type=\"button\">Action 1</button>\n </sky-dropdown-item>\n <sky-dropdown-item>\n <button type=\"button\">Action 2</button>\n </sky-dropdown-item>\n </sky-dropdown-menu>\n </sky-dropdown>\n </sky-box-controls>\n <sky-box-content>\n <p>Box content</p>\n </sky-box-content>\n</sky-box>\n"
9789
+ "rawContents": "<sky-box data-sky-id=\"box-demo\" [ariaLabel]=\"'boxDemo'\">\n <sky-box-header>\n <h2 class=\"sky-font-heading-2\">Box header</h2>\n </sky-box-header>\n <sky-box-controls>\n <sky-dropdown buttonType=\"context-menu\" label=\"Box demo context menu\">\n <sky-dropdown-menu>\n <sky-dropdown-item>\n <button type=\"button\">Action 1</button>\n </sky-dropdown-item>\n <sky-dropdown-item>\n <button type=\"button\">Action 2</button>\n </sky-dropdown-item>\n </sky-dropdown-menu>\n </sky-dropdown>\n </sky-box-controls>\n <sky-box-content>\n <p>Box content</p>\n </sky-box-content>\n</sky-box>\n"
9790
+ },
9791
+ {
9792
+ "fileName": "box-demo.component.spec.ts",
9793
+ "filePath": "/projects/layout/documentation/code-examples/box/basic/box-demo.component.spec.ts",
9794
+ "rawContents": "import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';\nimport { ComponentFixture, TestBed } from '@angular/core/testing';\nimport { SkyBoxHarness } from '@skyux/layout/testing';\n\nimport { BoxDemoComponent } from './box-demo.component';\nimport { BoxDemoModule } from './box-demo.module';\n\ndescribe('Basic box', async () => {\n async function setupTest(): Promise<{\n boxHarness: SkyBoxHarness;\n fixture: ComponentFixture<BoxDemoComponent>;\n }> {\n const fixture = TestBed.createComponent(BoxDemoComponent);\n const loader = TestbedHarnessEnvironment.loader(fixture);\n const boxHarness = await loader.getHarness(\n SkyBoxHarness.with({\n dataSkyId: 'box-demo',\n })\n );\n\n return { boxHarness, fixture };\n }\n\n beforeEach(() => {\n TestBed.configureTestingModule({\n imports: [BoxDemoModule],\n });\n });\n\n it('should display the correct box', async () => {\n const { boxHarness, fixture } = await setupTest();\n\n fixture.detectChanges();\n\n await expectAsync(boxHarness.getAriaLabel()).toBeResolvedTo('boxDemo');\n });\n});\n"
9394
9795
  },
9395
9796
  {
9396
9797
  "fileName": "box-demo.component.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/layout",
3
- "version": "7.20.0",
3
+ "version": "7.21.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -47,14 +47,14 @@
47
47
  "@angular/forms": "^14.2.11",
48
48
  "@angular/platform-browser": "^14.2.11",
49
49
  "@angular/router": "^14.2.11",
50
- "@skyux-sdk/testing": "7.20.0",
51
- "@skyux/core": "7.20.0",
52
- "@skyux/forms": "7.20.0",
53
- "@skyux/i18n": "7.20.0",
54
- "@skyux/indicators": "7.20.0",
55
- "@skyux/modals": "7.20.0",
56
- "@skyux/router": "7.20.0",
57
- "@skyux/theme": "7.20.0"
50
+ "@skyux-sdk/testing": "7.21.0",
51
+ "@skyux/core": "7.21.0",
52
+ "@skyux/forms": "7.21.0",
53
+ "@skyux/i18n": "7.21.0",
54
+ "@skyux/indicators": "7.21.0",
55
+ "@skyux/modals": "7.21.0",
56
+ "@skyux/router": "7.21.0",
57
+ "@skyux/theme": "7.21.0"
58
58
  },
59
59
  "dependencies": {
60
60
  "tslib": "^2.3.1"