@skyux/modals 7.18.0 → 7.19.0

package/documentation.json

@@ -20,7 +20,9 @@
     "SkyModalConfigurationInterface": "interface-skymodalconfigurationinterface",
     "SkyConfirmButtonStyleType": "type-alias-skyconfirmbuttonstyletype",
     "SkyConfirmHarness": "class-skyconfirmharness",
-    "SkyConfirmButtonHarnessFilters": "interface-skyconfirmbuttonharnessfilters"
+    "SkyModalHarness": "class-skymodalharness",
+    "SkyConfirmButtonHarnessFilters": "interface-skyconfirmbuttonharnessfilters",
+    "SkyModalHarnessFilters": "interface-skymodalharnessfilters"
   },
   "typedoc": {
     "id": 0,
@@ -3553,6 +3555,398 @@
           }
         ]
       },
+      {
+        "id": 377,
+        "name": "SkyModalHarness",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Harness for interacting with a modal component in tests."
+        },
+        "children": [
+          {
+            "id": 392,
+            "name": "getAriaDescribedBy",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 31,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 393,
+                "name": "getAriaDescribedBy",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the aria-describedBy property of the modal"
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 394,
+            "name": "getAriaLabelledBy",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 38,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 395,
+                "name": "getAriaLabelledBy",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the aria-labelledBy property of the modal"
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 396,
+            "name": "getAriaRole",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 45,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 397,
+                "name": "getAriaRole",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the role of the modal."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 398,
+            "name": "getSize",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 52,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 399,
+                "name": "getSize",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the modal size."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 400,
+            "name": "getWrapperClass",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 75,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 401,
+                "name": "getWrapperClass",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the wrapper class of the modal."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 407,
+            "name": "host",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {},
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
+                "line": 40,
+                "character": 4
+              }
+            ],
+            "signatures": [
+              {
+                "id": 408,
+                "name": "host",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets a `Promise` for the `TestElement` representing the host element of the component."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "reference",
+                      "qualifiedName": "TestElement",
+                      "package": "@angular/cdk",
+                      "name": "TestElement"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                },
+                "inheritedFrom": {
+                  "type": "reference",
+                  "name": "SkyComponentHarness.host"
+                }
+              }
+            ],
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyComponentHarness.host"
+            }
+          },
+          {
+            "id": 402,
+            "name": "isFullPage",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 82,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 403,
+                "name": "isFullPage",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Whether the modal is full page."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "boolean"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 379,
+            "name": "with",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true,
+              "isStatic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+                "line": 22,
+                "character": 16
+              }
+            ],
+            "signatures": [
+              {
+                "id": 380,
+                "name": "with",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets a `HarnessPredicate` that can be used to search for a\n`SkyModalHarness` that meets certain criteria"
+                },
+                "parameters": [
+                  {
+                    "id": 381,
+                    "name": "filters",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "id": 427,
+                      "name": "SkyModalHarnessFilters"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "reference",
+                      "id": 377,
+                      "name": "SkyModalHarness"
+                    }
+                  ],
+                  "qualifiedName": "HarnessPredicate",
+                  "package": "@angular/cdk",
+                  "name": "HarnessPredicate"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              387
+            ]
+          },
+          {
+            "title": "Methods",
+            "kind": 2048,
+            "children": [
+              392,
+              394,
+              396,
+              398,
+              400,
+              407,
+              402,
+              379
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/modals/src/testing/modal/modal-harness.ts",
+            "line": 9,
+            "character": 13
+          }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "name": "SkyComponentHarness"
+          }
+        ]
+      },
       {
         "id": 373,
         "name": "SkyConfirmButtonHarnessFilters",
@@ -3686,6 +4080,134 @@
             "name": "Omit"
           }
         ]
+      },
+      {
+        "id": 427,
+        "name": "SkyModalHarnessFilters",
+        "kind": 256,
+        "kindString": "Interface",
+        "flags": {},
+        "comment": {
+          "shortText": "A set of criteria that can be used to filter a list of SkyModalHarness instances."
+        },
+        "children": [
+          {
+            "id": 430,
+            "name": "ancestor",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances that are nested under an element with the given selector."
+            },
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
+                "line": 28,
+                "character": 4
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.ancestor"
+            }
+          },
+          {
+            "id": 428,
+            "name": "dataSkyId",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances whose `data-sky-id` attribute matches the given value."
+            },
+            "sources": [
+              {
+                "fileName": "libs/components/core/testing/src/shared/harness-filters.ts",
+                "line": 11,
+                "character": 2
+              }
+            ],
+            "type": {
+              "type": "union",
+              "types": [
+                {
+                  "type": "intrinsic",
+                  "name": "string"
+                },
+                {
+                  "type": "reference",
+                  "qualifiedName": "RegExp",
+                  "package": "typescript",
+                  "name": "RegExp"
+                }
+              ]
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.dataSkyId"
+            }
+          },
+          {
+            "id": 429,
+            "name": "selector",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances whose host element matches the given selector."
+            },
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/index.d.ts",
+                "line": 26,
+                "character": 4
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.selector"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              430,
+              428,
+              429
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/modals/src/testing/modal/modal-harness-filters.ts",
+            "line": 7,
+            "character": 17
+          }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "name": "SkyHarnessFilters"
+          }
+        ]
       }
     ],
     "groups": [
@@ -3778,7 +4300,7 @@
     {
       "fileName": "modal-demo-modal.component.html",
       "filePath": "/projects/modals/documentation/code-examples/modal/modal-demo-modal.component.html",
-      "rawContents": "<form [formGroup]=\"demoForm\" (submit)=\"saveForm()\">\n  <sky-modal>\n    <sky-modal-header> Modal title </sky-modal-header>\n    <sky-modal-content>\n      <sky-input-box>\n        <label class=\"sky-control-label\" [for]=\"myInput.id\">\n          An input inside a modal\n        </label>\n        <input\n          class=\"sky-form-control\"\n          formControlName=\"value1\"\n          type=\"text\"\n          skyId\n          #myInput=\"skyId\"\n        />\n      </sky-input-box>\n    </sky-modal-content>\n    <sky-modal-footer>\n      <button\n        class=\"sky-btn sky-btn-primary sky-margin-inline-sm\"\n        type=\"submit\"\n      >\n        Save\n      </button>\n      <button class=\"sky-btn sky-btn-link\" type=\"button\" (click)=\"cancelForm()\">\n        Cancel\n      </button>\n    </sky-modal-footer>\n  </sky-modal>\n</form>\n"
+      "rawContents": "<form [formGroup]=\"demoForm\" (submit)=\"saveForm()\">\n  <sky-modal data-sky-id=\"modal-demo\">\n    <sky-modal-header> Modal title </sky-modal-header>\n    <sky-modal-content>\n      <sky-input-box>\n        <label class=\"sky-control-label\" [for]=\"myInput.id\">\n          An input inside a modal\n        </label>\n        <input\n          class=\"sky-form-control\"\n          formControlName=\"value1\"\n          type=\"text\"\n          skyId\n          #myInput=\"skyId\"\n        />\n      </sky-input-box>\n    </sky-modal-content>\n    <sky-modal-footer>\n      <button\n        class=\"sky-btn sky-btn-primary sky-margin-inline-sm\"\n        type=\"submit\"\n      >\n        Save\n      </button>\n      <button class=\"sky-btn sky-btn-link\" type=\"button\" (click)=\"cancelForm()\">\n        Cancel\n      </button>\n    </sky-modal-footer>\n  </sky-modal>\n</form>\n"
     },
     {
       "fileName": "modal-demo-modal.component.ts",
@@ -3790,6 +4312,11 @@
       "filePath": "/projects/modals/documentation/code-examples/modal/modal-demo.component.html",
       "rawContents": "<button\n  class=\"sky-btn sky-btn-default\"\n  type=\"button\"\n  (click)=\"onOpenModalClick()\"\n>\n  Open modal demo\n</button>\n<div *ngIf=\"demoValue\">The user entered {{ demoValue }}</div>\n"
     },
+    {
+      "fileName": "modal-demo.component.spec.ts",
+      "filePath": "/projects/modals/documentation/code-examples/modal/modal-demo.component.spec.ts",
+      "rawContents": "import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';\nimport { ComponentFixture, TestBed } from '@angular/core/testing';\nimport { SkyWaitService } from '@skyux/indicators';\nimport { SkyModalService } from '@skyux/modals';\nimport { SkyModalHarness } from '@skyux/modals/testing';\n\nimport { Observable, of } from 'rxjs';\n\nimport { ModalDemoDataService } from './modal-demo-data.service';\nimport { ModalDemoComponent } from './modal-demo.component';\nimport { ModalDemoModule } from './modal-demo.module';\n\nclass mockWaitSvc {\n  public blockingWrap(data: unknown): Observable<unknown> {\n    return of(data);\n  }\n}\n\ndescribe('Basic modal', async () => {\n  async function setupTest(): Promise<{\n    modalHarness: SkyModalHarness;\n    fixture: ComponentFixture<ModalDemoComponent>;\n  }> {\n    const fixture = TestBed.createComponent(ModalDemoComponent);\n    fixture.componentInstance.onOpenModalClick();\n    fixture.detectChanges();\n\n    const loader = TestbedHarnessEnvironment.documentRootLoader(fixture);\n    const modalHarness = await loader.getHarness(\n      SkyModalHarness.with({\n        dataSkyId: 'modal-demo',\n      })\n    );\n\n    return { modalHarness, fixture };\n  }\n\n  beforeEach(() => {\n    TestBed.configureTestingModule({\n      imports: [ModalDemoModule],\n      providers: [\n        SkyModalService,\n        { provide: SkyWaitService, useClass: mockWaitSvc },\n        ModalDemoDataService,\n      ],\n    });\n  });\n\n  it('should open the correct modal', async () => {\n    const { modalHarness, fixture } = await setupTest();\n\n    fixture.detectChanges();\n\n    await expectAsync(modalHarness.getAriaRole()).toBeResolvedTo('dialog');\n    await expectAsync(modalHarness.getSize()).toBeResolvedTo('medium');\n    await expectAsync(modalHarness.isFullPage()).toBeResolvedTo(false);\n  });\n});\n"
+    },
     {
       "fileName": "modal-demo.component.ts",
       "filePath": "/projects/modals/documentation/code-examples/modal/modal-demo.component.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/modals",
-  "version": "7.18.0",
+  "version": "7.19.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -44,10 +44,10 @@
     "@angular/common": "^14.2.11",
     "@angular/core": "^14.2.11",
     "@angular/router": "^14.2.11",
-    "@skyux/core": "7.18.0",
-    "@skyux/i18n": "7.18.0",
-    "@skyux/indicators": "7.18.0",
-    "@skyux/theme": "7.18.0"
+    "@skyux/core": "7.19.0",
+    "@skyux/i18n": "7.19.0",
+    "@skyux/indicators": "7.19.0",
+    "@skyux/theme": "7.19.0"
   },
   "dependencies": {
     "tslib": "^2.3.1"