@skyux/modals 6.0.0-beta.1 → 6.0.0-beta.4

package/lib/modules/modal/modal-close-args.d.ts

@@ -1,4 +1,15 @@
+/**
+ * Contains an object with the data passed from users when
+ * a modal is closed and the reason that the modal was closed.
+ */
 export declare class SkyModalCloseArgs {
+    /**
+     * Indicates the reason the modal was closed.
+     * Options include `"close"`, `"save"`, and `"cancel"`.
+     */
     reason: string;
+    /**
+     * The data passed from users when the modal is closed.
+     */
     data: any;
 }

package/lib/modules/modal/modal-instance.d.ts

@@ -1,9 +1,6 @@
 import { Observable } from 'rxjs';
 import { SkyModalBeforeCloseHandler } from './modal-before-close-handler';
 import { SkyModalCloseArgs } from './modal-close-args';
-/**
- * Allows you to close the modal and return data from the launched modal.
- */
 export declare class SkyModalInstance {
     /**
      * An event that the modal instance emits when it is about to close.
@@ -18,7 +15,7 @@ export declare class SkyModalInstance {
      * data passed from users on close or save and a `reason` property that indicates
      * whether the modal was saved or closed without saving.
      * The `reason` property accepts any string value.
-     * Common examples include `cancel`, `close`, and `save`.
+     * Common examples include `"cancel"`, `"close"`, and `"save"`.
      */
     get closed(): Observable<SkyModalCloseArgs>;
     /**
@@ -39,19 +36,19 @@ export declare class SkyModalInstance {
      * @param result Specifies an object to emit to subscribers of the `closed` event of the
      * modal instance. The `SkyModalInstance` provider can be injected into a component's constructor
      * so that this `close` function can be called from a button in the `sky-modal-footer`.
-     * @param reason Specifies the reason for the modal closing, with the default reason of `close`.
+     * @param reason Specifies the reason for the modal closing, with the default reason of `"close"`.
      * @param ignoreBeforeClose Indicates whether to ignore the modal instance's `beforeClose` event.
      */
     close(result?: any, reason?: string, ignoreBeforeClose?: boolean): void;
     /**
-     * Closes the modal instance with `reason=cancel`.
+     * Closes the modal instance with `reason="cancel"`.
      * @param result Specifies an object to emit to subscribers of the `closed` event of the modal
      * instance. The `SkyModalInstance` provider can be injected into a component's constructor so
      * that this cancel function can be called from a button in the `sky-modal-footer`.
      */
     cancel(result?: any): void;
     /**
-     * Closes the modal instance with `reason=save`.
+     * Closes the modal instance with `reason="save"`.
      * @param result Specifies an object to emit to subscribers of the `closed` event of the modal
      * instance. The `SkyModalInstance` provider can be injected into a component's constructor so
      * that this `save` function can be called from a button in `the sky-modal-footer`.

package/lib/modules/modal/modal.component.d.ts

@@ -1,5 +1,5 @@
-import { AfterViewInit, ElementRef } from '@angular/core';
-import { SkyAppWindowRef, SkyCoreAdapterService, SkyDockService } from '@skyux/core';
+import { AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
+import { SkyAppWindowRef, SkyCoreAdapterService, SkyDockService, SkyResizeObserverMediaQueryService } from '@skyux/core';
 import { SkyModalComponentAdapterService } from './modal-component-adapter.service';
 import { SkyModalConfiguration } from './modal-configuration';
 import { SkyModalHostService } from './modal-host.service';
@@ -8,10 +8,9 @@ import * as i0 from "@angular/core";
 /**
  * Provides a common look-and-feel for modal content with options to display
  * a common modal header, specify body content, and display a common modal footer
- * and buttons. For information about how to test modals in SKY UX, see
- * [write unit tests for modals](https://developer.blackbaud.com/skyux/learn/get-started/advanced/unit-test-modals).
+ * and buttons.
  */
-export declare class SkyModalComponent implements AfterViewInit {
+export declare class SkyModalComponent implements AfterViewInit, OnDestroy {
     private hostService;
     private config;
     private elRef;
@@ -19,6 +18,7 @@ export declare class SkyModalComponent implements AfterViewInit {
     private componentAdapter;
     private coreAdapter;
     private dockService;
+    private mediaQueryService?;
     get wrapperClass(): string;
     /**
      * @internal
@@ -43,15 +43,16 @@ export declare class SkyModalComponent implements AfterViewInit {
     modalHeaderId: string;
     scrollShadow: SkyModalScrollShadowEventArgs;
     private modalContentWrapperElement;
-    constructor(hostService: SkyModalHostService, config: SkyModalConfiguration, elRef: ElementRef, windowRef: SkyAppWindowRef, componentAdapter: SkyModalComponentAdapterService, coreAdapter: SkyCoreAdapterService, dockService: SkyDockService);
+    constructor(hostService: SkyModalHostService, config: SkyModalConfiguration, elRef: ElementRef, windowRef: SkyAppWindowRef, componentAdapter: SkyModalComponentAdapterService, coreAdapter: SkyCoreAdapterService, dockService: SkyDockService, mediaQueryService?: SkyResizeObserverMediaQueryService);
     onDocumentKeyUp(event: KeyboardEvent): void;
     onDocumentKeyDown(event: KeyboardEvent): void;
     ngAfterViewInit(): void;
+    ngOnDestroy(): void;
     helpButtonClick(): void;
     closeButtonClick(): void;
     windowResize(): void;
     scrollShadowChange(args: SkyModalScrollShadowEventArgs): void;
     private isSizeEqual;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalComponent, [null, null, null, null, null, null, { host: true; }]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalComponent, [null, null, null, null, null, null, { host: true; }, { optional: true; host: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalComponent, "sky-modal", never, { "ariaRole": "ariaRole"; "tiledBody": "tiledBody"; }, {}, never, ["sky-modal-header", "sky-modal-content", "sky-modal-footer"]>;
 }

package/lib/modules/modal/modal.interface.d.ts

@@ -52,7 +52,7 @@ export interface SkyModalConfigurationInterface {
      */
     tiledBody?: boolean;
     /**
-     * Specifies a `helpKey` string. This property dispays
+     * Specifies a `helpKey` string. This property displays
      * the <i class="fa fa-question-circle" aria-hidden="true"></i> button in the modal header.
      * When users click this button, the `helpOpened` event broadcasts the `helpKey` parameter.
      * Blackbaud developers can use the Help Widget, which is for internal Blackbaud use only, to

package/lib/modules/modal/modal.service.d.ts

@@ -3,8 +3,7 @@ import { SkyModalInstance } from './modal-instance';
 import { SkyModalConfigurationInterface } from './modal.interface';
 import * as i0 from "@angular/core";
 /**
- * A service that lauches modals. For information about how to test modals in SKY UX, see
- * [write unit tests for modals](https://developer.blackbaud.com/skyux/learn/get-started/advanced/unit-test-modals).
+ * A service that launches modals.
  * @dynamic
  */
 export declare class SkyModalService {
@@ -19,7 +18,7 @@ export declare class SkyModalService {
     /**
      * Opens a modal using the specified component.
      * @param component Determines the component to render.
-     * @param {SkyModalConfigurationInterface} config Populates the modal based on the `SkyModalConfigurationInterface` object.
+     * @param {SkyModalConfigurationInterface} config Specifies configuration options for the modal.
      */
     open(component: any, config?: SkyModalConfigurationInterface | any[]): SkyModalInstance;
     private getConfigFromParameter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/modals",
-  "version": "6.0.0-beta.1",
+  "version": "6.0.0-beta.4",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -15,25 +15,6 @@
     "url": "https://github.com/blackbaud/skyux/issues"
   },
   "homepage": "https://github.com/blackbaud/skyux#readme",
-  "peerDependencies": {
-    "@angular/animations": "^13.2.7",
-    "@angular/common": "^13.2.7",
-    "@angular/core": "^13.2.7",
-    "@angular/router": "^13.2.7",
-    "@skyux/core": "6.0.0-beta.1",
-    "@skyux/i18n": "6.0.0-beta.1",
-    "@skyux/indicators": "6.0.0-beta.1",
-    "@skyux/theme": "6.0.0-beta.1"
-  },
-  "dependencies": {
-    "tslib": "^2.3.1"
-  },
-  "module": "fesm2015/skyux-modals.mjs",
-  "es2020": "fesm2020/skyux-modals.mjs",
-  "esm2020": "esm2020/skyux-modals.mjs",
-  "fesm2020": "fesm2020/skyux-modals.mjs",
-  "fesm2015": "fesm2015/skyux-modals.mjs",
-  "typings": "skyux-modals.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
@@ -53,7 +34,29 @@
       "es2015": "./fesm2015/skyux-modals-testing.mjs",
       "node": "./fesm2015/skyux-modals-testing.mjs",
       "default": "./fesm2020/skyux-modals-testing.mjs"
+    },
+    "./documentation.json": {
+      "default": "./documentation.json"
     }
   },
+  "peerDependencies": {
+    "@angular/animations": "^13.3.2",
+    "@angular/common": "^13.3.2",
+    "@angular/core": "^13.3.2",
+    "@angular/router": "^13.3.2",
+    "@skyux/core": "6.0.0-beta.4",
+    "@skyux/i18n": "6.0.0-beta.4",
+    "@skyux/indicators": "6.0.0-beta.4",
+    "@skyux/theme": "6.0.0-beta.4"
+  },
+  "dependencies": {
+    "tslib": "^2.3.1"
+  },
+  "module": "fesm2015/skyux-modals.mjs",
+  "es2020": "fesm2020/skyux-modals.mjs",
+  "esm2020": "esm2020/skyux-modals.mjs",
+  "fesm2020": "fesm2020/skyux-modals.mjs",
+  "fesm2015": "fesm2015/skyux-modals.mjs",
+  "typings": "skyux-modals.d.ts",
   "sideEffects": false
-}
+}