@itwin/appui-react 4.0.0-dev.9 → 4.0.0

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutMenu.js

@@ -1,91 +1,92 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import * as React from "react";
-import { ContextMenuItem, ContextSubMenu, GlobalContextMenu } from "@itwin/core-react";
-import { ConditionalBooleanValue, UiEvent } from "@itwin/appui-abstract";
-/** KeyboardShortcut Menu Event class.
- * @public
- */
-export class KeyboardShortcutMenuEvent extends UiEvent {
-}
-/** React component that displays a context menu at the cursor containing keyboard shortcuts.
- * @public
- */
-export class KeyboardShortcutMenu extends React.PureComponent {
-    constructor() {
-        super(...arguments);
-        /** @internal */
-        this.state = {
-            menuVisible: false,
-            menuX: 0,
-            menuY: 0,
-        };
-        this._handleKeyboardShortcutMenuEvent = (state) => {
-            this.setState(state);
-        };
-        this._hideContextMenu = () => {
-            this.setState({ menuVisible: false, shortcuts: undefined });
-        };
-        this._itemPicked = (shortcut) => {
-            this._hideContextMenu();
-            shortcut.itemPicked();
-        };
-    }
-    componentDidMount() {
-        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(this._handleKeyboardShortcutMenuEvent);
-    }
-    componentWillUnmount() {
-        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(this._handleKeyboardShortcutMenuEvent);
-    }
-    render() {
-        const { shortcuts, menuX, menuY, menuVisible } = this.state;
-        const onClose = this._hideContextMenu;
-        if (menuVisible) {
-            const items = this.getShortcutMenuItems(shortcuts);
-            return (React.createElement(GlobalContextMenu, { className: this.props.className, style: this.props.style, identifier: "keyboard-shortcuts", x: menuX, y: menuY, opened: menuVisible, onEsc: onClose, onOutsideClick: onClose, edgeLimit: false, autoflip: true, ignoreNextKeyUp: true }, items));
-        }
-        return null;
-    }
-    getShortcutMenuItems(shortcuts) {
-        const items = [];
-        // istanbul ignore else
-        if (shortcuts) {
-            shortcuts.forEach((shortcut, index) => {
-                const item = this.getShortcutMenuItem(shortcut, index);
-                // istanbul ignore else
-                if (item)
-                    items.push(item);
-            });
-        }
-        return items;
-    }
-    getShortcutMenuItem(shortcut, index) {
-        const shortcutKey = shortcut.key;
-        const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);
-        // Only pure characters go into the context menu
-        if (shortcutKey !== shortcut.keyMapKey || shortcut.isFunctionKey || shortcut.isSpecialKey || isHidden)
-            return null;
-        let node = null;
-        let label = shortcut.label;
-        const iconSpec = shortcut.iconSpec;
-        label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;
-        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
-            const shortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
-            const items = this.getShortcutMenuItems(shortcuts);
-            node = (React.createElement(ContextSubMenu, { key: index, icon: iconSpec, label: label, disabled: shortcut.isDisabled }, items));
-        }
-        else {
-            const sel = () => this._itemPicked(shortcut);
-            node = (React.createElement(ContextMenuItem, { key: index, onSelect: sel, icon: iconSpec, disabled: shortcut.isDisabled }, label));
-        }
-        return node;
-    }
-}
-/** Get KeyboardShortcut Menu Event. */
-KeyboardShortcutMenu.onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent();
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import * as React from "react";
+import { ContextMenuItem, ContextSubMenu, GlobalContextMenu } from "@itwin/core-react";
+import { ConditionalBooleanValue, UiEvent } from "@itwin/appui-abstract";
+/** KeyboardShortcut Menu Event class.
+ * @public
+ */
+export class KeyboardShortcutMenuEvent extends UiEvent {
+}
+/** React component that displays a context menu at the cursor containing keyboard shortcuts.
+ * @public
+ */
+class KeyboardShortcutMenu extends React.PureComponent {
+    constructor() {
+        super(...arguments);
+        /** @internal */
+        this.state = {
+            menuVisible: false,
+            menuX: 0,
+            menuY: 0,
+        };
+        this._handleKeyboardShortcutMenuEvent = (state) => {
+            this.setState(state);
+        };
+        this._hideContextMenu = () => {
+            this.setState({ menuVisible: false, shortcuts: undefined });
+        };
+        this._itemPicked = (shortcut) => {
+            this._hideContextMenu();
+            shortcut.itemPicked();
+        };
+    }
+    componentDidMount() {
+        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(this._handleKeyboardShortcutMenuEvent);
+    }
+    componentWillUnmount() {
+        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(this._handleKeyboardShortcutMenuEvent);
+    }
+    render() {
+        const { shortcuts, menuX, menuY, menuVisible } = this.state;
+        const onClose = this._hideContextMenu;
+        if (menuVisible) {
+            const items = this.getShortcutMenuItems(shortcuts);
+            return (React.createElement(GlobalContextMenu, { className: this.props.className, style: this.props.style, identifier: "keyboard-shortcuts", x: menuX, y: menuY, opened: menuVisible, onEsc: onClose, onOutsideClick: onClose, edgeLimit: false, autoflip: true, ignoreNextKeyUp: true }, items));
+        }
+        return null;
+    }
+    getShortcutMenuItems(shortcuts) {
+        const items = [];
+        // istanbul ignore else
+        if (shortcuts) {
+            shortcuts.forEach((shortcut, index) => {
+                const item = this.getShortcutMenuItem(shortcut, index);
+                // istanbul ignore else
+                if (item)
+                    items.push(item);
+            });
+        }
+        return items;
+    }
+    getShortcutMenuItem(shortcut, index) {
+        const shortcutKey = shortcut.key;
+        const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);
+        // Only pure characters go into the context menu
+        if (shortcutKey !== shortcut.keyMapKey || shortcut.isFunctionKey || shortcut.isSpecialKey || isHidden)
+            return null;
+        let node = null;
+        let label = shortcut.label;
+        const iconSpec = shortcut.iconSpec;
+        label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;
+        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
+            const shortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
+            const items = this.getShortcutMenuItems(shortcuts);
+            node = (React.createElement(ContextSubMenu, { key: index, icon: iconSpec, label: label, disabled: shortcut.isDisabled }, items));
+        }
+        else {
+            const sel = () => this._itemPicked(shortcut);
+            node = (React.createElement(ContextMenuItem, { key: index, onSelect: sel, icon: iconSpec, disabled: shortcut.isDisabled }, label));
+        }
+        return node;
+    }
+}
+/** Get KeyboardShortcut Menu Event. */
+KeyboardShortcutMenu.onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent();
+export { KeyboardShortcutMenu };
 //# sourceMappingURL=KeyboardShortcutMenu.js.map

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutMenu.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcutMenu.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAe,eAAe,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpG,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYzE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAkC;CAAI;AAErF;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK,CAAC,aAAqD;IAArG;;QAEE,gBAAgB;QACS,UAAK,GAA8B;YAC1D,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;SACT,CAAC;QAaM,qCAAgC,GAAG,CAAC,KAAgC,EAAE,EAAE;YAC9E,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QAkFM,qBAAgB,GAAG,GAAG,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEM,gBAAW,GAAG,CAAC,QAA0B,EAAQ,EAAE;YACzD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;IApGiB,iBAAiB;QAC/B,oBAAoB,CAAC,2BAA2B,CAAC,WAAW,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACtG,CAAC;IAEe,oBAAoB;QAClC,oBAAoB,CAAC,2BAA2B,CAAC,cAAc,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACzG,CAAC;IAMe,MAAM;QACpB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEtC,IAAI,WAAW,EAAE;YACf,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,OAAO,CACL,oBAAC,iBAAiB,IAChB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,UAAU,EAAC,oBAAoB,EAC/B,CAAC,EAAE,KAAK,EACR,CAAC,EAAE,KAAK,EACR,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,OAAO,EACvB,SAAS,EAAE,KAAK,EAChB,QAAQ,EAAE,IAAI,EACd,eAAe,EAAE,IAAI,IAEpB,KAAK,CACY,CACrB,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAAC,SAA8B;QACzD,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,uBAAuB;QACvB,IAAI,SAAS,EAAE;YACb,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,KAAa,EAAE,EAAE;gBAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvD,uBAAuB;gBACvB,IAAI,IAAI;oBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,mBAAmB,CAAC,QAA0B,EAAE,KAAa;QACnE,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAErE,gDAAgD;QAChD,IAAI,WAAW,KAAK,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ;YACnG,OAAO,IAAI,CAAC;QAEd,IAAI,IAAI,GAAoB,IAAI,CAAC;QACjC,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAEnC,KAAK,GAAG,IAAI,WAAW,CAAC,iBAAiB,EAAE,IAAI,KAAK,EAAE,CAAC;QAEvD,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,SAAS,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,IAAI,GAAG,CACL,oBAAC,cAAc,IAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,IACpF,KAAK,CACS,CAClB,CAAC;SACH;aAAM;YACL,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,GAAG,CACL,oBAAC,eAAe,IAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,IACtF,KAAK,CACU,CACnB,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA7FD,uCAAuC;AAChB,gDAA2B,GAAG,IAAI,yBAAyB,EAAE,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 KeyboardShortcut\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps, ContextMenuItem, ContextSubMenu, GlobalContextMenu } from \"@itwin/core-react\";\r\nimport { KeyboardShortcut } from \"./KeyboardShortcut\";\r\nimport { ConditionalBooleanValue, UiEvent } from \"@itwin/appui-abstract\";\r\n\r\n/** State for a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component\r\n * @public\r\n */\r\nexport interface KeyboardShortcutMenuState {\r\n  menuVisible: boolean;\r\n  menuX: number;\r\n  menuY: number;\r\n  shortcuts?: KeyboardShortcut[];\r\n}\r\n\r\n/** KeyboardShortcut Menu Event class.\r\n * @public\r\n */\r\nexport class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> { }\r\n\r\n/** React component that displays a context menu at the cursor containing keyboard shortcuts.\r\n * @public\r\n */\r\nexport class KeyboardShortcutMenu extends React.PureComponent<CommonProps, KeyboardShortcutMenuState> {\r\n\r\n  /** @internal */\r\n  public override readonly state: KeyboardShortcutMenuState = {\r\n    menuVisible: false,\r\n    menuX: 0,\r\n    menuY: 0,\r\n  };\r\n\r\n  /** Get KeyboardShortcut Menu Event. */\r\n  public static readonly onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent();\r\n\r\n  public override componentDidMount() {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(this._handleKeyboardShortcutMenuEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(this._handleKeyboardShortcutMenuEvent);\r\n  }\r\n\r\n  private _handleKeyboardShortcutMenuEvent = (state: KeyboardShortcutMenuState) => {\r\n    this.setState(state);\r\n  };\r\n\r\n  public override render(): React.ReactNode {\r\n    const { shortcuts, menuX, menuY, menuVisible } = this.state;\r\n    const onClose = this._hideContextMenu;\r\n\r\n    if (menuVisible) {\r\n      const items = this.getShortcutMenuItems(shortcuts);\r\n\r\n      return (\r\n        <GlobalContextMenu\r\n          className={this.props.className}\r\n          style={this.props.style}\r\n          identifier=\"keyboard-shortcuts\"\r\n          x={menuX}\r\n          y={menuY}\r\n          opened={menuVisible}\r\n          onEsc={onClose}\r\n          onOutsideClick={onClose}\r\n          edgeLimit={false}\r\n          autoflip={true}\r\n          ignoreNextKeyUp={true}  // Executing the shortcut on the keydown, so ignore the keyup in the menu\r\n        >\r\n          {items}\r\n        </GlobalContextMenu>\r\n      );\r\n    }\r\n\r\n    return null;\r\n  }\r\n\r\n  private getShortcutMenuItems(shortcuts?: KeyboardShortcut[]): React.ReactNode[] {\r\n    const items: React.ReactNode[] = [];\r\n\r\n    // istanbul ignore else\r\n    if (shortcuts) {\r\n      shortcuts.forEach((shortcut: KeyboardShortcut, index: number) => {\r\n        const item = this.getShortcutMenuItem(shortcut, index);\r\n        // istanbul ignore else\r\n        if (item)\r\n          items.push(item);\r\n      });\r\n    }\r\n\r\n    return items;\r\n  }\r\n\r\n  private getShortcutMenuItem(shortcut: KeyboardShortcut, index: number): React.ReactNode {\r\n    const shortcutKey = shortcut.key;\r\n    const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);\r\n\r\n    // Only pure characters go into the context menu\r\n    if (shortcutKey !== shortcut.keyMapKey || shortcut.isFunctionKey || shortcut.isSpecialKey || isHidden)\r\n      return null;\r\n\r\n    let node: React.ReactNode = null;\r\n    let label = shortcut.label;\r\n    const iconSpec = shortcut.iconSpec;\r\n\r\n    label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;\r\n\r\n    if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\r\n      const shortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\r\n      const items = this.getShortcutMenuItems(shortcuts);\r\n\r\n      node = (\r\n        <ContextSubMenu key={index} icon={iconSpec} label={label} disabled={shortcut.isDisabled}>\r\n          {items}\r\n        </ContextSubMenu>\r\n      );\r\n    } else {\r\n      const sel = () => this._itemPicked(shortcut);\r\n      node = (\r\n        <ContextMenuItem key={index} onSelect={sel} icon={iconSpec} disabled={shortcut.isDisabled}>\r\n          {label}\r\n        </ContextMenuItem>\r\n      );\r\n    }\r\n\r\n    return node;\r\n  }\r\n\r\n  private _hideContextMenu = () => {\r\n    this.setState({ menuVisible: false, shortcuts: undefined });\r\n  };\r\n\r\n  private _itemPicked = (shortcut: KeyboardShortcut): void => {\r\n    this._hideContextMenu();\r\n    shortcut.itemPicked();\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"KeyboardShortcutMenu.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAe,eAAe,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpG,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYzE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAkC;CAAI;AAErF;;GAEG;AACH,MAAa,oBAAqB,SAAQ,KAAK,CAAC,aAAqD;IAArG;;QAEE,gBAAgB;QACS,UAAK,GAA8B;YAC1D,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;SACT,CAAC;QAaM,qCAAgC,GAAG,CAAC,KAAgC,EAAE,EAAE;YAC9E,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QAkFM,qBAAgB,GAAG,GAAG,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEM,gBAAW,GAAG,CAAC,QAA0B,EAAQ,EAAE;YACzD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;IApGiB,iBAAiB;QAC/B,oBAAoB,CAAC,2BAA2B,CAAC,WAAW,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACtG,CAAC;IAEe,oBAAoB;QAClC,oBAAoB,CAAC,2BAA2B,CAAC,cAAc,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACzG,CAAC;IAMe,MAAM;QACpB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEtC,IAAI,WAAW,EAAE;YACf,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,OAAO,CACL,oBAAC,iBAAiB,IAChB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,UAAU,EAAC,oBAAoB,EAC/B,CAAC,EAAE,KAAK,EACR,CAAC,EAAE,KAAK,EACR,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,OAAO,EACvB,SAAS,EAAE,KAAK,EAChB,QAAQ,EAAE,IAAI,EACd,eAAe,EAAE,IAAI,IAEpB,KAAK,CACY,CACrB,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAAC,SAA8B;QACzD,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,uBAAuB;QACvB,IAAI,SAAS,EAAE;YACb,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,KAAa,EAAE,EAAE;gBAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvD,uBAAuB;gBACvB,IAAI,IAAI;oBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,mBAAmB,CAAC,QAA0B,EAAE,KAAa;QACnE,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAErE,gDAAgD;QAChD,IAAI,WAAW,KAAK,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ;YACnG,OAAO,IAAI,CAAC;QAEd,IAAI,IAAI,GAAoB,IAAI,CAAC;QACjC,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAEnC,KAAK,GAAG,IAAI,WAAW,CAAC,iBAAiB,EAAE,IAAI,KAAK,EAAE,CAAC;QAEvD,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,SAAS,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,IAAI,GAAG,CACL,oBAAC,cAAc,IAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,IACpF,KAAK,CACS,CAClB,CAAC;SACH;aAAM;YACL,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,GAAG,CACL,oBAAC,eAAe,IAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,IACtF,KAAK,CACU,CACnB,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA7FD,uCAAuC;AAChB,gDAA2B,GAAG,IAAI,yBAAyB,EAAE,AAAlC,CAAmC;SAV1E,oBAAoB","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 KeyboardShortcut\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps, ContextMenuItem, ContextSubMenu, GlobalContextMenu } from \"@itwin/core-react\";\r\nimport { KeyboardShortcut } from \"./KeyboardShortcut\";\r\nimport { ConditionalBooleanValue, UiEvent } from \"@itwin/appui-abstract\";\r\n\r\n/** State for a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component\r\n * @public\r\n */\r\nexport interface KeyboardShortcutMenuState {\r\n  menuVisible: boolean;\r\n  menuX: number;\r\n  menuY: number;\r\n  shortcuts?: KeyboardShortcut[];\r\n}\r\n\r\n/** KeyboardShortcut Menu Event class.\r\n * @public\r\n */\r\nexport class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> { }\r\n\r\n/** React component that displays a context menu at the cursor containing keyboard shortcuts.\r\n * @public\r\n */\r\nexport class KeyboardShortcutMenu extends React.PureComponent<CommonProps, KeyboardShortcutMenuState> {\r\n\r\n  /** @internal */\r\n  public override readonly state: KeyboardShortcutMenuState = {\r\n    menuVisible: false,\r\n    menuX: 0,\r\n    menuY: 0,\r\n  };\r\n\r\n  /** Get KeyboardShortcut Menu Event. */\r\n  public static readonly onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent();\r\n\r\n  public override componentDidMount() {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(this._handleKeyboardShortcutMenuEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(this._handleKeyboardShortcutMenuEvent);\r\n  }\r\n\r\n  private _handleKeyboardShortcutMenuEvent = (state: KeyboardShortcutMenuState) => {\r\n    this.setState(state);\r\n  };\r\n\r\n  public override render(): React.ReactNode {\r\n    const { shortcuts, menuX, menuY, menuVisible } = this.state;\r\n    const onClose = this._hideContextMenu;\r\n\r\n    if (menuVisible) {\r\n      const items = this.getShortcutMenuItems(shortcuts);\r\n\r\n      return (\r\n        <GlobalContextMenu\r\n          className={this.props.className}\r\n          style={this.props.style}\r\n          identifier=\"keyboard-shortcuts\"\r\n          x={menuX}\r\n          y={menuY}\r\n          opened={menuVisible}\r\n          onEsc={onClose}\r\n          onOutsideClick={onClose}\r\n          edgeLimit={false}\r\n          autoflip={true}\r\n          ignoreNextKeyUp={true}  // Executing the shortcut on the keydown, so ignore the keyup in the menu\r\n        >\r\n          {items}\r\n        </GlobalContextMenu>\r\n      );\r\n    }\r\n\r\n    return null;\r\n  }\r\n\r\n  private getShortcutMenuItems(shortcuts?: KeyboardShortcut[]): React.ReactNode[] {\r\n    const items: React.ReactNode[] = [];\r\n\r\n    // istanbul ignore else\r\n    if (shortcuts) {\r\n      shortcuts.forEach((shortcut: KeyboardShortcut, index: number) => {\r\n        const item = this.getShortcutMenuItem(shortcut, index);\r\n        // istanbul ignore else\r\n        if (item)\r\n          items.push(item);\r\n      });\r\n    }\r\n\r\n    return items;\r\n  }\r\n\r\n  private getShortcutMenuItem(shortcut: KeyboardShortcut, index: number): React.ReactNode {\r\n    const shortcutKey = shortcut.key;\r\n    const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);\r\n\r\n    // Only pure characters go into the context menu\r\n    if (shortcutKey !== shortcut.keyMapKey || shortcut.isFunctionKey || shortcut.isSpecialKey || isHidden)\r\n      return null;\r\n\r\n    let node: React.ReactNode = null;\r\n    let label = shortcut.label;\r\n    const iconSpec = shortcut.iconSpec;\r\n\r\n    label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;\r\n\r\n    if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\r\n      const shortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\r\n      const items = this.getShortcutMenuItems(shortcuts);\r\n\r\n      node = (\r\n        <ContextSubMenu key={index} icon={iconSpec} label={label} disabled={shortcut.isDisabled}>\r\n          {items}\r\n        </ContextSubMenu>\r\n      );\r\n    } else {\r\n      const sel = () => this._itemPicked(shortcut);\r\n      node = (\r\n        <ContextMenuItem key={index} onSelect={sel} icon={iconSpec} disabled={shortcut.isDisabled}>\r\n          {label}\r\n        </ContextMenuItem>\r\n      );\r\n    }\r\n\r\n    return node;\r\n  }\r\n\r\n  private _hideContextMenu = () => {\r\n    this.setState({ menuVisible: false, shortcuts: undefined });\r\n  };\r\n\r\n  private _itemPicked = (shortcut: KeyboardShortcut): void => {\r\n    this._hideContextMenu();\r\n    shortcut.itemPicked();\r\n  };\r\n}\r\n"]}

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

@@ -1,10 +1,10 @@
-/** @packageDocumentation
- * @module Notification
- */
-/// <reference types="react" />
-/**
- * Component wrapping the `useActivityMessage` hook to use in class components.
- * @internal
- */
-export declare function ActivityMessageRenderer(): JSX.Element;
+/** @packageDocumentation
+ * @module Notification
+ */
+/// <reference types="react" />
+/**
+ * Component wrapping the `useActivityMessage` hook to use in class components.
+ * @internal
+ */
+export declare function ActivityMessageRenderer(): JSX.Element;
 //# sourceMappingURL=ActivityMessage.d.ts.map

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

@@ -1,76 +1,76 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { UiCore } from "@itwin/core-react";
-import { ProgressLinear, Small, Text, toaster } from "@itwin/itwinui-react";
-import { UiFramework } from "../UiFramework";
-import { MessageManager } from "../messages/MessageManager";
-/**
- * Hook to render an Activity message.
- * @internal
- */
-function useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage }) {
-    const [cancelLabel] = React.useState(UiCore.translate("dialog.cancel"));
-    const recentToast = React.useRef();
-    React.useEffect(() => {
-        toaster.setSettings({ placement: "bottom" });
-    }, []);
-    React.useEffect(() => {
-        var _a, _b;
-        if (activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.restored) {
-            recentToast.current = toaster.informational(React.createElement(ActivityMessageContent, { initialActivityMessageInfo: activityMessageInfo }), { onRemove: dismissActivityMessage, type: "persisting", link: ((_a = activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.supportsCancellation) && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined });
-        }
-        if (!activityMessageInfo) {
-            (_b = recentToast.current) === null || _b === void 0 ? void 0 : _b.close();
-        }
-    }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);
-}
-/**
- * Component wrapping the `useActivityMessage` hook to use in class components.
- * @internal
- */
-export function ActivityMessageRenderer() {
-    const [activityMessageInfo, setActivityMessageInfo] = React.useState();
-    React.useEffect(() => {
-        return MessageManager.onActivityMessageUpdatedEvent.addListener((args) => {
-            setActivityMessageInfo(args);
-        });
-    }, []);
-    React.useEffect(() => {
-        return MessageManager.onActivityMessageCancelledEvent.addListener(() => {
-            setActivityMessageInfo(undefined);
-        });
-    }, []);
-    const cancelActivityMessage = React.useCallback(() => {
-        MessageManager.endActivityMessage(false);
-    }, []);
-    useActivityMessage({ activityMessageInfo, cancelActivityMessage });
-    return React.createElement(React.Fragment, null);
-}
-/**
- * Component used to show and update activity message content.
- * @internal
- */
-function ActivityMessageContent({ initialActivityMessageInfo }) {
-    var _a, _b;
-    const [percentCompleteLabel] = React.useState(UiFramework.translate("activityCenter.percentComplete"));
-    const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);
-    React.useEffect(() => {
-        const handleActivityMessageUpdatedEvent = (args) => {
-            setActivityMessageInfo(args);
-        };
-        return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);
-    }, []);
-    return (React.createElement(React.Fragment, null,
-        activityMessageInfo.message && React.createElement(Text, null,
-            React.createElement(React.Fragment, null, activityMessageInfo.message.reactNode || activityMessageInfo.message)),
-        !!((_a = activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.showPercentInMessage) &&
-            React.createElement(Small, null, `${activityMessageInfo.percentage} ${percentCompleteLabel}`),
-        ((_b = activityMessageInfo.details) === null || _b === void 0 ? void 0 : _b.showProgressBar) && React.createElement(ProgressLinear, { value: activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.percentage })));
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { UiCore } from "@itwin/core-react";
+import { ProgressLinear, Text, toaster } from "@itwin/itwinui-react";
+import { UiFramework } from "../UiFramework";
+import { MessageManager } from "../messages/MessageManager";
+/**
+ * Hook to render an Activity message.
+ * @internal
+ */
+function useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage }) {
+    const [cancelLabel] = React.useState(UiCore.translate("dialog.cancel"));
+    const recentToast = React.useRef();
+    React.useEffect(() => {
+        toaster.setSettings({ placement: "bottom" });
+    }, []);
+    React.useEffect(() => {
+        var _a, _b;
+        if (activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.restored) {
+            recentToast.current = toaster.informational(React.createElement(ActivityMessageContent, { initialActivityMessageInfo: activityMessageInfo }), { onRemove: dismissActivityMessage, type: "persisting", link: ((_a = activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.supportsCancellation) && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined });
+        }
+        if (!activityMessageInfo) {
+            (_b = recentToast.current) === null || _b === void 0 ? void 0 : _b.close();
+        }
+    }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);
+}
+/**
+ * Component wrapping the `useActivityMessage` hook to use in class components.
+ * @internal
+ */
+export function ActivityMessageRenderer() {
+    const [activityMessageInfo, setActivityMessageInfo] = React.useState();
+    React.useEffect(() => {
+        return MessageManager.onActivityMessageUpdatedEvent.addListener((args) => {
+            setActivityMessageInfo(args);
+        });
+    }, []);
+    React.useEffect(() => {
+        return MessageManager.onActivityMessageCancelledEvent.addListener(() => {
+            setActivityMessageInfo(undefined);
+        });
+    }, []);
+    const cancelActivityMessage = React.useCallback(() => {
+        MessageManager.endActivityMessage(false);
+    }, []);
+    useActivityMessage({ activityMessageInfo, cancelActivityMessage });
+    return React.createElement(React.Fragment, null);
+}
+/**
+ * Component used to show and update activity message content.
+ * @internal
+ */
+function ActivityMessageContent({ initialActivityMessageInfo }) {
+    var _a, _b;
+    const [percentCompleteLabel] = React.useState(UiFramework.translate("activityCenter.percentComplete"));
+    const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);
+    React.useEffect(() => {
+        const handleActivityMessageUpdatedEvent = (args) => {
+            setActivityMessageInfo(args);
+        };
+        return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);
+    }, []);
+    return (React.createElement(React.Fragment, null,
+        activityMessageInfo.message && React.createElement(Text, null,
+            React.createElement(React.Fragment, null, activityMessageInfo.message.reactNode || activityMessageInfo.message)),
+        !!((_a = activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.showPercentInMessage) &&
+            React.createElement(Text, { variant: "small" }, `${activityMessageInfo.percentage} ${percentCompleteLabel}`),
+        ((_b = activityMessageInfo.details) === null || _b === void 0 ? void 0 : _b.showProgressBar) && React.createElement(ProgressLinear, { value: activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.percentage })));
+}
 //# sourceMappingURL=ActivityMessage.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ActivityMessage.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAgB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAA4B,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAQtF;;;GAGG;AACH,SAAS,kBAAkB,CAAC,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAA2B;IACzH,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAqC,CAAC;IACtE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,IAAI,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,QAAQ,EAAE;YACjC,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CACzC,oBAAC,sBAAsB,IAAC,0BAA0B,EAAE,mBAAmB,GAAI,EAC3E,EAAE,QAAQ,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,OAAO,0CAAE,oBAAoB,KAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CACjN,CAAC;SACH;QACD,IAAI,CAAC,mBAAmB,EAAE;YACxB,MAAA,WAAW,CAAC,OAAO,0CAAE,KAAK,EAAE,CAAC;SAC9B;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;AACxF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB;IACrC,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAwC,CAAC;IAC7G,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,cAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACvE,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,cAAc,CAAC,+BAA+B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,qBAAqB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACnD,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,kBAAkB,CAAC,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC,CAAC;IACnE,OAAO,yCAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,EAAE,0BAA0B,EAA4D;;IACtH,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEjG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iCAAiC,GAAG,CAAC,IAA8B,EAAE,EAAE;YAC3E,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,OAAO,cAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;IACrG,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL;QACG,mBAAmB,CAAC,OAAO,IAAI,oBAAC,IAAI;YAAC,0CAAI,mBAAmB,CAAC,OAAwB,CAAC,SAAS,IAAI,mBAAmB,CAAC,OAAO,CAAI,CAAO;QACzI,CAAC,CAAC,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,oBAAoB,CAAA;YAClD,oBAAC,KAAK,QAAE,GAAG,mBAAmB,CAAC,UAAU,IAAI,oBAAoB,EAAE,CAAS;QAE7E,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,eAAe,KAAI,oBAAC,cAAc,IAAC,KAAK,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,UAAU,GAAI,CAC1G,CACJ,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 { ReactMessage, UiCore } from \"@itwin/core-react\";\r\nimport { ProgressLinear, Small, Text, toaster } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ActivityMessageEventArgs, MessageManager } from \"../messages/MessageManager\";\r\n\r\ninterface UseActivityMessageProps {\r\n  cancelActivityMessage?: () => void;\r\n  dismissActivityMessage?: () => void;\r\n  activityMessageInfo?: ActivityMessageEventArgs;\r\n}\r\n\r\n/**\r\n * Hook to render an Activity message.\r\n * @internal\r\n */\r\nfunction useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage }: UseActivityMessageProps) {\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n  const recentToast = React.useRef<{ close: () => void } | undefined>();\r\n  React.useEffect(() => {\r\n    toaster.setSettings({ placement: \"bottom\" });\r\n  }, []);\r\n\r\n  React.useEffect(() => {\r\n    if (activityMessageInfo?.restored) {\r\n      recentToast.current = toaster.informational(\r\n        <ActivityMessageContent initialActivityMessageInfo={activityMessageInfo} />,\r\n        { onRemove: dismissActivityMessage, type: \"persisting\", link: activityMessageInfo?.details?.supportsCancellation && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined }\r\n      );\r\n    }\r\n    if (!activityMessageInfo) {\r\n      recentToast.current?.close();\r\n    }\r\n  }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);\r\n}\r\n\r\n/**\r\n * Component wrapping the `useActivityMessage` hook to use in class components.\r\n * @internal\r\n */\r\nexport function ActivityMessageRenderer() {\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState<ActivityMessageEventArgs | undefined>();\r\n  React.useEffect(() => {\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener((args) => {\r\n      setActivityMessageInfo(args);\r\n    });\r\n  }, []);\r\n\r\n  React.useEffect(() => {\r\n    return MessageManager.onActivityMessageCancelledEvent.addListener(() => {\r\n      setActivityMessageInfo(undefined);\r\n    });\r\n  }, []);\r\n\r\n  const cancelActivityMessage = React.useCallback(() => {\r\n    MessageManager.endActivityMessage(false);\r\n  }, []);\r\n\r\n  useActivityMessage({ activityMessageInfo, cancelActivityMessage });\r\n  return <></>;\r\n}\r\n\r\n/**\r\n * Component used to show and update activity message content.\r\n * @internal\r\n */\r\nfunction ActivityMessageContent({ initialActivityMessageInfo }: { initialActivityMessageInfo: ActivityMessageEventArgs }) {\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);\r\n\r\n  React.useEffect(() => {\r\n    const handleActivityMessageUpdatedEvent = (args: ActivityMessageEventArgs) => {\r\n      setActivityMessageInfo(args);\r\n    };\r\n\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);\r\n  }, []);\r\n\r\n  return (\r\n    <>\r\n      {activityMessageInfo.message && <Text><>{(activityMessageInfo.message as ReactMessage).reactNode || activityMessageInfo.message}</></Text>}\r\n      {!!activityMessageInfo.details?.showPercentInMessage &&\r\n        <Small>{`${activityMessageInfo.percentage} ${percentCompleteLabel}`}</Small>\r\n      }\r\n      {activityMessageInfo.details?.showProgressBar && <ProgressLinear value={activityMessageInfo?.percentage} />}\r\n    </>\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"ActivityMessage.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAgB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAA4B,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAQtF;;;GAGG;AACH,SAAS,kBAAkB,CAAC,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAA2B;IACzH,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAqC,CAAC;IACtE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,IAAI,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,QAAQ,EAAE;YACjC,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CACzC,oBAAC,sBAAsB,IAAC,0BAA0B,EAAE,mBAAmB,GAAI,EAC3E,EAAE,QAAQ,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,OAAO,0CAAE,oBAAoB,KAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CACjN,CAAC;SACH;QACD,IAAI,CAAC,mBAAmB,EAAE;YACxB,MAAA,WAAW,CAAC,OAAO,0CAAE,KAAK,EAAE,CAAC;SAC9B;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;AACxF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB;IACrC,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAwC,CAAC;IAC7G,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,cAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACvE,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,cAAc,CAAC,+BAA+B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,qBAAqB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACnD,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,kBAAkB,CAAC,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC,CAAC;IACnE,OAAO,yCAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,EAAE,0BAA0B,EAA4D;;IACtH,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEjG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iCAAiC,GAAG,CAAC,IAA8B,EAAE,EAAE;YAC3E,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,OAAO,cAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;IACrG,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL;QACG,mBAAmB,CAAC,OAAO,IAAI,oBAAC,IAAI;YAAC,0CAAI,mBAAmB,CAAC,OAAwB,CAAC,SAAS,IAAI,mBAAmB,CAAC,OAAO,CAAI,CAAO;QACzI,CAAC,CAAC,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,oBAAoB,CAAA;YAClD,oBAAC,IAAI,IAAC,OAAO,EAAC,OAAO,IAAE,GAAG,mBAAmB,CAAC,UAAU,IAAI,oBAAoB,EAAE,CAAQ;QAE3F,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,eAAe,KAAI,oBAAC,cAAc,IAAC,KAAK,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,UAAU,GAAI,CAC1G,CACJ,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 { ReactMessage, UiCore } from \"@itwin/core-react\";\r\nimport { ProgressLinear, Text, toaster } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ActivityMessageEventArgs, MessageManager } from \"../messages/MessageManager\";\r\n\r\ninterface UseActivityMessageProps {\r\n  cancelActivityMessage?: () => void;\r\n  dismissActivityMessage?: () => void;\r\n  activityMessageInfo?: ActivityMessageEventArgs;\r\n}\r\n\r\n/**\r\n * Hook to render an Activity message.\r\n * @internal\r\n */\r\nfunction useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage }: UseActivityMessageProps) {\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n  const recentToast = React.useRef<{ close: () => void } | undefined>();\r\n  React.useEffect(() => {\r\n    toaster.setSettings({ placement: \"bottom\" });\r\n  }, []);\r\n\r\n  React.useEffect(() => {\r\n    if (activityMessageInfo?.restored) {\r\n      recentToast.current = toaster.informational(\r\n        <ActivityMessageContent initialActivityMessageInfo={activityMessageInfo} />,\r\n        { onRemove: dismissActivityMessage, type: \"persisting\", link: activityMessageInfo?.details?.supportsCancellation && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined }\r\n      );\r\n    }\r\n    if (!activityMessageInfo) {\r\n      recentToast.current?.close();\r\n    }\r\n  }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);\r\n}\r\n\r\n/**\r\n * Component wrapping the `useActivityMessage` hook to use in class components.\r\n * @internal\r\n */\r\nexport function ActivityMessageRenderer() {\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState<ActivityMessageEventArgs | undefined>();\r\n  React.useEffect(() => {\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener((args) => {\r\n      setActivityMessageInfo(args);\r\n    });\r\n  }, []);\r\n\r\n  React.useEffect(() => {\r\n    return MessageManager.onActivityMessageCancelledEvent.addListener(() => {\r\n      setActivityMessageInfo(undefined);\r\n    });\r\n  }, []);\r\n\r\n  const cancelActivityMessage = React.useCallback(() => {\r\n    MessageManager.endActivityMessage(false);\r\n  }, []);\r\n\r\n  useActivityMessage({ activityMessageInfo, cancelActivityMessage });\r\n  return <></>;\r\n}\r\n\r\n/**\r\n * Component used to show and update activity message content.\r\n * @internal\r\n */\r\nfunction ActivityMessageContent({ initialActivityMessageInfo }: { initialActivityMessageInfo: ActivityMessageEventArgs }) {\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);\r\n\r\n  React.useEffect(() => {\r\n    const handleActivityMessageUpdatedEvent = (args: ActivityMessageEventArgs) => {\r\n      setActivityMessageInfo(args);\r\n    };\r\n\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);\r\n  }, []);\r\n\r\n  return (\r\n    <>\r\n      {activityMessageInfo.message && <Text><>{(activityMessageInfo.message as ReactMessage).reactNode || activityMessageInfo.message}</></Text>}\r\n      {!!activityMessageInfo.details?.showPercentInMessage &&\r\n        <Text variant=\"small\">{`${activityMessageInfo.percentage} ${percentCompleteLabel}`}</Text>\r\n      }\r\n      {activityMessageInfo.details?.showProgressBar && <ProgressLinear value={activityMessageInfo?.percentage} />}\r\n    </>\r\n  );\r\n}\r\n"]}

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