@itwin/appui-react 3.4.0-dev.57 → 3.4.0-dev.59

package/lib/esm/appui-react/messages/AppNotificationManager.d.ts

@@ -1,75 +1,75 @@
-/** @packageDocumentation
- * @module Notification
- */
-import { XAndY } from "@itwin/core-geometry";
-import { ActivityMessageDetails, ActivityMessageEndReason, MessageBoxIconType, MessageBoxType, MessageBoxValue, NotificationManager, NotifyMessageDetails, ToolAssistanceInstructions, ToolTipOptions } from "@itwin/core-frontend";
-import { RelativePosition } from "@itwin/appui-abstract";
-/**
- * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.
- * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.
- * @public
- */
-export declare class AppNotificationManager extends NotificationManager {
-    /** Output a prompt, given an i18n key.
-     */
-    outputPromptByKey(key: string): void;
-    /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.
-     */
-    outputPrompt(prompt: string): void;
-    /** Output a message and/or alert to the user. */
-    outputMessage(message: NotifyMessageDetails): void;
-    /** Output a MessageBox and wait for response from the user.
-     * @param mbType       The MessageBox type.
-     * @param message      The message to display.
-     * @param icon         The MessageBox icon type.
-     * @return the response from the user.
-     */
-    openMessageBox(mbType: MessageBoxType, message: HTMLElement | string, icon: MessageBoxIconType): Promise<MessageBoxValue>;
-    /**
-     * Set up for activity messages.
-     * @param details  The activity message details.
-     * @return true if the message was displayed, false if an invalid priority is specified.
-     */
-    setupActivityMessage(details: ActivityMessageDetails): boolean;
-    /**
-     * Output an activity message to the user.
-     * @param messageText      The message text.
-     * @param percentComplete  The percentage of completion.
-     * @return true if the message was displayed, false if the message could not be displayed.
-     */
-    outputActivityMessage(messageText: HTMLElement | string, percentComplete: number): boolean;
-    /**
-     * End an activity message.
-     * @param reason       Reason for the end of the Activity Message.
-     * @return true if the message was ended successfully, false if the activityMessage could not be ended.
-     */
-    endActivityMessage(reason: ActivityMessageEndReason): boolean;
-    /** Update message position created with [[OutputMessageType.Pointer]].
-     * @param displayPoint        Point at which to display the Pointer type message.
-     * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.
-     */
-    updatePointerMessage(displayPoint: XAndY, relativePosition: RelativePosition): void;
-    /** Hides the Pointer message. */
-    closePointerMessage(): void;
-    /** Return true if _showTooltip has an implementation and will display a tooltip. */
-    get isToolTipSupported(): boolean;
-    /** Return true if the tooltip is currently open. */
-    get isToolTipOpen(): boolean;
-    /** Clear the ToolTip if it is currently open. If not open, does nothing. */
-    clearToolTip(): void;
-    /** Show a ToolTip window.
-     * @param el       The HTMLElement that anchors the toolTip.
-     * @param message  The message to display inside the ToolTip
-     * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.
-     * @param options  Options that supply additional information about how the ToolTip should function.
-     */
-    protected _showToolTip(el: HTMLElement, message: HTMLElement | string, pt?: XAndY, options?: ToolTipOptions): void;
-    /** Hide a InputField message. */
-    closeInputFieldMessage(): void;
-    /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.
-     * @param instructions The tool assistance instructions.
-     * @public
-     */
-    setToolAssistance(instructions: ToolAssistanceInstructions | undefined): void;
-}
+/** @packageDocumentation
+ * @module Notification
+ */
+import { XAndY } from "@itwin/core-geometry";
+import { ActivityMessageDetails, ActivityMessageEndReason, MessageBoxIconType, MessageBoxType, MessageBoxValue, NotificationManager, NotifyMessageDetails, ToolAssistanceInstructions, ToolTipOptions } from "@itwin/core-frontend";
+import { RelativePosition } from "@itwin/appui-abstract";
+/**
+ * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.
+ * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.
+ * @public
+ */
+export declare class AppNotificationManager extends NotificationManager {
+    /** Output a prompt, given an i18n key.
+     */
+    outputPromptByKey(key: string): void;
+    /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.
+     */
+    outputPrompt(prompt: string): void;
+    /** Output a message and/or alert to the user. */
+    outputMessage(message: NotifyMessageDetails): void;
+    /** Output a MessageBox and wait for response from the user.
+     * @param mbType       The MessageBox type.
+     * @param message      The message to display.
+     * @param icon         The MessageBox icon type.
+     * @return the response from the user.
+     */
+    openMessageBox(mbType: MessageBoxType, message: HTMLElement | string, icon: MessageBoxIconType): Promise<MessageBoxValue>;
+    /**
+     * Set up for activity messages.
+     * @param details  The activity message details.
+     * @return true if the message was displayed, false if an invalid priority is specified.
+     */
+    setupActivityMessage(details: ActivityMessageDetails): boolean;
+    /**
+     * Output an activity message to the user.
+     * @param messageText      The message text.
+     * @param percentComplete  The percentage of completion.
+     * @return true if the message was displayed, false if the message could not be displayed.
+     */
+    outputActivityMessage(messageText: HTMLElement | string, percentComplete: number): boolean;
+    /**
+     * End an activity message.
+     * @param reason       Reason for the end of the Activity Message.
+     * @return true if the message was ended successfully, false if the activityMessage could not be ended.
+     */
+    endActivityMessage(reason: ActivityMessageEndReason): boolean;
+    /** Update message position created with [[OutputMessageType.Pointer]].
+     * @param displayPoint        Point at which to display the Pointer type message.
+     * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.
+     */
+    updatePointerMessage(displayPoint: XAndY, relativePosition: RelativePosition): void;
+    /** Hides the Pointer message. */
+    closePointerMessage(): void;
+    /** Return true if _showTooltip has an implementation and will display a tooltip. */
+    get isToolTipSupported(): boolean;
+    /** Return true if the tooltip is currently open. */
+    get isToolTipOpen(): boolean;
+    /** Clear the ToolTip if it is currently open. If not open, does nothing. */
+    clearToolTip(): void;
+    /** Show a ToolTip window.
+     * @param el       The HTMLElement that anchors the toolTip.
+     * @param message  The message to display inside the ToolTip
+     * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.
+     * @param options  Options that supply additional information about how the ToolTip should function.
+     */
+    protected _showToolTip(el: HTMLElement, message: HTMLElement | string, pt?: XAndY, options?: ToolTipOptions): void;
+    /** Hide a InputField message. */
+    closeInputFieldMessage(): void;
+    /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.
+     * @param instructions The tool assistance instructions.
+     * @public
+     */
+    setToolAssistance(instructions: ToolAssistanceInstructions | undefined): void;
+}
 //# sourceMappingURL=AppNotificationManager.d.ts.map

package/lib/esm/appui-react/messages/AppNotificationManager.js

@@ -1,122 +1,122 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Notification
- */
-import { ActivityMessageEndReason, NotificationManager, ToolAssistance, } from "@itwin/core-frontend";
-import { ElementTooltip } from "../feedback/ElementTooltip";
-import { UiFramework } from "../UiFramework";
-import { MessageManager } from "./MessageManager";
-import { PointerMessage } from "./Pointer";
-/**
- * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.
- * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.
- * @public
- */
-export class AppNotificationManager extends NotificationManager {
-    /** Output a prompt, given an i18n key.
-     */
-    outputPromptByKey(key) {
-        this.outputPrompt(UiFramework.localization.getLocalizedString(key));
-    }
-    /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.
-     */
-    outputPrompt(prompt) {
-        MessageManager.outputPrompt(prompt);
-        const mainInstruction = ToolAssistance.createInstruction("", prompt);
-        const instructions = ToolAssistance.createInstructions(mainInstruction);
-        MessageManager.setToolAssistance(instructions);
-    }
-    /** Output a message and/or alert to the user. */
-    outputMessage(message) {
-        MessageManager.outputMessage(message);
-    }
-    /** Output a MessageBox and wait for response from the user.
-     * @param mbType       The MessageBox type.
-     * @param message      The message to display.
-     * @param icon         The MessageBox icon type.
-     * @return the response from the user.
-     */
-    async openMessageBox(mbType, message, icon) {
-        return MessageManager.openMessageBox(mbType, message, icon);
-    }
-    /**
-     * Set up for activity messages.
-     * @param details  The activity message details.
-     * @return true if the message was displayed, false if an invalid priority is specified.
-     */
-    setupActivityMessage(details) {
-        return MessageManager.setupActivityMessageDetails(details);
-    }
-    /**
-     * Output an activity message to the user.
-     * @param messageText      The message text.
-     * @param percentComplete  The percentage of completion.
-     * @return true if the message was displayed, false if the message could not be displayed.
-     */
-    outputActivityMessage(messageText, percentComplete) {
-        return MessageManager.setupActivityMessageValues(messageText, percentComplete);
-    }
-    /**
-     * End an activity message.
-     * @param reason       Reason for the end of the Activity Message.
-     * @return true if the message was ended successfully, false if the activityMessage could not be ended.
-     */
-    endActivityMessage(reason) {
-        let result = false;
-        switch (reason) {
-            case ActivityMessageEndReason.Completed:
-                result = MessageManager.endActivityMessage(true);
-                break;
-            case ActivityMessageEndReason.Cancelled:
-                result = MessageManager.endActivityMessage(false);
-                break;
-        }
-        return result;
-    }
-    /** Update message position created with [[OutputMessageType.Pointer]].
-     * @param displayPoint        Point at which to display the Pointer type message.
-     * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.
-     */
-    updatePointerMessage(displayPoint, relativePosition) {
-        PointerMessage.updateMessage(displayPoint, relativePosition);
-    }
-    /** Hides the Pointer message. */
-    closePointerMessage() {
-        PointerMessage.hideMessage();
-    }
-    /** Return true if _showTooltip has an implementation and will display a tooltip. */
-    get isToolTipSupported() { return true; }
-    /** Return true if the tooltip is currently open. */
-    get isToolTipOpen() { return ElementTooltip.isTooltipVisible; }
-    /** Clear the ToolTip if it is currently open. If not open, does nothing. */
-    clearToolTip() {
-        // istanbul ignore else
-        if (this.isToolTipOpen)
-            ElementTooltip.hideTooltip();
-    }
-    /** Show a ToolTip window.
-     * @param el       The HTMLElement that anchors the toolTip.
-     * @param message  The message to display inside the ToolTip
-     * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.
-     * @param options  Options that supply additional information about how the ToolTip should function.
-     */
-    _showToolTip(el, message, pt, options) {
-        ElementTooltip.showTooltip(el, message, pt, options);
-    }
-    /** Hide a InputField message. */
-    closeInputFieldMessage() {
-        MessageManager.hideInputFieldMessage();
-    }
-    /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.
-     * @param instructions The tool assistance instructions.
-     * @public
-     */
-    setToolAssistance(instructions) {
-        MessageManager.outputPrompt(instructions ? instructions.mainInstruction.text : /* istanbul ignore next */ "");
-        MessageManager.setToolAssistance(instructions);
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Notification
+ */
+import { ActivityMessageEndReason, NotificationManager, ToolAssistance, } from "@itwin/core-frontend";
+import { ElementTooltip } from "../feedback/ElementTooltip";
+import { UiFramework } from "../UiFramework";
+import { MessageManager } from "./MessageManager";
+import { PointerMessage } from "./Pointer";
+/**
+ * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.
+ * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.
+ * @public
+ */
+export class AppNotificationManager extends NotificationManager {
+    /** Output a prompt, given an i18n key.
+     */
+    outputPromptByKey(key) {
+        this.outputPrompt(UiFramework.localization.getLocalizedString(key));
+    }
+    /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.
+     */
+    outputPrompt(prompt) {
+        MessageManager.outputPrompt(prompt);
+        const mainInstruction = ToolAssistance.createInstruction("", prompt);
+        const instructions = ToolAssistance.createInstructions(mainInstruction);
+        MessageManager.setToolAssistance(instructions);
+    }
+    /** Output a message and/or alert to the user. */
+    outputMessage(message) {
+        MessageManager.outputMessage(message);
+    }
+    /** Output a MessageBox and wait for response from the user.
+     * @param mbType       The MessageBox type.
+     * @param message      The message to display.
+     * @param icon         The MessageBox icon type.
+     * @return the response from the user.
+     */
+    async openMessageBox(mbType, message, icon) {
+        return MessageManager.openMessageBox(mbType, message, icon);
+    }
+    /**
+     * Set up for activity messages.
+     * @param details  The activity message details.
+     * @return true if the message was displayed, false if an invalid priority is specified.
+     */
+    setupActivityMessage(details) {
+        return MessageManager.setupActivityMessageDetails(details);
+    }
+    /**
+     * Output an activity message to the user.
+     * @param messageText      The message text.
+     * @param percentComplete  The percentage of completion.
+     * @return true if the message was displayed, false if the message could not be displayed.
+     */
+    outputActivityMessage(messageText, percentComplete) {
+        return MessageManager.setupActivityMessageValues(messageText, percentComplete);
+    }
+    /**
+     * End an activity message.
+     * @param reason       Reason for the end of the Activity Message.
+     * @return true if the message was ended successfully, false if the activityMessage could not be ended.
+     */
+    endActivityMessage(reason) {
+        let result = false;
+        switch (reason) {
+            case ActivityMessageEndReason.Completed:
+                result = MessageManager.endActivityMessage(true);
+                break;
+            case ActivityMessageEndReason.Cancelled:
+                result = MessageManager.endActivityMessage(false);
+                break;
+        }
+        return result;
+    }
+    /** Update message position created with [[OutputMessageType.Pointer]].
+     * @param displayPoint        Point at which to display the Pointer type message.
+     * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.
+     */
+    updatePointerMessage(displayPoint, relativePosition) {
+        PointerMessage.updateMessage(displayPoint, relativePosition);
+    }
+    /** Hides the Pointer message. */
+    closePointerMessage() {
+        PointerMessage.hideMessage();
+    }
+    /** Return true if _showTooltip has an implementation and will display a tooltip. */
+    get isToolTipSupported() { return true; }
+    /** Return true if the tooltip is currently open. */
+    get isToolTipOpen() { return ElementTooltip.isTooltipVisible; }
+    /** Clear the ToolTip if it is currently open. If not open, does nothing. */
+    clearToolTip() {
+        // istanbul ignore else
+        if (this.isToolTipOpen)
+            ElementTooltip.hideTooltip();
+    }
+    /** Show a ToolTip window.
+     * @param el       The HTMLElement that anchors the toolTip.
+     * @param message  The message to display inside the ToolTip
+     * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.
+     * @param options  Options that supply additional information about how the ToolTip should function.
+     */
+    _showToolTip(el, message, pt, options) {
+        ElementTooltip.showTooltip(el, message, pt, options);
+    }
+    /** Hide a InputField message. */
+    closeInputFieldMessage() {
+        MessageManager.hideInputFieldMessage();
+    }
+    /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.
+     * @param instructions The tool assistance instructions.
+     * @public
+     */
+    setToolAssistance(instructions) {
+        MessageManager.outputPrompt(instructions ? instructions.mainInstruction.text : /* istanbul ignore next */ "");
+        MessageManager.setToolAssistance(instructions);
+    }
+}
 //# sourceMappingURL=AppNotificationManager.js.map

package/lib/esm/appui-react/messages/AppNotificationManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppNotificationManager.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/AppNotificationManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACmB,wBAAwB,EAAuD,mBAAmB,EAC1H,cAAc,GACf,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAE7D;OACG;IACa,iBAAiB,CAAC,GAAW;QAC3C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;OACG;IACa,YAAY,CAAC,MAAc;QACzC,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAG,cAAc,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACrE,MAAM,YAAY,GAAG,cAAc,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACxE,cAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED,iDAAiD;IACjC,aAAa,CAAC,OAA6B;QACzD,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACa,KAAK,CAAC,cAAc,CAAC,MAAsB,EAAE,OAA6B,EAAE,IAAwB;QAClH,OAAO,cAAc,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACa,oBAAoB,CAAC,OAA+B;QAClE,OAAO,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACa,qBAAqB,CAAC,WAAiC,EAAE,eAAuB;QAC9F,OAAO,cAAc,CAAC,0BAA0B,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACa,kBAAkB,CAAC,MAAgC;QACjE,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,QAAQ,MAAM,EAAE;YACd,KAAK,wBAAwB,CAAC,SAAS;gBACrC,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBACjD,MAAM;YACR,KAAK,wBAAwB,CAAC,SAAS;gBACrC,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAClD,MAAM;SACT;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACa,oBAAoB,CAAC,YAAmB,EAAE,gBAAkC;QAC1F,cAAc,CAAC,aAAa,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IAED,iCAAiC;IACjB,mBAAmB;QACjC,cAAc,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;IAED,oFAAoF;IACpF,IAAoB,kBAAkB,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAElE,oDAAoD;IACpD,IAAoB,aAAa,KAAc,OAAO,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAExF,4EAA4E;IAC5D,YAAY;QAC1B,uBAAuB;QACvB,IAAI,IAAI,CAAC,aAAa;YACpB,cAAc,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACgB,YAAY,CAAC,EAAe,EAAE,OAA6B,EAAE,EAAU,EAAE,OAAwB;QAClH,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,iCAAiC;IACjB,sBAAsB;QACpC,cAAc,CAAC,qBAAqB,EAAE,CAAC;IACzC,CAAC;IAED;;;OAGG;IACa,iBAAiB,CAAC,YAAoD;QACpF,cAAc,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;QAC9G,cAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;CAEF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Notification\n */\n\nimport { XAndY } from \"@itwin/core-geometry\";\nimport {\n  ActivityMessageDetails, ActivityMessageEndReason, MessageBoxIconType, MessageBoxType, MessageBoxValue, NotificationManager, NotifyMessageDetails,\n  ToolAssistance, ToolAssistanceInstructions, ToolTipOptions,\n} from \"@itwin/core-frontend\";\nimport { RelativePosition } from \"@itwin/appui-abstract\";\nimport { ElementTooltip } from \"../feedback/ElementTooltip\";\nimport { UiFramework } from \"../UiFramework\";\nimport { MessageManager } from \"./MessageManager\";\nimport { PointerMessage } from \"./Pointer\";\n\n/**\n * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.\n * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.\n * @public\n */\nexport class AppNotificationManager extends NotificationManager {\n\n  /** Output a prompt, given an i18n key.\n   */\n  public override outputPromptByKey(key: string): void {\n    this.outputPrompt(UiFramework.localization.getLocalizedString(key));\n  }\n\n  /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.\n   */\n  public override outputPrompt(prompt: string): void {\n    MessageManager.outputPrompt(prompt);\n\n    const mainInstruction = ToolAssistance.createInstruction(\"\", prompt);\n    const instructions = ToolAssistance.createInstructions(mainInstruction);\n    MessageManager.setToolAssistance(instructions);\n  }\n\n  /** Output a message and/or alert to the user. */\n  public override outputMessage(message: NotifyMessageDetails): void {\n    MessageManager.outputMessage(message);\n  }\n\n  /** Output a MessageBox and wait for response from the user.\n   * @param mbType       The MessageBox type.\n   * @param message      The message to display.\n   * @param icon         The MessageBox icon type.\n   * @return the response from the user.\n   */\n  public override async openMessageBox(mbType: MessageBoxType, message: HTMLElement | string, icon: MessageBoxIconType): Promise<MessageBoxValue> {\n    return MessageManager.openMessageBox(mbType, message, icon);\n  }\n\n  /**\n   * Set up for activity messages.\n   * @param details  The activity message details.\n   * @return true if the message was displayed, false if an invalid priority is specified.\n   */\n  public override setupActivityMessage(details: ActivityMessageDetails): boolean {\n    return MessageManager.setupActivityMessageDetails(details);\n  }\n\n  /**\n   * Output an activity message to the user.\n   * @param messageText      The message text.\n   * @param percentComplete  The percentage of completion.\n   * @return true if the message was displayed, false if the message could not be displayed.\n   */\n  public override outputActivityMessage(messageText: HTMLElement | string, percentComplete: number): boolean {\n    return MessageManager.setupActivityMessageValues(messageText, percentComplete);\n  }\n\n  /**\n   * End an activity message.\n   * @param reason       Reason for the end of the Activity Message.\n   * @return true if the message was ended successfully, false if the activityMessage could not be ended.\n   */\n  public override endActivityMessage(reason: ActivityMessageEndReason): boolean {\n    let result = false;\n\n    switch (reason) {\n      case ActivityMessageEndReason.Completed:\n        result = MessageManager.endActivityMessage(true);\n        break;\n      case ActivityMessageEndReason.Cancelled:\n        result = MessageManager.endActivityMessage(false);\n        break;\n    }\n\n    return result;\n  }\n\n  /** Update message position created with [[OutputMessageType.Pointer]].\n   * @param displayPoint        Point at which to display the Pointer type message.\n   * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.\n   */\n  public override updatePointerMessage(displayPoint: XAndY, relativePosition: RelativePosition): void {\n    PointerMessage.updateMessage(displayPoint, relativePosition);\n  }\n\n  /** Hides the Pointer message. */\n  public override closePointerMessage(): void {\n    PointerMessage.hideMessage();\n  }\n\n  /** Return true if _showTooltip has an implementation and will display a tooltip. */\n  public override get isToolTipSupported(): boolean { return true; }\n\n  /** Return true if the tooltip is currently open. */\n  public override get isToolTipOpen(): boolean { return ElementTooltip.isTooltipVisible; }\n\n  /** Clear the ToolTip if it is currently open. If not open, does nothing. */\n  public override clearToolTip(): void {\n    // istanbul ignore else\n    if (this.isToolTipOpen)\n      ElementTooltip.hideTooltip();\n  }\n\n  /** Show a ToolTip window.\n   * @param el       The HTMLElement that anchors the toolTip.\n   * @param message  The message to display inside the ToolTip\n   * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.\n   * @param options  Options that supply additional information about how the ToolTip should function.\n   */\n  protected override _showToolTip(el: HTMLElement, message: HTMLElement | string, pt?: XAndY, options?: ToolTipOptions): void {\n    ElementTooltip.showTooltip(el, message, pt, options);\n  }\n\n  /** Hide a InputField message. */\n  public override closeInputFieldMessage(): void {\n    MessageManager.hideInputFieldMessage();\n  }\n\n  /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.\n   * @param instructions The tool assistance instructions.\n   * @public\n   */\n  public override setToolAssistance(instructions: ToolAssistanceInstructions | undefined) {\n    MessageManager.outputPrompt(instructions ? instructions.mainInstruction.text : /* istanbul ignore next */ \"\");\n    MessageManager.setToolAssistance(instructions);\n  }\n\n}\n"]}
+{"version":3,"file":"AppNotificationManager.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/AppNotificationManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACmB,wBAAwB,EAAuD,mBAAmB,EAC1H,cAAc,GACf,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAE7D;OACG;IACa,iBAAiB,CAAC,GAAW;QAC3C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;OACG;IACa,YAAY,CAAC,MAAc;QACzC,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAG,cAAc,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACrE,MAAM,YAAY,GAAG,cAAc,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACxE,cAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED,iDAAiD;IACjC,aAAa,CAAC,OAA6B;QACzD,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACa,KAAK,CAAC,cAAc,CAAC,MAAsB,EAAE,OAA6B,EAAE,IAAwB;QAClH,OAAO,cAAc,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACa,oBAAoB,CAAC,OAA+B;QAClE,OAAO,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACa,qBAAqB,CAAC,WAAiC,EAAE,eAAuB;QAC9F,OAAO,cAAc,CAAC,0BAA0B,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACa,kBAAkB,CAAC,MAAgC;QACjE,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,QAAQ,MAAM,EAAE;YACd,KAAK,wBAAwB,CAAC,SAAS;gBACrC,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBACjD,MAAM;YACR,KAAK,wBAAwB,CAAC,SAAS;gBACrC,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAClD,MAAM;SACT;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACa,oBAAoB,CAAC,YAAmB,EAAE,gBAAkC;QAC1F,cAAc,CAAC,aAAa,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IAED,iCAAiC;IACjB,mBAAmB;QACjC,cAAc,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;IAED,oFAAoF;IACpF,IAAoB,kBAAkB,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAElE,oDAAoD;IACpD,IAAoB,aAAa,KAAc,OAAO,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAExF,4EAA4E;IAC5D,YAAY;QAC1B,uBAAuB;QACvB,IAAI,IAAI,CAAC,aAAa;YACpB,cAAc,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACgB,YAAY,CAAC,EAAe,EAAE,OAA6B,EAAE,EAAU,EAAE,OAAwB;QAClH,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,iCAAiC;IACjB,sBAAsB;QACpC,cAAc,CAAC,qBAAqB,EAAE,CAAC;IACzC,CAAC;IAED;;;OAGG;IACa,iBAAiB,CAAC,YAAoD;QACpF,cAAc,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;QAC9G,cAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;CAEF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Notification\r\n */\r\n\r\nimport { XAndY } from \"@itwin/core-geometry\";\r\nimport {\r\n  ActivityMessageDetails, ActivityMessageEndReason, MessageBoxIconType, MessageBoxType, MessageBoxValue, NotificationManager, NotifyMessageDetails,\r\n  ToolAssistance, ToolAssistanceInstructions, ToolTipOptions,\r\n} from \"@itwin/core-frontend\";\r\nimport { RelativePosition } from \"@itwin/appui-abstract\";\r\nimport { ElementTooltip } from \"../feedback/ElementTooltip\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { MessageManager } from \"./MessageManager\";\r\nimport { PointerMessage } from \"./Pointer\";\r\n\r\n/**\r\n * The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend.\r\n * This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.\r\n * @public\r\n */\r\nexport class AppNotificationManager extends NotificationManager {\r\n\r\n  /** Output a prompt, given an i18n key.\r\n   */\r\n  public override outputPromptByKey(key: string): void {\r\n    this.outputPrompt(UiFramework.localization.getLocalizedString(key));\r\n  }\r\n\r\n  /** Output a prompt to the user. A 'prompt' indicates an action the user should take to proceed.\r\n   */\r\n  public override outputPrompt(prompt: string): void {\r\n    MessageManager.outputPrompt(prompt);\r\n\r\n    const mainInstruction = ToolAssistance.createInstruction(\"\", prompt);\r\n    const instructions = ToolAssistance.createInstructions(mainInstruction);\r\n    MessageManager.setToolAssistance(instructions);\r\n  }\r\n\r\n  /** Output a message and/or alert to the user. */\r\n  public override outputMessage(message: NotifyMessageDetails): void {\r\n    MessageManager.outputMessage(message);\r\n  }\r\n\r\n  /** Output a MessageBox and wait for response from the user.\r\n   * @param mbType       The MessageBox type.\r\n   * @param message      The message to display.\r\n   * @param icon         The MessageBox icon type.\r\n   * @return the response from the user.\r\n   */\r\n  public override async openMessageBox(mbType: MessageBoxType, message: HTMLElement | string, icon: MessageBoxIconType): Promise<MessageBoxValue> {\r\n    return MessageManager.openMessageBox(mbType, message, icon);\r\n  }\r\n\r\n  /**\r\n   * Set up for activity messages.\r\n   * @param details  The activity message details.\r\n   * @return true if the message was displayed, false if an invalid priority is specified.\r\n   */\r\n  public override setupActivityMessage(details: ActivityMessageDetails): boolean {\r\n    return MessageManager.setupActivityMessageDetails(details);\r\n  }\r\n\r\n  /**\r\n   * Output an activity message to the user.\r\n   * @param messageText      The message text.\r\n   * @param percentComplete  The percentage of completion.\r\n   * @return true if the message was displayed, false if the message could not be displayed.\r\n   */\r\n  public override outputActivityMessage(messageText: HTMLElement | string, percentComplete: number): boolean {\r\n    return MessageManager.setupActivityMessageValues(messageText, percentComplete);\r\n  }\r\n\r\n  /**\r\n   * End an activity message.\r\n   * @param reason       Reason for the end of the Activity Message.\r\n   * @return true if the message was ended successfully, false if the activityMessage could not be ended.\r\n   */\r\n  public override endActivityMessage(reason: ActivityMessageEndReason): boolean {\r\n    let result = false;\r\n\r\n    switch (reason) {\r\n      case ActivityMessageEndReason.Completed:\r\n        result = MessageManager.endActivityMessage(true);\r\n        break;\r\n      case ActivityMessageEndReason.Cancelled:\r\n        result = MessageManager.endActivityMessage(false);\r\n        break;\r\n    }\r\n\r\n    return result;\r\n  }\r\n\r\n  /** Update message position created with [[OutputMessageType.Pointer]].\r\n   * @param displayPoint        Point at which to display the Pointer type message.\r\n   * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.\r\n   */\r\n  public override updatePointerMessage(displayPoint: XAndY, relativePosition: RelativePosition): void {\r\n    PointerMessage.updateMessage(displayPoint, relativePosition);\r\n  }\r\n\r\n  /** Hides the Pointer message. */\r\n  public override closePointerMessage(): void {\r\n    PointerMessage.hideMessage();\r\n  }\r\n\r\n  /** Return true if _showTooltip has an implementation and will display a tooltip. */\r\n  public override get isToolTipSupported(): boolean { return true; }\r\n\r\n  /** Return true if the tooltip is currently open. */\r\n  public override get isToolTipOpen(): boolean { return ElementTooltip.isTooltipVisible; }\r\n\r\n  /** Clear the ToolTip if it is currently open. If not open, does nothing. */\r\n  public override clearToolTip(): void {\r\n    // istanbul ignore else\r\n    if (this.isToolTipOpen)\r\n      ElementTooltip.hideTooltip();\r\n  }\r\n\r\n  /** Show a ToolTip window.\r\n   * @param el       The HTMLElement that anchors the toolTip.\r\n   * @param message  The message to display inside the ToolTip\r\n   * @param pt       An optional location, relative to the origin of el, for the ToolTip. If undefined, center of el.\r\n   * @param options  Options that supply additional information about how the ToolTip should function.\r\n   */\r\n  protected override _showToolTip(el: HTMLElement, message: HTMLElement | string, pt?: XAndY, options?: ToolTipOptions): void {\r\n    ElementTooltip.showTooltip(el, message, pt, options);\r\n  }\r\n\r\n  /** Hide a InputField message. */\r\n  public override closeInputFieldMessage(): void {\r\n    MessageManager.hideInputFieldMessage();\r\n  }\r\n\r\n  /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.\r\n   * @param instructions The tool assistance instructions.\r\n   * @public\r\n   */\r\n  public override setToolAssistance(instructions: ToolAssistanceInstructions | undefined) {\r\n    MessageManager.outputPrompt(instructions ? instructions.mainInstruction.text : /* istanbul ignore next */ \"\");\r\n    MessageManager.setToolAssistance(instructions);\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/messages/HollowIcon.d.ts

@@ -1,10 +1,10 @@
-/** @packageDocumentation
- * @module Notification
- */
-/// <reference types="react" />
-import { IconProps } from "@itwin/core-react";
-/** Icon for Message
- * @internal
- */
-export declare function HollowIcon(props: IconProps): JSX.Element;
+/** @packageDocumentation
+ * @module Notification
+ */
+/// <reference types="react" />
+import { IconProps } from "@itwin/core-react";
+/** Icon for Message
+ * @internal
+ */
+export declare function HollowIcon(props: IconProps): JSX.Element;
 //# sourceMappingURL=HollowIcon.d.ts.map

package/lib/esm/appui-react/messages/HollowIcon.js

@@ -1,17 +1,17 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Notification
- */
-import * as React from "react";
-import { Icon } from "@itwin/core-react";
-/** Icon for Message
- * @internal
- */
-export function HollowIcon(props) {
-    return (React.createElement("span", { className: "uifw-statusbar-hollow-icon" },
-        React.createElement(Icon, { ...props })));
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Notification
+ */
+import * as React from "react";
+import { Icon } from "@itwin/core-react";
+/** Icon for Message
+ * @internal
+ */
+export function HollowIcon(props) {
+    return (React.createElement("span", { className: "uifw-statusbar-hollow-icon" },
+        React.createElement(Icon, { ...props })));
+}
 //# sourceMappingURL=HollowIcon.js.map

package/lib/esm/appui-react/messages/HollowIcon.js.map

@@ -1 +1 @@
-{"version":3,"file":"HollowIcon.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/HollowIcon.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAa,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,KAAgB;IACzC,OAAO,CACL,8BAAM,SAAS,EAAC,4BAA4B;QAC1C,oBAAC,IAAI,OAAK,KAAK,GAAI,CACd,CACR,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Notification\n */\n\nimport * as React from \"react\";\nimport { Icon, IconProps } from \"@itwin/core-react\";\n\n/** Icon for Message\n * @internal\n */\nexport function HollowIcon(props: IconProps) {\n  return (\n    <span className=\"uifw-statusbar-hollow-icon\">\n      <Icon {...props} />\n    </span>\n  );\n}\n"]}
+{"version":3,"file":"HollowIcon.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/HollowIcon.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAa,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,KAAgB;IACzC,OAAO,CACL,8BAAM,SAAS,EAAC,4BAA4B;QAC1C,oBAAC,IAAI,OAAK,KAAK,GAAI,CACd,CACR,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Notification\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Icon, IconProps } from \"@itwin/core-react\";\r\n\r\n/** Icon for Message\r\n * @internal\r\n */\r\nexport function HollowIcon(props: IconProps) {\r\n  return (\r\n    <span className=\"uifw-statusbar-hollow-icon\">\r\n      <Icon {...props} />\r\n    </span>\r\n  );\r\n}\r\n"]}

package/lib/esm/appui-react/messages/InputField.d.ts

@@ -1,38 +1,38 @@
-/** @packageDocumentation
- * @module Notification
- */
-import "./InputField.scss";
-import * as React from "react";
-import { OutputMessagePriority } from "@itwin/core-frontend";
-import { NotifyMessageType } from "./ReactNotifyMessageDetails";
-/** Properties of [[InputFieldMessage]] component.
- * @public
- */
-interface InputFieldMessageProps {
-    showCloseButton?: boolean;
-}
-/** [[InputFieldMessage]] state.
- * @internal
- */
-interface InputFieldMessageState {
-    isVisible: boolean;
-    priority: OutputMessagePriority;
-    message: NotifyMessageType;
-    detailedMessage?: NotifyMessageType;
-    inputFieldElement?: HTMLElement;
-    showCloseButton?: boolean;
-}
-/** InputField message pops up near pointer when attempting an invalid interaction.
- * @public
- */
-export declare class InputFieldMessage extends React.PureComponent<InputFieldMessageProps, InputFieldMessageState> {
-    readonly state: Readonly<InputFieldMessageState>;
-    render(): React.ReactNode;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    private _onInputMessageClose;
-    private _handleInputFieldMessageAddedEvent;
-    private _handleInputFieldMessageRemovedEvent;
-}
-export {};
+/** @packageDocumentation
+ * @module Notification
+ */
+import "./InputField.scss";
+import * as React from "react";
+import { OutputMessagePriority } from "@itwin/core-frontend";
+import { NotifyMessageType } from "./ReactNotifyMessageDetails";
+/** Properties of [[InputFieldMessage]] component.
+ * @public
+ */
+interface InputFieldMessageProps {
+    showCloseButton?: boolean;
+}
+/** [[InputFieldMessage]] state.
+ * @internal
+ */
+interface InputFieldMessageState {
+    isVisible: boolean;
+    priority: OutputMessagePriority;
+    message: NotifyMessageType;
+    detailedMessage?: NotifyMessageType;
+    inputFieldElement?: HTMLElement;
+    showCloseButton?: boolean;
+}
+/** InputField message pops up near pointer when attempting an invalid interaction.
+ * @public
+ */
+export declare class InputFieldMessage extends React.PureComponent<InputFieldMessageProps, InputFieldMessageState> {
+    readonly state: Readonly<InputFieldMessageState>;
+    render(): React.ReactNode;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _onInputMessageClose;
+    private _handleInputFieldMessageAddedEvent;
+    private _handleInputFieldMessageRemovedEvent;
+}
+export {};
 //# sourceMappingURL=InputField.d.ts.map