@skyux/pages 8.3.0 → 8.4.0

package/lib/modules/page/types/page-layout-type.d.ts

@@ -0,0 +1 @@
+export type SkyPageLayoutType = 'none' | 'fit' | 'blocks' | 'list' | 'tabs';

package/lib/modules/page-header/page-header.component.d.ts

@@ -1,8 +1,17 @@
 import { SkyPageLink } from '../action-hub/types/page-link';
 import * as i0 from "@angular/core";
 declare let parentLink: SkyPageLink;
+/**
+ * Displays a page heading. Applies the correct layout spacing if used within a SkyPage.
+ */
 export declare class SkyPageHeaderComponent {
+    /**
+     * A link to the parent page of the current page.
+     */
     parentLink?: typeof parentLink;
+    /**
+     * The title of the current page.
+     */
     pageTitle: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageHeaderComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageHeaderComponent, "sky-page-header", never, { "parentLink": "parentLink"; "pageTitle": "pageTitle"; }, {}, never, never, false, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/pages",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -27,21 +27,30 @@
       "node": "./fesm2015/skyux-pages.mjs",
       "default": "./fesm2020/skyux-pages.mjs"
     },
+    "./testing": {
+      "types": "./testing/index.d.ts",
+      "esm2020": "./esm2020/testing/skyux-pages-testing.mjs",
+      "es2020": "./fesm2020/skyux-pages-testing.mjs",
+      "es2015": "./fesm2015/skyux-pages-testing.mjs",
+      "node": "./fesm2015/skyux-pages-testing.mjs",
+      "default": "./fesm2020/skyux-pages-testing.mjs"
+    },
     "./documentation.json": {
       "default": "./documentation.json"
     }
   },
   "peerDependencies": {
+    "@angular/cdk": "^15.2.9",
     "@angular/common": "^15.2.9",
     "@angular/core": "^15.2.9",
     "@angular/router": "^15.2.9",
-    "@skyux/core": "8.3.0",
-    "@skyux/i18n": "8.3.0",
-    "@skyux/indicators": "8.3.0",
-    "@skyux/layout": "8.3.0",
-    "@skyux/modals": "8.3.0",
-    "@skyux/router": "8.3.0",
-    "@skyux/theme": "8.3.0"
+    "@skyux/core": "8.4.0",
+    "@skyux/i18n": "8.4.0",
+    "@skyux/indicators": "8.4.0",
+    "@skyux/layout": "8.4.0",
+    "@skyux/modals": "8.4.0",
+    "@skyux/router": "8.4.0",
+    "@skyux/theme": "8.4.0"
   },
   "dependencies": {
     "tslib": "^2.5.0"

package/testing/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@skyux/pages/testing" />
+export * from './public-api';

package/testing/page/page-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of SkyPageHarness instances.
+ */
+export interface SkyPageHarnessFilters extends SkyHarnessFilters {
+}

package/testing/page/page-harness.d.ts

@@ -0,0 +1,29 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyPageLayoutType } from '@skyux/pages';
+import { SkyPageHeaderHarness } from '../page-header/page-header-harness';
+import { SkyPageHeaderHarnessFilters } from '../page-header/page-header-harness-filters';
+import { SkyPageHarnessFilters } from './page-harness-filters';
+/**
+ * Harness for interacting with a page component in tests.
+ */
+export declare class SkyPageHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyPageHarness` that meets certain criteria.
+     */
+    static with(filters: SkyPageHarnessFilters): HarnessPredicate<SkyPageHarness>;
+    /**
+     * Gets the current layout.
+     */
+    getLayout(): Promise<SkyPageLayoutType>;
+    /**
+     * Gets the first page header that matches the given filters.
+     * @param filters filters for which page header to return
+     */
+    getPageHeader(filters?: SkyPageHeaderHarnessFilters): Promise<SkyPageHeaderHarness>;
+}

package/testing/page-header/page-header-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of SkyPageHeaderHarness instances.
+ */
+export interface SkyPageHeaderHarnessFilters extends SkyHarnessFilters {
+}

package/testing/page-header/page-header-harness.d.ts

@@ -0,0 +1,26 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyPageHeaderHarnessFilters } from './page-header-harness-filters';
+/**
+ * Harness for interacting with a page header component in tests.
+ */
+export declare class SkyPageHeaderHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyPageHeaderHarness` that meets certain criteria.
+     */
+    static with(filters: SkyPageHeaderHarnessFilters): HarnessPredicate<SkyPageHeaderHarness>;
+    /**
+     * Gets the current page title.
+     */
+    getPageTitle(): Promise<string | undefined>;
+    /**
+     * Gets the current page title.
+     */
+    getParentLinkText(): Promise<string>;
+}

package/testing/public-api.d.ts

@@ -0,0 +1,2 @@
+export * from './page/page-harness';
+export * from './page/page-harness-filters';