@skyux/modals 5.8.1 → 5.8.4

package/bundles/skyux-modals.umd.js

@@ -33,31 +33,23 @@
     var SkyConfirmInstance = /** @class */ (function () {
         function SkyConfirmInstance() {
             /**
-             * Fires when users select an action to close the confirmation dialog. This event
+             * Fires when users select an action to close the dialog. This event
              * returns a `SkyConfirmCloseEventArgs` object with information about the button that
-             * users select.
+             * users select. It returns the `'cancel'` action when users press the <kbd>Escape</kbd> key.
              */
             this.closed = new i0.EventEmitter();
         }
         return SkyConfirmInstance;
     }());
 
-    /* istanbul ignore next */
-    var SkyConfirmModalContext = /** @class */ (function () {
-        function SkyConfirmModalContext() {
-        }
-        return SkyConfirmModalContext;
-    }());
-
     exports.SkyConfirmType = void 0;
     (function (SkyConfirmType) {
         /**
-         * Allows you to define your own `buttons` using the buttons property to
-         * specify an array of `SkyConfirmButtonConfig` objects.
+         * Allows you to define your own buttons using the `buttons` property of `SkyConfirmConfig`.
          */
         SkyConfirmType[SkyConfirmType["Custom"] = 0] = "Custom";
         /**
-         * Displays one button with an **OK** label.
+         * Displays one button with an **OK** label and an `'ok'` action.
          */
         SkyConfirmType[SkyConfirmType["OK"] = 1] = "OK";
         /**
@@ -950,6 +942,15 @@
                     }]
             }] });
 
+    /**
+     * @internal
+     */
+    var SkyConfirmModalContext = /** @class */ (function () {
+        function SkyConfirmModalContext() {
+        }
+        return SkyConfirmModalContext;
+    }());
+
     /**
      * Closes the modal instance using the `closeModal` method.
      */
@@ -971,11 +972,6 @@
         return SkyModalCloseArgs;
     }());
 
-    // TODO: this class won't show in the generated docs until this work is done:
-    // https://github.com/blackbaud/skyux-docs-tools/issues/30
-    /**
-     * Allows you to close the modal and return data from the launched modal.
-     */
     var SkyModalInstance = /** @class */ (function () {
         function SkyModalInstance() {
             this._beforeClose = new rxjs.Subject();
@@ -1260,7 +1256,7 @@
         /**
          * 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.
          */
         SkyModalService.prototype.open = function (component, config) {
             var modalInstance = new SkyModalInstance();
@@ -1317,16 +1313,15 @@
             }], ctorParameters: function () { return [{ type: i3__namespace.SkyDynamicComponentService }]; } });
 
     /**
-     *  The `SkyConfirmService` provider launches the confirmation dialog.
-     * Within the service, you can specify the dialog's message and customize the button text.
+     * Launches a dialog.
      */
     var SkyConfirmService = /** @class */ (function () {
         function SkyConfirmService(modalService) {
             this.modalService = modalService;
         }
         /**
-         * Opens a confirmation dialog and passes the `config` parameter of type `SkyConfirmConfig`
-         * to the component's constructor. This method returns an object of type `SkyConfirmInstance`.
+         * Opens a dialog using the specified options.
+         * @param config Specifies configuration options for the dialog.
          */
         SkyConfirmService.prototype.open = function (config) {
             var modalInstance = this.modalService.open(SkyConfirmComponent, {
@@ -1365,12 +1360,13 @@
                     }]
             }], ctorParameters: function () { return [{ type: SkyModalService }]; } });
 
+    // TODO: confirm-button is internal and should be removed in a future version
+
     /**
      * Generated bundle index. Do not edit.
      */
 
     exports.SkyConfirmInstance = SkyConfirmInstance;
-    exports.SkyConfirmModalContext = SkyConfirmModalContext;
     exports.SkyConfirmModule = SkyConfirmModule;
     exports.SkyConfirmService = SkyConfirmService;
     exports.SkyModalBeforeCloseHandler = SkyModalBeforeCloseHandler;