@skyux/modals 7.14.0 → 7.15.0

package/documentation.json

@@ -408,7 +408,7 @@
         "kindString": "Class",
         "flags": {},
         "comment": {
-          "shortText": "Closes the modal instance using the `closeModal` method."
+          "shortText": "Properties about the modal close action and a method to close the modal."
         },
         "children": [
           {
@@ -420,7 +420,7 @@
             "sources": [
               {
                 "fileName": "projects/modals/src/modules/modal/modal-before-close-handler.ts",
-                "line": 7,
+                "line": 20,
                 "character": 2
               }
             ],
@@ -465,6 +465,57 @@
                 }
               }
             ]
+          },
+          {
+            "id": 137,
+            "name": "closeArgs",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true,
+              "isReadonly": true
+            },
+            "comment": {
+              "shortText": "The object that would be emitted by a modal's `closed` event. This object\ncan be used to determine whether to prompt the user for confirmation, such\nas when the user closes a modal form after entering data."
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/modules/modal/modal-before-close-handler.ts",
+                "line": 12,
+                "character": 18
+              }
+            ],
+            "type": {
+              "type": "reference",
+              "id": 139,
+              "name": "SkyModalCloseArgs"
+            }
+          },
+          {
+            "id": 138,
+            "name": "closeModal",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true,
+              "isReadonly": true
+            },
+            "comment": {
+              "shortText": "Function to call to close the modal. Neglecting to call this function\neffectively cancels the close modal action."
+            },
+            "sources": [
+              {
+                "fileName": "projects/modals/src/modules/modal/modal-before-close-handler.ts",
+                "line": 18,
+                "character": 18
+              }
+            ],
+            "type": {
+              "type": "reference",
+              "qualifiedName": "Function",
+              "package": "typescript",
+              "name": "Function"
+            }
           }
         ],
         "groups": [
@@ -479,8 +530,8 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              138,
-              137
+              137,
+              138
             ]
           }
         ],
@@ -3732,7 +3783,7 @@
     {
       "fileName": "modal-demo-modal.component.ts",
       "filePath": "/projects/modals/documentation/code-examples/modal/modal-demo-modal.component.ts",
-      "rawContents": "import { Component } from '@angular/core';\nimport { FormBuilder, FormControl, FormGroup } from '@angular/forms';\nimport { SkyWaitService } from '@skyux/indicators';\nimport { SkyModalInstance } from '@skyux/modals';\n\nimport { ModalDemoContext } from './modal-demo-context';\nimport { ModalDemoDataService } from './modal-demo-data.service';\n\n@Component({\n  selector: 'app-modal-demo-modal',\n  templateUrl: './modal-demo-modal.component.html',\n})\nexport class ModalDemoModalComponent {\n  public demoForm: FormGroup<{\n    value1: FormControl<string | null | undefined>;\n  }>;\n\n  #dataSvc: ModalDemoDataService;\n  #instance: SkyModalInstance;\n  #waitSvc: SkyWaitService;\n\n  constructor(\n    instance: SkyModalInstance,\n    waitSvc: SkyWaitService,\n    dataSvc: ModalDemoDataService,\n    context: ModalDemoContext,\n    fb: FormBuilder\n  ) {\n    this.#instance = instance;\n    this.#waitSvc = waitSvc;\n    this.#dataSvc = dataSvc;\n\n    const value1 = fb.control(context.data.value1);\n    this.demoForm = fb.group({ value1 });\n  }\n\n  public saveForm(): void {\n    // Use the data service to save the data.\n\n    this.#waitSvc\n      .blockingWrap(this.#dataSvc.save(this.demoForm.value))\n      .subscribe((data) => {\n        // Notify the modal instance that data was saved and return the saved data.\n        this.#instance.save(data);\n      });\n  }\n\n  public cancelForm(): void {\n    this.#instance.cancel();\n  }\n}\n"
+      "rawContents": "import { Component, OnInit, inject } from '@angular/core';\nimport { FormControl, FormGroup } from '@angular/forms';\nimport { SkyWaitService } from '@skyux/indicators';\nimport {\n  SkyConfirmService,\n  SkyConfirmType,\n  SkyModalBeforeCloseHandler,\n  SkyModalInstance,\n} from '@skyux/modals';\n\nimport { Subject } from 'rxjs';\nimport { takeUntil } from 'rxjs/operators';\n\nimport { ModalDemoContext } from './modal-demo-context';\nimport { ModalDemoDataService } from './modal-demo-data.service';\n\n@Component({\n  selector: 'app-modal-demo-modal',\n  templateUrl: './modal-demo-modal.component.html',\n})\nexport class ModalDemoModalComponent implements OnInit {\n  protected demoForm: FormGroup<{\n    value1: FormControl<string | null | undefined>;\n  }>;\n\n  #ngUnsubscribe = new Subject<void>();\n\n  #confirmSvc = inject(SkyConfirmService);\n  #instance = inject(SkyModalInstance);\n  #waitSvc = inject(SkyWaitService);\n  #context = inject(ModalDemoContext);\n  #dataSvc = inject(ModalDemoDataService);\n\n  constructor() {\n    this.demoForm = new FormGroup({\n      value1: new FormControl(this.#context.data.value1),\n    });\n  }\n\n  public ngOnInit(): void {\n    // Display a confirmation dialog based on how the modal is being closed.\n    this.#instance.beforeClose\n      .pipe(takeUntil(this.#ngUnsubscribe))\n      .subscribe((args) => this.#confirmClose(args));\n  }\n\n  public saveForm(): void {\n    // Use the data service to save the data.\n\n    this.#waitSvc\n      .blockingWrap(this.#dataSvc.save(this.demoForm.value))\n      .subscribe((data) => {\n        // Notify the modal instance that data was saved and return the saved data.\n        this.#instance.save(data);\n      });\n  }\n\n  public cancelForm(): void {\n    this.#instance.cancel();\n  }\n\n  #confirmClose(args: SkyModalBeforeCloseHandler): void {\n    if (args.closeArgs.reason === 'close' && this.demoForm.dirty) {\n      // The user closed the form either by clicking the close button\n      // or pressing Escape. Confirm that the user wants to discard\n      // unsaved changes. Note that clicking Cancel does not require\n      // confirmation.\n      const confirm = this.#confirmSvc.open({\n        message:\n          'You have unsaved changes that will be lost. Are you sure you want to close the form?',\n        buttons: [\n          {\n            action: 'no',\n            styleType: 'primary',\n            text: 'No',\n          },\n          {\n            action: 'yes',\n            text: 'Yes',\n          },\n        ],\n        type: SkyConfirmType.Custom,\n      });\n\n      confirm.closed\n        .pipe(takeUntil(this.#ngUnsubscribe))\n        .subscribe((confirmArgs) => {\n          if (confirmArgs.action === 'yes') {\n            args.closeModal();\n          }\n        });\n    } else {\n      args.closeModal();\n    }\n  }\n}\n"
     },
     {
       "fileName": "modal-demo.component.html",

package/esm2020/lib/modules/modal/modal-before-close-handler.mjs

@@ -1,10 +1,10 @@
 /**
- * Closes the modal instance using the `closeModal` method.
+ * Properties about the modal close action and a method to close the modal.
  */
 export class SkyModalBeforeCloseHandler {
     constructor(closeModal, closeArgs) {
-        this.closeModal = closeModal;
         this.closeArgs = closeArgs;
+        this.closeModal = closeModal;
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kYWwtYmVmb3JlLWNsb3NlLWhhbmRsZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi8uLi8uLi9saWJzL2NvbXBvbmVudHMvbW9kYWxzL3NyYy9saWIvbW9kdWxlcy9tb2RhbC9tb2RhbC1iZWZvcmUtY2xvc2UtaGFuZGxlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7R0FFRztBQUNILE1BQU0sT0FBTywwQkFBMEI7SUFDckMsWUFDa0IsVUFBb0IsRUFDcEIsU0FBNEI7UUFENUIsZUFBVSxHQUFWLFVBQVUsQ0FBVTtRQUNwQixjQUFTLEdBQVQsU0FBUyxDQUFtQjtJQUMzQyxDQUFDO0NBQ0wiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBTa3lNb2RhbENsb3NlQXJncyB9IGZyb20gJy4vbW9kYWwtY2xvc2UtYXJncyc7XG5cbi8qKlxuICogQ2xvc2VzIHRoZSBtb2RhbCBpbnN0YW5jZSB1c2luZyB0aGUgYGNsb3NlTW9kYWxgIG1ldGhvZC5cbiAqL1xuZXhwb3J0IGNsYXNzIFNreU1vZGFsQmVmb3JlQ2xvc2VIYW5kbGVyIHtcbiAgY29uc3RydWN0b3IoXG4gICAgcHVibGljIHJlYWRvbmx5IGNsb3NlTW9kYWw6IEZ1bmN0aW9uLFxuICAgIHB1YmxpYyByZWFkb25seSBjbG9zZUFyZ3M6IFNreU1vZGFsQ2xvc2VBcmdzXG4gICkge31cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kYWwtYmVmb3JlLWNsb3NlLWhhbmRsZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi8uLi8uLi9saWJzL2NvbXBvbmVudHMvbW9kYWxzL3NyYy9saWIvbW9kdWxlcy9tb2RhbC9tb2RhbC1iZWZvcmUtY2xvc2UtaGFuZGxlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7R0FFRztBQUNILE1BQU0sT0FBTywwQkFBMEI7SUFjckMsWUFBWSxVQUFvQixFQUFFLFNBQTRCO1FBQzVELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO0lBQy9CLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFNreU1vZGFsQ2xvc2VBcmdzIH0gZnJvbSAnLi9tb2RhbC1jbG9zZS1hcmdzJztcblxuLyoqXG4gKiBQcm9wZXJ0aWVzIGFib3V0IHRoZSBtb2RhbCBjbG9zZSBhY3Rpb24gYW5kIGEgbWV0aG9kIHRvIGNsb3NlIHRoZSBtb2RhbC5cbiAqL1xuZXhwb3J0IGNsYXNzIFNreU1vZGFsQmVmb3JlQ2xvc2VIYW5kbGVyIHtcbiAgLyoqXG4gICAqIFRoZSBvYmplY3QgdGhhdCB3b3VsZCBiZSBlbWl0dGVkIGJ5IGEgbW9kYWwncyBgY2xvc2VkYCBldmVudC4gVGhpcyBvYmplY3RcbiAgICogY2FuIGJlIHVzZWQgdG8gZGV0ZXJtaW5lIHdoZXRoZXIgdG8gcHJvbXB0IHRoZSB1c2VyIGZvciBjb25maXJtYXRpb24sIHN1Y2hcbiAgICogYXMgd2hlbiB0aGUgdXNlciBjbG9zZXMgYSBtb2RhbCBmb3JtIGFmdGVyIGVudGVyaW5nIGRhdGEuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgY2xvc2VBcmdzOiBTa3lNb2RhbENsb3NlQXJncztcblxuICAvKipcbiAgICogRnVuY3Rpb24gdG8gY2FsbCB0byBjbG9zZSB0aGUgbW9kYWwuIE5lZ2xlY3RpbmcgdG8gY2FsbCB0aGlzIGZ1bmN0aW9uXG4gICAqIGVmZmVjdGl2ZWx5IGNhbmNlbHMgdGhlIGNsb3NlIG1vZGFsIGFjdGlvbi5cbiAgICovXG4gIHB1YmxpYyByZWFkb25seSBjbG9zZU1vZGFsOiBGdW5jdGlvbjtcblxuICBjb25zdHJ1Y3RvcihjbG9zZU1vZGFsOiBGdW5jdGlvbiwgY2xvc2VBcmdzOiBTa3lNb2RhbENsb3NlQXJncykge1xuICAgIHRoaXMuY2xvc2VBcmdzID0gY2xvc2VBcmdzO1xuICAgIHRoaXMuY2xvc2VNb2RhbCA9IGNsb3NlTW9kYWw7XG4gIH1cbn1cbiJdfQ==

package/fesm2015/skyux-modals.mjs

@@ -949,12 +949,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
 const SKY_CONFIRM_CONFIG = new InjectionToken('SkyConfirmConfig');
 
 /**
- * Closes the modal instance using the `closeModal` method.
+ * Properties about the modal close action and a method to close the modal.
  */
 class SkyModalBeforeCloseHandler {
     constructor(closeModal, closeArgs) {
-        this.closeModal = closeModal;
         this.closeArgs = closeArgs;
+        this.closeModal = closeModal;
     }
 }