@skyux/core 11.0.0 → 11.1.0

package/index.d.ts

@@ -32,6 +32,7 @@ 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 { SkyHelpUpdateArgs } from './lib/modules/help/help-update-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';

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

@@ -1,5 +1,5 @@
 /**
- * Options for displaying global help.
+ * Options for displaying a globally accessible help dialog.
  */
 export interface SkyHelpOpenArgs {
     /**

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

@@ -0,0 +1,13 @@
+/**
+ *  Options for updating a globally accessible help dialog.
+ */
+export interface SkyHelpUpdateArgs {
+    /**
+     * A unique key that identifies the current help content to display. If set to `undefined`, the page's default help content will be displayed.
+     */
+    helpKey?: string;
+    /**
+     * A unique key that identifies the page's default help content to display. Set this property to `undefined` to unset the current page default help key.
+     * */
+    pageDefaultHelpKey?: string;
+}

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

@@ -1,8 +1,9 @@
 import { Observable } from 'rxjs';
 import { SkyHelpOpenArgs } from './help-open-args';
+import { SkyHelpUpdateArgs } from './help-update-args';
 import * as i0 from "@angular/core";
 /**
- * Provides methods for opening a globally accessible help dialog.
+ * Provides methods for opening and updating a globally accessible help dialog.
  */
 export declare abstract class SkyHelpService {
     /**
@@ -13,7 +14,12 @@ export declare abstract class SkyHelpService {
      * Opens a globally accessible help dialog.
      * @param args The options for opening the help dialog.
      */
-    abstract openHelp(args: SkyHelpOpenArgs): void;
+    abstract openHelp(args?: SkyHelpOpenArgs): void;
+    /**
+     * Updates a globally accessible help dialog.
+     * @param args The options for updating the help dialog.
+     */
+    abstract updateHelp(args: SkyHelpUpdateArgs): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SkyHelpService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "11.0.0",
+  "version": "11.1.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -41,7 +41,7 @@
     "@angular/core": "^18.2.3",
     "@angular/platform-browser": "^18.2.3",
     "@angular/router": "^18.2.3",
-    "@skyux/i18n": "11.0.0"
+    "@skyux/i18n": "11.1.0"
   },
   "dependencies": {
     "tslib": "^2.6.3"

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

@@ -1,4 +1,4 @@
-import { SkyHelpOpenArgs, SkyHelpService } from '@skyux/core';
+import { SkyHelpOpenArgs, SkyHelpService, SkyHelpUpdateArgs } from '@skyux/core';
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
@@ -7,7 +7,8 @@ import * as i0 from "@angular/core";
 export declare class SkyHelpTestingService extends SkyHelpService {
     #private;
     get widgetReadyStateChange(): Observable<boolean>;
-    openHelp(args: SkyHelpOpenArgs): void;
+    openHelp(args?: SkyHelpOpenArgs): void;
+    updateHelp(args: SkyHelpUpdateArgs): void;
     getCurrentHelpKey(): string | undefined;
     closeHelp(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpTestingService, never>;