@skyux/core 10.12.0 → 10.14.0

package/index.d.ts

@@ -30,6 +30,10 @@ export { SkyDynamicComponentModule } from './lib/modules/dynamic-component/dynam
 export { SkyDynamicComponentLegacyService, SkyDynamicComponentService, } from './lib/modules/dynamic-component/dynamic-component.service';
 export { SkyFormsUtility } from './lib/modules/forms-utility/forms-utility';
 export { SkyAppFormat } from './lib/modules/format/app-format';
+export { SkyHelpGlobalOptions } from './lib/modules/help/help-global-options';
+export { SKY_HELP_GLOBAL_OPTIONS } from './lib/modules/help/help-global-options-token';
+export { SkyHelpOpenArgs } from './lib/modules/help/help-open-args';
+export { SkyHelpService } from './lib/modules/help/help.service';
 export { SkyIdModule } from './lib/modules/id/id.module';
 export { SkyIdService } from './lib/modules/id/id.service';
 export { SkyLayoutHostForChildArgs } from './lib/modules/layout-host/layout-host-for-child-args';

package/lib/modules/help/help-global-options-token.d.ts

@@ -0,0 +1,6 @@
+import { InjectionToken } from '@angular/core';
+import { SkyHelpGlobalOptions } from './help-global-options';
+/**
+ * Injection token for specifying and retrieving global help options.
+ */
+export declare const SKY_HELP_GLOBAL_OPTIONS: InjectionToken<SkyHelpGlobalOptions>;

package/lib/modules/help/help-global-options.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options to apply to all components that invoke global help.
+ */
+export interface SkyHelpGlobalOptions {
+    /**
+     * The ID of the element that is displayed when the invoking component is clicked.
+     */
+    ariaControls?: string;
+    /**
+     * The type of popup triggered by the invoking component.
+     */
+    ariaHaspopup?: 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+}

package/lib/modules/help/help-open-args.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Options for displaying global help.
+ */
+export interface SkyHelpOpenArgs {
+    /**
+     * A unique key that identifies the help content to display.
+     * */
+    helpKey: string;
+}

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

@@ -0,0 +1,14 @@
+import { SkyHelpOpenArgs } from './help-open-args';
+import * as i0 from "@angular/core";
+/**
+ * Provides methods for opening a globally accessible help dialog.
+ */
+export declare class SkyHelpService {
+    /**
+     * Opens a globally accessible help dialog.
+     * @param args The options for opening the help dialog.
+     */
+    openHelp(args: SkyHelpOpenArgs): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SkyHelpService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "10.12.0",
+  "version": "10.14.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -42,7 +42,7 @@
     "@angular/forms": "^17.3.4",
     "@angular/platform-browser": "^17.3.4",
     "@angular/router": "^17.3.4",
-    "@skyux/i18n": "10.12.0"
+    "@skyux/i18n": "10.14.0"
   },
   "dependencies": {
     "tslib": "^2.6.2"

package/testing/help/help-testing-controller.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Provides methods for validating global help in unit tests.
+ */
+export declare class SkyHelpTestingController {
+    #private;
+    /**
+     * Validates the current help key and throws an error if the current help key does not match the expected help key.
+     * @param expectedHelpKey The expected help key.
+     */
+    expectCurrentHelpKey(expectedHelpKey: string | undefined): void;
+    /**
+     * Close the current help.
+     */
+    closeHelp(): void;
+}

package/testing/help/help-testing.module.d.ts

@@ -0,0 +1,9 @@
+import * as i0 from "@angular/core";
+/**
+ * Mocks SkyHelpService to enable testing of global help.
+ */
+export declare class SkyHelpTestingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpTestingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyHelpTestingModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SkyHelpTestingModule>;
+}

package/testing/help/help-testing.service.d.ts

@@ -0,0 +1,13 @@
+import { SkyHelpOpenArgs, SkyHelpService } from '@skyux/core';
+import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
+export declare class SkyHelpTestingService extends SkyHelpService {
+    #private;
+    openHelp(args: SkyHelpOpenArgs): void;
+    getCurrentHelpKey(): string | undefined;
+    closeHelp(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpTestingService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SkyHelpTestingService>;
+}

package/testing/public-api.d.ts

@@ -7,3 +7,5 @@ export { mockResizeObserver, mockResizeObserverEntry, mockResizeObserverHandle,
 export { SkyComponentHarness } from './shared/component-harness';
 export { SkyHarnessFilters } from './shared/harness-filters';
 export { SkyQueryableComponentHarness } from './shared/queryable-component-harness';
+export { SkyHelpTestingController } from './help/help-testing-controller';
+export { SkyHelpTestingModule } from './help/help-testing.module';