@skyux/modals 13.14.2 → 13.15.0

package/index.d.ts

@@ -537,6 +537,13 @@ declare class SkyModalComponent implements AfterViewInit, OnDestroy, OnInit {
     set ariaLabelledBy(id: string | undefined);
     get ariaLabelledBy(): string | undefined;
     readonly layout: i0.InputSignal<"none" | "fit">;
+    /**
+     * Whether to hide the modal's header, including the heading from `headingText`,
+     * the help inline button if `helpKey` is provided, and the close button in the
+     * top right. Reserve this property for specific use cases where you need a
+     * banner image in place of the header.
+     */
+    readonly headingHidden: i0.InputSignalWithTransform<boolean, unknown>;
     ariaOwns: string | null;
     /**
      * @deprecated
@@ -563,7 +570,25 @@ declare class SkyModalComponent implements AfterViewInit, OnDestroy, OnInit {
     scrollShadowChange(args: SkyScrollShadowEventArgs): void;
     viewkeeperEnabled(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalComponent, "sky-modal", never, { "formErrors": { "alias": "formErrors"; "required": false; }; "headingText": { "alias": "headingText"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "tiledBody": { "alias": "tiledBody"; "required": false; }; "ariaDescribedBy": { "alias": "ariaDescribedBy"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "layout": { "alias": "layout"; "required": false; "isSignal": true; }; }, {}, never, ["sky-modal-header", "sky-modal-content", "sky-modal-footer"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalComponent, "sky-modal", never, { "formErrors": { "alias": "formErrors"; "required": false; }; "headingText": { "alias": "headingText"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "tiledBody": { "alias": "tiledBody"; "required": false; }; "ariaDescribedBy": { "alias": "ariaDescribedBy"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "layout": { "alias": "layout"; "required": false; "isSignal": true; }; "headingHidden": { "alias": "headingHidden"; "required": false; "isSignal": true; }; }, {}, never, ["sky-modal-header", "sky-modal-banner", "sky-modal-content", "sky-modal-footer"], true, never>;
+}
+
+/**
+ * Specifies content to display at the top of the modal. The content extends
+ * the full width of the modal without any padding or margin. In general, only
+ * use a banner when the modal's `headingHidden` input is set to `true`.
+ */
+declare class SkyModalBannerComponent {
+    /**
+     * The banner image to display at the top of the modal. To fit the allotted
+     * space, the image must have a 5:3 aspect ratio. If it is wider, extra space
+     * appears under the image. If it is narrower, the bottom of the image is
+     * cropped.
+     */
+    readonly imageSrc: i0.InputSignal<string>;
+    protected readonly backgroundImage: i0.Signal<string | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalBannerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalBannerComponent, "sky-modal-banner", never, { "imageSrc": { "alias": "imageSrc"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
 }
 
 /**
@@ -610,7 +635,7 @@ declare class SkyModalIsDirtyDirective implements OnInit, OnDestroy {
 
 declare class SkyModalModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalModule, never, [typeof SkyModalComponent, typeof SkyModalContentComponent, typeof SkyModalFooterComponent, typeof SkyModalHeaderComponent, typeof SkyModalIsDirtyDirective], [typeof SkyModalComponent, typeof SkyModalContentComponent, typeof SkyModalFooterComponent, typeof SkyModalHeaderComponent, typeof SkyModalIsDirtyDirective]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalModule, never, [typeof SkyModalComponent, typeof SkyModalBannerComponent, typeof SkyModalContentComponent, typeof SkyModalFooterComponent, typeof SkyModalHeaderComponent, typeof SkyModalIsDirtyDirective], [typeof SkyModalComponent, typeof SkyModalBannerComponent, typeof SkyModalContentComponent, typeof SkyModalFooterComponent, typeof SkyModalHeaderComponent, typeof SkyModalIsDirtyDirective]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyModalModule>;
 }
 
@@ -643,5 +668,5 @@ declare class SkyConfirmComponent implements OnDestroy {
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyConfirmComponent, "sky-confirm", never, {}, {}, never, never, true, never>;
 }
 
-export { SkyConfirmInstance, SkyConfirmModule, SkyConfirmService, SkyConfirmType, SkyModalBeforeCloseHandler, SkyModalCloseArgs, SkyModalConfiguration, SkyModalErrorsService, SkyModalHostService, SkyModalInstance, SkyModalLegacyService, SkyModalModule, SkyModalService, SkyConfirmComponent as λ1, SkyModalContentComponent as λ2, SkyModalFooterComponent as λ3, SkyModalHeaderComponent as λ4, SkyModalComponent as λ5, SkyModalIsDirtyDirective as λ6 };
+export { SkyConfirmInstance, SkyConfirmModule, SkyConfirmService, SkyConfirmType, SkyModalBeforeCloseHandler, SkyModalCloseArgs, SkyModalConfiguration, SkyModalErrorsService, SkyModalHostService, SkyModalInstance, SkyModalLegacyService, SkyModalModule, SkyModalService, SkyConfirmComponent as λ1, SkyModalContentComponent as λ2, SkyModalFooterComponent as λ3, SkyModalHeaderComponent as λ4, SkyModalComponent as λ5, SkyModalIsDirtyDirective as λ6, SkyModalBannerComponent as λ7 };
 export type { SkyConfirmButtonAction, SkyConfirmButtonConfig, SkyConfirmButtonStyleType, SkyConfirmCloseEventArgs, SkyConfirmConfig, SkyConfirmServiceInterface, SkyModalConfigurationInterface, SkyModalError, SkyModalServiceInterface };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/modals",
-  "version": "13.14.2",
+  "version": "13.15.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -17,15 +17,15 @@
   "homepage": "https://github.com/blackbaud/skyux#readme",
   "peerDependencies": {
     "@angular/cdk": "^20.2.14",
-    "@angular/common": "^20.3.15",
-    "@angular/core": "^20.3.15",
-    "@angular/router": "^20.3.15",
-    "@skyux/core": "13.14.2",
-    "@skyux/help-inline": "13.14.2",
-    "@skyux/i18n": "13.14.2",
-    "@skyux/icon": "13.14.2",
-    "@skyux/indicators": "13.14.2",
-    "@skyux/theme": "13.14.2"
+    "@angular/common": "^20.3.17",
+    "@angular/core": "^20.3.17",
+    "@angular/router": "^20.3.17",
+    "@skyux/core": "13.15.0",
+    "@skyux/help-inline": "13.15.0",
+    "@skyux/i18n": "13.15.0",
+    "@skyux/icon": "13.15.0",
+    "@skyux/indicators": "13.15.0",
+    "@skyux/theme": "13.15.0"
   },
   "dependencies": {
     "tslib": "^2.8.1"

package/testing/index.d.ts

@@ -221,6 +221,21 @@ declare class SkyModalTestingModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyModalTestingModule>;
 }
 
+/**
+ * Harness for interacting with a modal banner component in tests.
+ */
+declare class SkyModalBannerHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets the image source URL from the banner's background image style.
+     * Returns `null` if no image source is set.
+     */
+    getImageSrc(): Promise<string | null>;
+}
+
 /**
  * A set of criteria that can be used to filter a list of SkyModalHarness instances.
  */
@@ -241,6 +256,10 @@ declare class SkyModalHarness extends SkyComponentHarness {
      * `SkyModalHarness` that meets certain criteria
      */
     static with(filters: SkyModalHarnessFilters): HarnessPredicate<SkyModalHarness>;
+    /**
+     * Gets the modal banner harness, or `null` if no banner is present.
+     */
+    getBanner(): Promise<SkyModalBannerHarness | null>;
     /**
      * Clicks the help inline button.
      */
@@ -289,5 +308,5 @@ declare class SkyModalHarness extends SkyComponentHarness {
     isDirty(): Promise<boolean>;
 }
 
-export { SkyConfirmButtonHarness, SkyConfirmHarness, SkyConfirmTestingController, SkyConfirmTestingModule, SkyModalFixture, SkyModalHarness, SkyModalTestingController, SkyModalTestingModule };
+export { SkyConfirmButtonHarness, SkyConfirmHarness, SkyConfirmTestingController, SkyConfirmTestingModule, SkyModalBannerHarness, SkyModalFixture, SkyModalHarness, SkyModalTestingController, SkyModalTestingModule };
 export type { SkyConfirmButtonHarnessFilters, SkyModalHarnessFilters };