@itwin/appui-react 4.14.0 → 4.15.0

package/lib/esm/appui-react/frontstage/StandardFrontstageProvider.js

@@ -5,18 +5,14 @@
 /** @packageDocumentation
  * @module Frontstage
  */
-import * as React from "react";
-import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
 import { FrontstageProvider } from "./FrontstageProvider";
-import { ContentToolWidgetComposer } from "../widgets/ContentToolWidgetComposer";
-import { ViewToolWidgetComposer } from "../widgets/ViewToolWidgetComposer";
-import { StatusBarComposer } from "../statusbar/StatusBarComposer";
-import { StagePanelState } from "../stagepanels/StagePanelState";
-/**
- * FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
+import { FrontstageUtilities } from "./FrontstageUtilities";
+/** FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
  * be provided by one or more item providers, see [[UiItemsProvider]].
  * @public
+ * @deprecated in 4.15.0. Use {@link FrontstageUtilities.createStandardFrontstage} instead.
  */
+// eslint-disable-next-line deprecation/deprecation
 export class StandardFrontstageProvider extends FrontstageProvider {
     constructor(props) {
         super();
@@ -26,56 +22,8 @@ export class StandardFrontstageProvider extends FrontstageProvider {
         return this.props.id;
     }
     frontstageConfig() {
-        const contentGroup = this.props.contentGroupProps instanceof ContentGroupProvider
-            ? this.props.contentGroupProps
-            : new ContentGroup(this.props.contentGroupProps);
-        return {
-            id: this.props.id,
-            version: this.props.version ?? 1.0,
-            contentGroup,
-            usage: this.props.usage,
-            defaultTool: this.props.defaultTool,
-            contentManipulation: {
-                id: `${this.props.id}-contentManipulationTools`,
-                content: (React.createElement(ContentToolWidgetComposer, { cornerButton: this.props.cornerButton })),
-            },
-            viewNavigation: {
-                id: `${this.props.id}-viewNavigationTools`,
-                content: (React.createElement(ViewToolWidgetComposer, { hideNavigationAid: this.props.hideNavigationAid })),
-            },
-            toolSettings: this.props.hideToolSettings
-                ? undefined
-                : {
-                    id: `${this.props.id}-toolSettings`,
-                },
-            statusBar: this.props.hideStatusBar
-                ? undefined
-                : {
-                    id: `${this.props.id}-statusBar`,
-                    content: React.createElement(StatusBarComposer, { items: [] }),
-                },
-            leftPanel: {
-                sizeSpec: 300,
-                pinned: false,
-                defaultState: StagePanelState.Minimized,
-                ...this.props.leftPanelProps,
-            },
-            topPanel: {
-                sizeSpec: 90,
-                pinned: false,
-                defaultState: StagePanelState.Minimized,
-                ...this.props.topPanelProps,
-            },
-            rightPanel: {
-                defaultState: StagePanelState.Open,
-                ...this.props.rightPanelProps,
-            },
-            bottomPanel: {
-                sizeSpec: 180,
-                defaultState: StagePanelState.Open,
-                ...this.props.bottomPanelProps,
-            },
-        };
+        const config = FrontstageUtilities.createStandardFrontstage(this.props);
+        return config;
     }
 }
 //# sourceMappingURL=StandardFrontstageProvider.js.map

package/lib/esm/appui-react/frontstage/StandardFrontstageProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandardFrontstageProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StandardFrontstageProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAI3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AA4DjE;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;IAChE,YAAoB,KAA8B;QAChD,KAAK,EAAE,CAAC;QADU,UAAK,GAAL,KAAK,CAAyB;IAElD,CAAC;IAED,IAAoB,EAAE;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACvB,CAAC;IAEe,gBAAgB;QAC9B,MAAM,YAAY,GAChB,IAAI,CAAC,KAAK,CAAC,iBAAiB,YAAY,oBAAoB;YAC1D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB;YAC9B,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrD,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,GAAG;YAClC,YAAY;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;YACnC,mBAAmB,EAAE;gBACnB,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,2BAA2B;gBAC/C,OAAO,EAAE,CACP,oBAAC,yBAAyB,IAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAI,CACrE;aACF;YACD,cAAc,EAAE;gBACd,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,sBAAsB;gBAC1C,OAAO,EAAE,CACP,oBAAC,sBAAsB,IACrB,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAC/C,CACH;aACF;YACD,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB;gBACvC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe;iBACpC;YACL,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;gBACjC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY;oBAChC,OAAO,EAAE,oBAAC,iBAAiB,IAAC,KAAK,EAAE,EAAE,GAAI;iBAC1C;YACL,SAAS,EAAE;gBACT,QAAQ,EAAE,GAAG;gBACb,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc;aAC7B;YACD,QAAQ,EAAE;gBACR,QAAQ,EAAE,EAAE;gBACZ,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa;aAC5B;YACD,UAAU,EAAE;gBACV,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe;aAC9B;YACD,WAAW,EAAE;gBACX,QAAQ,EAAE,GAAG;gBACb,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB;aAC/B;SACF,CAAC;IACJ,CAAC;CACF","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 Frontstage\n */\n\nimport * as React from \"react\";\nimport type { ContentGroupProps } from \"../content/ContentGroup\";\nimport { ContentGroup, ContentGroupProvider } from \"../content/ContentGroup\";\nimport { FrontstageProvider } from \"./FrontstageProvider\";\nimport { ContentToolWidgetComposer } from \"../widgets/ContentToolWidgetComposer\";\nimport { ViewToolWidgetComposer } from \"../widgets/ViewToolWidgetComposer\";\nimport type { FrontstageConfig } from \"./FrontstageConfig\";\nimport type { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport type { StageUsage } from \"./StageUsage\";\nimport { StatusBarComposer } from \"../statusbar/StatusBarComposer\";\nimport { StagePanelState } from \"../stagepanels/StagePanelState\";\n\n/** Properties of a [[WidgetPanelProps]] component\n * @public\n */\nexport type WidgetPanelProps = Omit<\n  StagePanelConfig,\n  \"widgets\" | \"runtimeProps\" | \"header\" | \"allowedZones\" | \"panelZones\"\n>;\n\n/**\n * Props for [[StandardFrontstageProvider]]\n * @public\n */\nexport interface StandardFrontstageProps {\n  /* unique stage id. To ensure uniqueness it is common practice to format id like `appName:stageId` */\n  id: string;\n  /* version id that is used to store state of stage */\n  version?: number;\n  // Usage of stage. To allow generic UiItemProvides to populate this stage set to `StageUsage.General`.\n  usage: StageUsage | string;\n  /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.\n   * Most of the time, this is the Element Selection Tool (SelectionTool.toolId).\n   * Your app can specify its own tool or another core tool as default with this property.\n   */\n  defaultTool?: string;\n  /** Definition of available content groups or a function that provides them */\n  contentGroupProps: ContentGroupProps | ContentGroupProvider;\n  /** Specify button to use to open backstage. Leave undefined for no backstage button.\n   * ```\n   * <BackstageAppButton icon={<SvgBentleySystems />} />\n   * ```\n   * Custom corner button definition\n   * ```\n   * const cornerButton = <BackstageAppButton icon={<SvgBentleySystems />}\n   *   label=\"Toggle Backstage display\",\n   *   execute={() => UiFramework.backstage.getBackstageToggleCommand().execute()} />;\n   * ```\n   */\n  cornerButton?: React.ReactNode;\n  /** Set to true if default Navigation aid is not desired */\n  hideNavigationAid?: boolean;\n  /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */\n  hideToolSettings?: boolean;\n  /** Set to true if no status bar is needed in stage */\n  hideStatusBar?: boolean;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 300, pinned=false, defaultState:StagePanelState.Minimized} */\n  leftPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 90, pinned=false, defaultState:StagePanelState.Minimized} */\n  topPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 200, pinned=true, defaultState:StagePanelState.Open} */\n  rightPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 180, pinned=true, defaultState:StagePanelState.Open} */\n  bottomPanelProps?: WidgetPanelProps;\n}\n\n/**\n * FrontstageProvider that provides an \"empty\" stage. All tool buttons, statusbar items, and widgets must\n * be provided by one or more item providers, see [[UiItemsProvider]].\n * @public\n */\nexport class StandardFrontstageProvider extends FrontstageProvider {\n  constructor(private props: StandardFrontstageProps) {\n    super();\n  }\n\n  public override get id(): string {\n    return this.props.id;\n  }\n\n  public override frontstageConfig(): FrontstageConfig {\n    const contentGroup =\n      this.props.contentGroupProps instanceof ContentGroupProvider\n        ? this.props.contentGroupProps\n        : new ContentGroup(this.props.contentGroupProps);\n    return {\n      id: this.props.id,\n      version: this.props.version ?? 1.0,\n      contentGroup,\n      usage: this.props.usage,\n      defaultTool: this.props.defaultTool,\n      contentManipulation: {\n        id: `${this.props.id}-contentManipulationTools`,\n        content: (\n          <ContentToolWidgetComposer cornerButton={this.props.cornerButton} />\n        ),\n      },\n      viewNavigation: {\n        id: `${this.props.id}-viewNavigationTools`,\n        content: (\n          <ViewToolWidgetComposer\n            hideNavigationAid={this.props.hideNavigationAid}\n          />\n        ),\n      },\n      toolSettings: this.props.hideToolSettings\n        ? undefined\n        : {\n            id: `${this.props.id}-toolSettings`,\n          },\n      statusBar: this.props.hideStatusBar\n        ? undefined\n        : {\n            id: `${this.props.id}-statusBar`,\n            content: <StatusBarComposer items={[]} />,\n          },\n      leftPanel: {\n        sizeSpec: 300,\n        pinned: false,\n        defaultState: StagePanelState.Minimized,\n        ...this.props.leftPanelProps,\n      },\n      topPanel: {\n        sizeSpec: 90,\n        pinned: false,\n        defaultState: StagePanelState.Minimized,\n        ...this.props.topPanelProps,\n      },\n      rightPanel: {\n        defaultState: StagePanelState.Open,\n        ...this.props.rightPanelProps,\n      },\n      bottomPanel: {\n        sizeSpec: 180,\n        defaultState: StagePanelState.Open,\n        ...this.props.bottomPanelProps,\n      },\n    };\n  }\n}\n"]}
+{"version":3,"file":"StandardFrontstageProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StandardFrontstageProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AA2D5D;;;;GAIG;AACH,mDAAmD;AACnD,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;IAChE,YAAoB,KAA8B;QAChD,KAAK,EAAE,CAAC;QADU,UAAK,GAAL,KAAK,CAAyB;IAElD,CAAC;IAED,IAAoB,EAAE;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACvB,CAAC;IAEe,gBAAgB;QAC9B,MAAM,MAAM,GAAG,mBAAmB,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxE,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","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 Frontstage\n */\n\nimport type * as React from \"react\";\nimport type {\n  ContentGroupProps,\n  ContentGroupProvider,\n} from \"../content/ContentGroup\";\nimport { FrontstageProvider } from \"./FrontstageProvider\";\nimport type { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport type { StageUsage } from \"./StageUsage\";\nimport type { Frontstage } from \"./Frontstage\";\nimport { FrontstageUtilities } from \"./FrontstageUtilities\";\n\n/** Widget panel properties used in a {@link StandardFrontstageProps}.\n * @public\n */\nexport type WidgetPanelProps = Omit<\n  StagePanelConfig,\n  \"widgets\" | \"runtimeProps\" | \"header\" | \"allowedZones\" | \"panelZones\"\n>;\n\n/** Props of a {@link StandardFrontstageProvider}.\n * @public\n */\nexport interface StandardFrontstageProps {\n  /* unique stage id. To ensure uniqueness it is common practice to format id like `appName:stageId` */\n  id: string;\n  /* version id that is used to store state of stage */\n  version?: number;\n  // Usage of stage. To allow generic UiItemProvides to populate this stage set to `StageUsage.General`.\n  usage: StageUsage | string;\n  /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.\n   * Most of the time, this is the Element Selection Tool (SelectionTool.toolId).\n   * Your app can specify its own tool or another core tool as default with this property.\n   */\n  defaultTool?: string;\n  /** Definition of available content groups or a function that provides them */\n  contentGroupProps: ContentGroupProps | ContentGroupProvider;\n  /** Specify button to use to open backstage. Leave undefined for no backstage button.\n   * ```\n   * <BackstageAppButton icon={<SvgBentleySystems />} />\n   * ```\n   * Custom corner button definition\n   * ```\n   * const cornerButton = <BackstageAppButton icon={<SvgBentleySystems />}\n   *   label=\"Toggle Backstage display\",\n   *   execute={() => UiFramework.backstage.getBackstageToggleCommand().execute()} />;\n   * ```\n   */\n  cornerButton?: React.ReactNode;\n  /** Set to true if default Navigation aid is not desired */\n  hideNavigationAid?: boolean;\n  /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */\n  hideToolSettings?: boolean;\n  /** Set to true if no status bar is needed in stage */\n  hideStatusBar?: boolean;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 300, pinned=false, defaultState:StagePanelState.Minimized} */\n  leftPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 90, pinned=false, defaultState:StagePanelState.Minimized} */\n  topPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 200, pinned=true, defaultState:StagePanelState.Open} */\n  rightPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {sizeSpec: 180, pinned=true, defaultState:StagePanelState.Open} */\n  bottomPanelProps?: WidgetPanelProps;\n}\n\n/** FrontstageProvider that provides an \"empty\" stage. All tool buttons, statusbar items, and widgets must\n * be provided by one or more item providers, see [[UiItemsProvider]].\n * @public\n * @deprecated in 4.15.0. Use {@link FrontstageUtilities.createStandardFrontstage} instead.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class StandardFrontstageProvider extends FrontstageProvider {\n  constructor(private props: StandardFrontstageProps) {\n    super();\n  }\n\n  public override get id(): string {\n    return this.props.id;\n  }\n\n  public override frontstageConfig(): Frontstage {\n    const config = FrontstageUtilities.createStandardFrontstage(this.props);\n    return config;\n  }\n}\n"]}

package/lib/esm/appui-react/hooks/useActiveIModelConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useActiveIModelConnection.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAM7D;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,gBAAgB,GAAG,SAAS,CAwBxE"}
+{"version":3,"file":"useActiveIModelConnection.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAM7D;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,gBAAgB,GAAG,SAAS,CAyBxE"}

package/lib/esm/appui-react/hooks/useActiveIModelConnection.js

@@ -19,6 +19,7 @@ export function useActiveIModelConnection() {
     useEffect(() => {
         // eslint-disable-next-line deprecation/deprecation
         const handleSyncUiEvent = (args) => {
+            // eslint-disable-next-line deprecation/deprecation
             const eventIds = [SessionStateActionId.SetIModelConnection];
             if (eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
                 setActiveConnection(UiFramework.getIModelConnection());

package/lib/esm/appui-react/hooks/useActiveIModelConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"useActiveIModelConnection.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C;;;;GAIG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CACtD,WAAW,CAAC,mBAAmB,EAAE,CAClC,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,MAAM,QAAQ,GAAG,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC5D,IACE,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CACvC,EACD,CAAC;gBACD,mBAAmB,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC;QAEF,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnE,OAAO,GAAG,EAAE;YACV,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,OAAO,gBAAgB,CAAC;AAC1B,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 Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** React hook that maintains the active IModelConnection. For this hook to work properly the\n * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires\n * that the host app includes the UiFramework reducer into its Redux store.\n * @public\n */\nexport function useActiveIModelConnection(): IModelConnection | undefined {\n  const [activeConnection, setActiveConnection] = useState(\n    UiFramework.getIModelConnection()\n  );\n  useEffect(() => {\n    // eslint-disable-next-line deprecation/deprecation\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      const eventIds = [SessionStateActionId.SetIModelConnection];\n      if (\n        eventIds.some((value: string): boolean =>\n          args.eventIds.has(value.toLowerCase())\n        )\n      ) {\n        setActiveConnection(UiFramework.getIModelConnection());\n      }\n    };\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n    return () => {\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);\n    };\n  }, [activeConnection]);\n\n  return activeConnection;\n}\n"]}
+{"version":3,"file":"useActiveIModelConnection.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C;;;;GAIG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CACtD,WAAW,CAAC,mBAAmB,EAAE,CAClC,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,mDAAmD;YACnD,MAAM,QAAQ,GAAG,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC5D,IACE,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CACvC,EACD,CAAC;gBACD,mBAAmB,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC;QAEF,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnE,OAAO,GAAG,EAAE;YACV,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,OAAO,gBAAgB,CAAC;AAC1B,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 Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** React hook that maintains the active IModelConnection. For this hook to work properly the\n * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires\n * that the host app includes the UiFramework reducer into its Redux store.\n * @public\n */\nexport function useActiveIModelConnection(): IModelConnection | undefined {\n  const [activeConnection, setActiveConnection] = useState(\n    UiFramework.getIModelConnection()\n  );\n  useEffect(() => {\n    // eslint-disable-next-line deprecation/deprecation\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      // eslint-disable-next-line deprecation/deprecation\n      const eventIds = [SessionStateActionId.SetIModelConnection];\n      if (\n        eventIds.some((value: string): boolean =>\n          args.eventIds.has(value.toLowerCase())\n        )\n      ) {\n        setActiveConnection(UiFramework.getIModelConnection());\n      }\n    };\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n    return () => {\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);\n    };\n  }, [activeConnection]);\n\n  return activeConnection;\n}\n"]}

package/lib/esm/appui-react/keyboardshortcut/InternalKeyboardShortcut.d.ts

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module KeyboardShortcut
  */
-import type { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
 import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut";
+import type { KeyboardShortcutProps } from "./KeyboardShortcutProps";
 /** Keyboard Shortcut Manager
  * @internal
  */

package/lib/esm/appui-react/keyboardshortcut/InternalKeyboardShortcut.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InternalKeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAErF,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,oBAAoB,CAAC;AAM5B;;GAEG;AACH,qBAAa,+BAA+B;IAC1C,OAAO,CAAC,MAAM,CAAC,UAAU,CACS;IAElC;;OAEG;WACW,UAAU,IAAI,IAAI;IAMhC,qDAAqD;WACvC,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMjE,sDAAsD;WACxC,YAAY,CAAC,aAAa,EAAE,qBAAqB;IAK/D,qEAAqE;WACvD,UAAU,CACtB,WAAW,EAAE,MAAM,EACnB,eAAe,GAAE,OAAe,EAChC,gBAAgB,GAAE,OAAe,EACjC,iBAAiB,GAAE,OAAe,GACjC,OAAO;IAiBV,qDAAqD;IACrD,WAAkB,iBAAiB,IAAI,yBAAyB,CAE/D;IAED,yDAAyD;WAC3C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1E,yCAAyC;IACzC,WAAkB,aAAa,IAAI,OAAO,CAGzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAQpC,yDAAyD;WAC3C,WAAW,IAAI,IAAI;IAMjC,yCAAyC;WAC3B,SAAS,IAAI,IAAI;IAS/B,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IACD,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IAGD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAqB/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAgB/B;CACH"}
+{"version":3,"file":"InternalKeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAMrE;;GAEG;AACH,qBAAa,+BAA+B;IAC1C,OAAO,CAAC,MAAM,CAAC,UAAU,CACS;IAElC;;OAEG;WACW,UAAU,IAAI,IAAI;IAMhC,qDAAqD;WACvC,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMjE,sDAAsD;WACxC,YAAY,CAAC,aAAa,EAAE,qBAAqB;IAK/D,qEAAqE;WACvD,UAAU,CACtB,WAAW,EAAE,MAAM,EACnB,eAAe,GAAE,OAAe,EAChC,gBAAgB,GAAE,OAAe,EACjC,iBAAiB,GAAE,OAAe,GACjC,OAAO;IAiBV,qDAAqD;IACrD,WAAkB,iBAAiB,IAAI,yBAAyB,CAE/D;IAED,yDAAyD;WAC3C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1E,yCAAyC;IACzC,WAAkB,aAAa,IAAI,OAAO,CAGzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAQpC,yDAAyD;WAC3C,WAAW,IAAI,IAAI;IAMjC,yCAAyC;WAC3B,SAAS,IAAI,IAAI;IAS/B,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IACD,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IAED,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAqB/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAgB/B;CACH"}

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

@@ -87,7 +87,6 @@ export class InternalKeyboardShortcutManager {
     }
 }
 InternalKeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
-// eslint-disable-next-line deprecation/deprecation
 InternalKeyboardShortcutManager._handleSyncUiEvent = (args) => {
     const updateBooleanValue = (booleanValue) => {
         if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))

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

@@ -1 +1 @@
-{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACL,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAKxE;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAI1C;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAC7C,+BAA+B,CAAC,kBAAkB,CACnD,CAAC;IACJ,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,aAAa,CAAC,YAAqC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,YAAY,CAAC,aAAoC;QAC7D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CACtB,WAAmB,EACnB,kBAA2B,KAAK,EAChC,mBAA4B,KAAK,EACjC,oBAA6B,KAAK;QAElC,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAC3D,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CAClB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,OAAO,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,IAAI,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,SAAS;QACrB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IACD,gEAAgE;IACzD,MAAM,KAAK,OAAO;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;;AAjGc,0CAAU,GACvB,IAAI,yBAAyB,EAAE,CAAC;AAkGlC,mDAAmD;AACpC,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IACE,qBAAqB,CAAC,kBAAkB,CACtC,IAAI,CAAC,QAAQ,EACb,YAAY,CAAC,YAAY,CAC1B;YAED,YAAY,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,QAA0B,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,UAAU,YAAY,uBAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,uBAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,+BAA+B,CAAC,kBAAkB,CAChD,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAC1E,gBAAgB,CACjB,CAAC;AACJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAClC,SAA6B,EAC7B,QAAwB,EACxB,EAAE;IACF,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE,CAAC;YAC/D,MAAM,cAAc,GAClB,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,+BAA+B,CAAC,kBAAkB,CAChD,cAAc,EACd,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,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 KeyboardShortcut\n */\n\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport type { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\nimport {\n  KeyboardShortcut,\n  KeyboardShortcutContainer,\n} from \"./KeyboardShortcut\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\n\n/** Keyboard Shortcut Manager\n * @internal\n */\nexport class InternalKeyboardShortcutManager {\n  private static _shortcuts: KeyboardShortcutContainer =\n    new KeyboardShortcutContainer();\n\n  /** Initialize the Keyboard Shortcut manager\n   * @internal\n   */\n  public static initialize(): void {\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(\n      InternalKeyboardShortcutManager._handleSyncUiEvent\n    );\n  }\n\n  /** Loads Keyboard Shortcuts into the managed list */\n  public static loadShortcuts(shortcutList: KeyboardShortcutProps[]) {\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\n      this.loadShortcut(shortcutProps);\n    });\n  }\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  public static loadShortcut(shortcutProps: KeyboardShortcutProps) {\n    const shortcut = new KeyboardShortcut(shortcutProps);\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n  }\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  public static processKey(\n    keyboardKey: string,\n    isAltKeyPressed: boolean = false,\n    isCtrlKeyPressed: boolean = false,\n    isShiftKeyPressed: boolean = false\n  ): boolean {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      keyboardKey,\n      isAltKeyPressed,\n      isCtrlKeyPressed,\n      isShiftKeyPressed\n    );\n\n    const shortcut = this.getShortcut(keyMapKey);\n    if (shortcut) {\n      shortcut.itemPicked();\n      return true;\n    }\n\n    return false;\n  }\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  public static get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(keyMapKey);\n  }\n\n  /** Determines if focus is set to Home */\n  public static get isFocusOnHome(): boolean {\n    const element = document.activeElement as HTMLElement;\n    return element && element === document.body;\n  }\n\n  /** Sets focus to Home */\n  public static setFocusToHome(): void {\n    const element = document.activeElement as HTMLElement;\n    if (element && element !== document.body) {\n      element.blur();\n      document.body.focus();\n    }\n  }\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  public static displayMenu(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    }\n  }\n\n  /** Closes the Keyboard Shortcuts menu */\n  public static closeMenu(): void {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: false,\n      menuX: 0,\n      menuY: 0,\n      shortcuts: undefined,\n    });\n  }\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  public static get cursorX(): number {\n    return CursorInformation.cursorX;\n  }\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  public static get cursorY(): number {\n    return CursorInformation.cursorY;\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(\n          args.eventIds,\n          booleanValue.syncEventIds\n        )\n      )\n        booleanValue.refresh();\n    };\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isDisabled);\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isHidden);\n    };\n\n    InternalKeyboardShortcutManager._traverseShortcuts(\n      InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(),\n      handleForSyncIds\n    );\n  };\n\n  private static _traverseShortcuts = (\n    shortcuts: KeyboardShortcut[],\n    callback: OnShortcutFunc\n  ) => {\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\n      callback(shortcut);\n\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n        const childShortcuts =\n          shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n        InternalKeyboardShortcutManager._traverseShortcuts(\n          childShortcuts,\n          callback\n        );\n      }\n    });\n  };\n}\n"]}
+{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACL,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAQxE;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAI1C;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAC7C,+BAA+B,CAAC,kBAAkB,CACnD,CAAC;IACJ,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,aAAa,CAAC,YAAqC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,YAAY,CAAC,aAAoC;QAC7D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CACtB,WAAmB,EACnB,kBAA2B,KAAK,EAChC,mBAA4B,KAAK,EACjC,oBAA6B,KAAK;QAElC,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAC3D,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CAClB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,OAAO,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,IAAI,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,SAAS;QACrB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IACD,gEAAgE;IACzD,MAAM,KAAK,OAAO;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;;AAjGc,0CAAU,GACvB,IAAI,yBAAyB,EAAE,CAAC;AAkGnB,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IACE,qBAAqB,CAAC,kBAAkB,CACtC,IAAI,CAAC,QAAQ,EACb,YAAY,CAAC,YAAY,CAC1B;YAED,YAAY,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,QAA0B,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,UAAU,YAAY,uBAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,uBAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,+BAA+B,CAAC,kBAAkB,CAChD,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAC1E,gBAAgB,CACjB,CAAC;AACJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAClC,SAA6B,EAC7B,QAAwB,EACxB,EAAE;IACF,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE,CAAC;YAC/D,MAAM,cAAc,GAClB,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,+BAA+B,CAAC,kBAAkB,CAChD,cAAc,EACd,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,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 KeyboardShortcut\n */\n\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\nimport {\n  KeyboardShortcut,\n  KeyboardShortcutContainer,\n} from \"./KeyboardShortcut\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\nimport type { KeyboardShortcutProps } from \"./KeyboardShortcutProps\";\n\n/* eslint-disable deprecation/deprecation */\n\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\n\n/** Keyboard Shortcut Manager\n * @internal\n */\nexport class InternalKeyboardShortcutManager {\n  private static _shortcuts: KeyboardShortcutContainer =\n    new KeyboardShortcutContainer();\n\n  /** Initialize the Keyboard Shortcut manager\n   * @internal\n   */\n  public static initialize(): void {\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(\n      InternalKeyboardShortcutManager._handleSyncUiEvent\n    );\n  }\n\n  /** Loads Keyboard Shortcuts into the managed list */\n  public static loadShortcuts(shortcutList: KeyboardShortcutProps[]) {\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\n      this.loadShortcut(shortcutProps);\n    });\n  }\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  public static loadShortcut(shortcutProps: KeyboardShortcutProps) {\n    const shortcut = new KeyboardShortcut(shortcutProps);\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n  }\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  public static processKey(\n    keyboardKey: string,\n    isAltKeyPressed: boolean = false,\n    isCtrlKeyPressed: boolean = false,\n    isShiftKeyPressed: boolean = false\n  ): boolean {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      keyboardKey,\n      isAltKeyPressed,\n      isCtrlKeyPressed,\n      isShiftKeyPressed\n    );\n\n    const shortcut = this.getShortcut(keyMapKey);\n    if (shortcut) {\n      shortcut.itemPicked();\n      return true;\n    }\n\n    return false;\n  }\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  public static get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(keyMapKey);\n  }\n\n  /** Determines if focus is set to Home */\n  public static get isFocusOnHome(): boolean {\n    const element = document.activeElement as HTMLElement;\n    return element && element === document.body;\n  }\n\n  /** Sets focus to Home */\n  public static setFocusToHome(): void {\n    const element = document.activeElement as HTMLElement;\n    if (element && element !== document.body) {\n      element.blur();\n      document.body.focus();\n    }\n  }\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  public static displayMenu(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    }\n  }\n\n  /** Closes the Keyboard Shortcuts menu */\n  public static closeMenu(): void {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: false,\n      menuX: 0,\n      menuY: 0,\n      shortcuts: undefined,\n    });\n  }\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  public static get cursorX(): number {\n    return CursorInformation.cursorX;\n  }\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  public static get cursorY(): number {\n    return CursorInformation.cursorY;\n  }\n\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(\n          args.eventIds,\n          booleanValue.syncEventIds\n        )\n      )\n        booleanValue.refresh();\n    };\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isDisabled);\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isHidden);\n    };\n\n    InternalKeyboardShortcutManager._traverseShortcuts(\n      InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(),\n      handleForSyncIds\n    );\n  };\n\n  private static _traverseShortcuts = (\n    shortcuts: KeyboardShortcut[],\n    callback: OnShortcutFunc\n  ) => {\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\n      callback(shortcut);\n\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n        const childShortcuts =\n          shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n        InternalKeyboardShortcutManager._traverseShortcuts(\n          childShortcuts,\n          callback\n        );\n      }\n    });\n  };\n}\n"]}

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts

@@ -3,14 +3,16 @@
  */
 import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
 import { ItemDefBase } from "../shared/ItemDefBase";
-import type { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+import type { KeyboardShortcutProps } from "./KeyboardShortcutProps";
 /** Keyboard Shortcut used to execute an action
  * @public
+ * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.
  */
 export declare class KeyboardShortcut extends ItemDefBase {
     private _key;
     private _item?;
     private _shortcuts;
+    private _execute?;
     private _isAltKeyRequired;
     private _isCtrlKeyRequired;
     private _isShiftKeyRequired;
@@ -44,6 +46,7 @@ export declare class KeyboardShortcut extends ItemDefBase {
 }
 /** Keyboard Shortcut Container
  * @public
+ * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.
  */
 export declare class KeyboardShortcutContainer {
     private _keyMap;

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AA4CrF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAsB;IACpC,OAAO,CAAC,UAAU,CAA4B;IAE9C,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,aAAa,CAAkB;gBAE3B,KAAK,EAAE,qBAAqB;IAyCxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,qCAAqC;IACrC,IAAW,iBAAiB,IAAI,yBAAyB,CAExD;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIhE,wDAAwD;IACxD,IAAW,SAAS,IAAI,MAAM,CAQ7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAUzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAEvB;IACD,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAErC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IACD,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAElC;IACD,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAGX;IACJ,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,gBAAgB,GAC3B,gBAAgB,GAAG,SAAS;IAqB/B,4DAA4D;IACrD,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/D,2EAA2E;IACpE,6BAA6B,IAAI,OAAO;IAI/C,yDAAyD;IAClD,SAAS,IAAI,IAAI;IAKjB,6BAA6B,IAAI,gBAAgB,EAAE;IAI1D,4FAA4F;WAC9E,iBAAiB,CAC7B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,OAAO,EACzB,iBAAiB,EAAE,OAAO,EAC1B,kBAAkB,EAAE,OAAO,GAC1B,MAAM;IAUT,mEAAmE;IAC5D,iBAAiB;CASzB"}
+{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAgDrE;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAsB;IACpC,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,QAAQ,CAAC,CAAa;IAE9B,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,aAAa,CAAkB;gBAE3B,KAAK,EAAE,qBAAqB;IA0CxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,qCAAqC;IACrC,IAAW,iBAAiB,IAAI,yBAAyB,CAExD;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIhE,wDAAwD;IACxD,IAAW,SAAS,IAAI,MAAM,CAQ7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAWzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAEvB;IACD,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAErC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IACD,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAElC;IACD,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAGX;IACJ,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,gBAAgB,GAC3B,gBAAgB,GAAG,SAAS;IAqB/B,4DAA4D;IACrD,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/D,2EAA2E;IACpE,6BAA6B,IAAI,OAAO;IAI/C,yDAAyD;IAClD,SAAS,IAAI,IAAI;IAKjB,6BAA6B,IAAI,gBAAgB,EAAE;IAI1D,4FAA4F;WAC9E,iBAAiB,CAC7B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,OAAO,EACzB,iBAAiB,EAAE,OAAO,EAC1B,kBAAkB,EAAE,OAAO,GAC1B,MAAM;IAUT,mEAAmE;IAC5D,iBAAiB;CASzB"}

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

@@ -9,6 +9,7 @@ import { UiError } from "@itwin/appui-abstract";
 import { ItemDefBase } from "../shared/ItemDefBase";
 import { UiFramework } from "../UiFramework";
 import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu";
+/* eslint-disable deprecation/deprecation */
 var FunctionKey;
 (function (FunctionKey) {
     FunctionKey["F1"] = "F1";
@@ -51,6 +52,7 @@ var SpecialKey;
 })(SpecialKey || (SpecialKey = {}));
 /** Keyboard Shortcut used to execute an action
  * @public
+ * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.
  */
 export class KeyboardShortcut extends ItemDefBase {
     constructor(props) {
@@ -80,6 +82,9 @@ export class KeyboardShortcut extends ItemDefBase {
             if (this.isHidden === undefined)
                 this.isHidden = this._item.isHidden;
         }
+        else if (props.execute) {
+            this._execute = props.execute;
+        }
         else if (props.shortcuts) {
             props.shortcuts.forEach((childProps) => {
                 const shortcut = new KeyboardShortcut(childProps);
@@ -87,8 +92,7 @@ export class KeyboardShortcut extends ItemDefBase {
             });
         }
         else {
-            // eslint-disable-next-line deprecation/deprecation
-            throw new UiError(UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);
+            throw new UiError(UiFramework.loggerCategory(this), `Either 'item', 'execute' or 'shortcuts' must be specified for '${props.key}' key.`);
         }
         if (props.isAltKeyRequired !== undefined)
             this._isAltKeyRequired = props.isAltKeyRequired;
@@ -127,6 +131,8 @@ export class KeyboardShortcut extends ItemDefBase {
             setTimeout(() => {
                 if (this._item)
                     this._item.execute();
+                else if (this._execute)
+                    this._execute();
             });
         }
     }
@@ -157,6 +163,7 @@ export class KeyboardShortcut extends ItemDefBase {
 }
 /** Keyboard Shortcut Container
  * @public
+ * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.
  */
 export class KeyboardShortcutContainer {
     constructor() {

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

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,IAAK,WAaJ;AAbD,WAAK,WAAW;IACd,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,0BAAW,CAAA;AACb,CAAC,EAbI,WAAW,KAAX,WAAW,QAaf;AAED,IAAK,UAuBJ;AAvBD,WAAK,UAAU;IACb,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,8BAAgB,CAAA;IAChB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,yBAAW,CAAA;IACX,iCAAmB,CAAA;AACrB,CAAC,EAvBI,UAAU,KAAV,UAAU,QAuBd;AAED;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAW/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,WAAW;YAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,IAAI,IAAI,UAAU;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEvD,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACvE,CAAC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC3B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,mDAAmD;YACnD,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CACzE,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAC3D,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,mBAAmB,CACzB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,yCAAyC;IACzC,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IACD,2CAA2C;IAC3C,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,0CAA0C;IAC1C,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAGrD,CAAC;QACI,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAyExE,CAAC;IAvEC,oFAAoF;IAC7E,WAAW,CAChB,SAAiB,EACjB,UAA4B;QAE5B,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACvD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACf,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEpD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAC7B,WAAmB,EACnB,gBAAyB,EACzB,iBAA0B,EAC1B,kBAA2B;QAE3B,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAAE,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACrD,IAAI,kBAAkB;YAAE,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACzD,IAAI,iBAAiB;YAAE,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAEvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF","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 KeyboardShortcut\n */\n\nimport { UiError } from \"@itwin/appui-abstract\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\nimport type { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\nimport { UiFramework } from \"../UiFramework\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\n\nenum FunctionKey {\n  F1 = \"F1\",\n  F2 = \"F2\",\n  F3 = \"F3\",\n  F4 = \"F4\",\n  F5 = \"F5\",\n  F6 = \"F6\",\n  F7 = \"F7\",\n  F8 = \"F8\",\n  F9 = \"F9\",\n  F10 = \"F10\",\n  F11 = \"F11\",\n  F12 = \"F12\",\n}\n\nenum SpecialKey {\n  Home = \"Home\",\n  End = \"End\",\n  PageUp = \"PageUp\",\n  PageDown = \"PageDown\",\n  Escape = \"Escape\",\n  Delete = \"Delete\",\n  Insert = \"Insert\",\n  Tab = \"Tab\",\n  ArrowLeft = \"ArrowLeft\",\n  ArrowRight = \"ArrowRight\",\n  ArrowUp = \"ArrowUp\",\n  ArrowDown = \"ArrowDown\",\n  Enter = \"Enter\",\n  Return = \"Enter\", // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\n  Space = \" \",\n  Backspace = \"Backspace\",\n  Clear = \"Clear\",\n  Divide = \"Divide\",\n  Multiply = \"Multiply\",\n  Subtract = \"Subtract\",\n  Add = \"Add\",\n  Decimal = \"Decimal\",\n}\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport class KeyboardShortcut extends ItemDefBase {\n  private _key: string;\n  private _item?: ActionButtonItemDef;\n  private _shortcuts: KeyboardShortcutContainer;\n\n  private _isAltKeyRequired: boolean = false;\n  private _isCtrlKeyRequired: boolean = false;\n  private _isShiftKeyRequired: boolean = false;\n  private _isFunctionKey: boolean = false;\n  private _isSpecialKey: boolean = false;\n\n  constructor(props: KeyboardShortcutProps) {\n    super(props);\n\n    this._key = props.key;\n\n    if (this._key in FunctionKey) this._isFunctionKey = true;\n    if (this._key in SpecialKey) this._isSpecialKey = true;\n\n    this._shortcuts = new KeyboardShortcutContainer();\n\n    if (props.item) {\n      this._item = props.item;\n\n      // Copy over icon, label & tooltip from the item\n      if (!this.iconSpec) this.iconSpec = this._item.iconSpec;\n      if (!this.label) this.setLabel(this._item.label);\n      if (!this.tooltip) this.setTooltip(this._item.tooltip);\n      if (this.isDisabled === undefined)\n        this.isDisabled = this._item.isDisabled;\n      if (this.isHidden === undefined) this.isHidden = this._item.isHidden;\n    } else if (props.shortcuts) {\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\n        const shortcut = new KeyboardShortcut(childProps);\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n      });\n    } else {\n      // eslint-disable-next-line deprecation/deprecation\n      throw new UiError(\n        UiFramework.loggerCategory(this),\n        `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`\n      );\n    }\n\n    if (props.isAltKeyRequired !== undefined)\n      this._isAltKeyRequired = props.isAltKeyRequired;\n    if (props.isCtrlKeyRequired !== undefined)\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\n    if (props.isShiftKeyRequired !== undefined)\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\n  }\n\n  /** Returns the id for this shortcut */\n  public get id(): string {\n    return this.keyMapKey;\n  }\n\n  /** Returns the shortcut container */\n  public get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(mapKey);\n  }\n\n  /** Returns the shortcut's key map key used as the id */\n  public get keyMapKey(): string {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      this.key,\n      this._isAltKeyRequired,\n      this._isCtrlKeyRequired,\n      this._isShiftKeyRequired\n    );\n    return keyMapKey;\n  }\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  public get item(): ActionButtonItemDef | undefined {\n    return this._item;\n  }\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  public itemPicked(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    } else {\n      setTimeout(() => {\n        if (this._item) this._item.execute();\n      });\n    }\n  }\n\n  /** Gets the keyboard key */\n  public get key(): string {\n    return this._key;\n  }\n  /** Gets whether the Alt key required. */\n  public get isAltKeyRequired(): boolean {\n    return this._isAltKeyRequired;\n  }\n  /** Gets whether the Ctrl key required. */\n  public get isCtrlKeyRequired(): boolean {\n    return this._isCtrlKeyRequired;\n  }\n  /** Gets whether the Shift key required. */\n  public get isShiftKeyRequired(): boolean {\n    return this._isShiftKeyRequired;\n  }\n  /** Gets whether this is a Function key. */\n  public get isFunctionKey(): boolean {\n    return this._isFunctionKey;\n  }\n  /** Gets whether this is a Special key. */\n  public get isSpecialKey(): boolean {\n    return this._isSpecialKey;\n  }\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport class KeyboardShortcutContainer {\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<\n    string,\n    KeyboardShortcut\n  >();\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\n\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  public registerKey(\n    keyMapKey: string,\n    inShortcut: KeyboardShortcut\n  ): KeyboardShortcut | undefined {\n    let shortcut: KeyboardShortcut | undefined;\n\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\n      shortcut = inShortcut;\n      this._keyArray.push(shortcut);\n    } else {\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\n        return value.keyMapKey === keyMapKey;\n      });\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    if (shortcut) this._keyMap.set(keyMapKey, shortcut);\n\n    return shortcut;\n  }\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._keyMap.get(keyMapKey);\n  }\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  public areKeyboardShortcutsAvailable(): boolean {\n    return this._keyMap.size !== 0;\n  }\n\n  /** Empties any Keyboard Shortcuts from this container */\n  public emptyData(): void {\n    this._keyMap.clear();\n    this._keyArray.length = 0;\n  }\n\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\n    return this._keyArray.slice();\n  }\n\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\n  public static generateKeyMapKey(\n    keyboardKey: string,\n    isAltKeyRequired: boolean,\n    isCtrlKeyRequired: boolean,\n    isShiftKeyRequired: boolean\n  ): string {\n    let keyMapKey = keyboardKey;\n\n    if (isAltKeyRequired) keyMapKey = `Alt+${keyMapKey}`;\n    if (isShiftKeyRequired) keyMapKey = `Shift+${keyMapKey}`;\n    if (isCtrlKeyRequired) keyMapKey = `Ctrl+${keyMapKey}`;\n\n    return keyMapKey;\n  }\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  public showShortcutsMenu() {\n    const offset = 8;\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: true,\n      menuX: UiFramework.keyboardShortcuts.cursorX - offset,\n      menuY: UiFramework.keyboardShortcuts.cursorY - offset,\n      shortcuts: this.getAvailableKeyboardShortcuts(),\n    });\n  }\n}\n"]}
+{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAO9D,4CAA4C;AAE5C,IAAK,WAaJ;AAbD,WAAK,WAAW;IACd,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,0BAAW,CAAA;AACb,CAAC,EAbI,WAAW,KAAX,WAAW,QAaf;AAED,IAAK,UAuBJ;AAvBD,WAAK,UAAU;IACb,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,8BAAgB,CAAA;IAChB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,yBAAW,CAAA;IACX,iCAAmB,CAAA;AACrB,CAAC,EAvBI,UAAU,KAAV,UAAU,QAuBd;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAY/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,WAAW;YAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,IAAI,IAAI,UAAU;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEvD,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACvE,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC3B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,kEAAkE,KAAK,CAAC,GAAG,QAAQ,CACpF,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAC3D,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,mBAAmB,CACzB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;qBAChC,IAAI,IAAI,CAAC,QAAQ;oBAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,yCAAyC;IACzC,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IACD,2CAA2C;IAC3C,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,0CAA0C;IAC1C,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAGrD,CAAC;QACI,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAyExE,CAAC;IAvEC,oFAAoF;IAC7E,WAAW,CAChB,SAAiB,EACjB,UAA4B;QAE5B,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACvD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACf,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEpD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAC7B,WAAmB,EACnB,gBAAyB,EACzB,iBAA0B,EAC1B,kBAA2B;QAE3B,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAAE,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACrD,IAAI,kBAAkB;YAAE,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACzD,IAAI,iBAAiB;YAAE,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAEvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF","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 KeyboardShortcut\n */\n\nimport { UiError } from \"@itwin/appui-abstract\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\nimport { UiFramework } from \"../UiFramework\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\nimport type { KeyboardShortcutProps } from \"./KeyboardShortcutProps\";\nimport type {\n  FrameworkKeyboardShortcut,\n  FrameworkKeyboardShortcutContainer,\n} from \"../framework/FrameworkKeyboardShortcuts\";\n\n/* eslint-disable deprecation/deprecation */\n\nenum FunctionKey {\n  F1 = \"F1\",\n  F2 = \"F2\",\n  F3 = \"F3\",\n  F4 = \"F4\",\n  F5 = \"F5\",\n  F6 = \"F6\",\n  F7 = \"F7\",\n  F8 = \"F8\",\n  F9 = \"F9\",\n  F10 = \"F10\",\n  F11 = \"F11\",\n  F12 = \"F12\",\n}\n\nenum SpecialKey {\n  Home = \"Home\",\n  End = \"End\",\n  PageUp = \"PageUp\",\n  PageDown = \"PageDown\",\n  Escape = \"Escape\",\n  Delete = \"Delete\",\n  Insert = \"Insert\",\n  Tab = \"Tab\",\n  ArrowLeft = \"ArrowLeft\",\n  ArrowRight = \"ArrowRight\",\n  ArrowUp = \"ArrowUp\",\n  ArrowDown = \"ArrowDown\",\n  Enter = \"Enter\",\n  Return = \"Enter\", // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\n  Space = \" \",\n  Backspace = \"Backspace\",\n  Clear = \"Clear\",\n  Divide = \"Divide\",\n  Multiply = \"Multiply\",\n  Subtract = \"Subtract\",\n  Add = \"Add\",\n  Decimal = \"Decimal\",\n}\n\n/** Keyboard Shortcut used to execute an action\n * @public\n * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.\n */\nexport class KeyboardShortcut extends ItemDefBase {\n  private _key: string;\n  private _item?: ActionButtonItemDef;\n  private _shortcuts: KeyboardShortcutContainer;\n  private _execute?: () => void;\n\n  private _isAltKeyRequired: boolean = false;\n  private _isCtrlKeyRequired: boolean = false;\n  private _isShiftKeyRequired: boolean = false;\n  private _isFunctionKey: boolean = false;\n  private _isSpecialKey: boolean = false;\n\n  constructor(props: KeyboardShortcutProps) {\n    super(props);\n\n    this._key = props.key;\n\n    if (this._key in FunctionKey) this._isFunctionKey = true;\n    if (this._key in SpecialKey) this._isSpecialKey = true;\n\n    this._shortcuts = new KeyboardShortcutContainer();\n\n    if (props.item) {\n      this._item = props.item;\n\n      // Copy over icon, label & tooltip from the item\n      if (!this.iconSpec) this.iconSpec = this._item.iconSpec;\n      if (!this.label) this.setLabel(this._item.label);\n      if (!this.tooltip) this.setTooltip(this._item.tooltip);\n      if (this.isDisabled === undefined)\n        this.isDisabled = this._item.isDisabled;\n      if (this.isHidden === undefined) this.isHidden = this._item.isHidden;\n    } else if (props.execute) {\n      this._execute = props.execute;\n    } else if (props.shortcuts) {\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\n        const shortcut = new KeyboardShortcut(childProps);\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n      });\n    } else {\n      throw new UiError(\n        UiFramework.loggerCategory(this),\n        `Either 'item', 'execute' or 'shortcuts' must be specified for '${props.key}' key.`\n      );\n    }\n\n    if (props.isAltKeyRequired !== undefined)\n      this._isAltKeyRequired = props.isAltKeyRequired;\n    if (props.isCtrlKeyRequired !== undefined)\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\n    if (props.isShiftKeyRequired !== undefined)\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\n  }\n\n  /** Returns the id for this shortcut */\n  public get id(): string {\n    return this.keyMapKey;\n  }\n\n  /** Returns the shortcut container */\n  public get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(mapKey);\n  }\n\n  /** Returns the shortcut's key map key used as the id */\n  public get keyMapKey(): string {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      this.key,\n      this._isAltKeyRequired,\n      this._isCtrlKeyRequired,\n      this._isShiftKeyRequired\n    );\n    return keyMapKey;\n  }\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  public get item(): ActionButtonItemDef | undefined {\n    return this._item;\n  }\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  public itemPicked(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    } else {\n      setTimeout(() => {\n        if (this._item) this._item.execute();\n        else if (this._execute) this._execute();\n      });\n    }\n  }\n\n  /** Gets the keyboard key */\n  public get key(): string {\n    return this._key;\n  }\n  /** Gets whether the Alt key required. */\n  public get isAltKeyRequired(): boolean {\n    return this._isAltKeyRequired;\n  }\n  /** Gets whether the Ctrl key required. */\n  public get isCtrlKeyRequired(): boolean {\n    return this._isCtrlKeyRequired;\n  }\n  /** Gets whether the Shift key required. */\n  public get isShiftKeyRequired(): boolean {\n    return this._isShiftKeyRequired;\n  }\n  /** Gets whether this is a Function key. */\n  public get isFunctionKey(): boolean {\n    return this._isFunctionKey;\n  }\n  /** Gets whether this is a Special key. */\n  public get isSpecialKey(): boolean {\n    return this._isSpecialKey;\n  }\n}\n\n/** Keyboard Shortcut Container\n * @public\n * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.\n */\nexport class KeyboardShortcutContainer {\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<\n    string,\n    KeyboardShortcut\n  >();\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\n\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  public registerKey(\n    keyMapKey: string,\n    inShortcut: KeyboardShortcut\n  ): KeyboardShortcut | undefined {\n    let shortcut: KeyboardShortcut | undefined;\n\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\n      shortcut = inShortcut;\n      this._keyArray.push(shortcut);\n    } else {\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\n        return value.keyMapKey === keyMapKey;\n      });\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    if (shortcut) this._keyMap.set(keyMapKey, shortcut);\n\n    return shortcut;\n  }\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._keyMap.get(keyMapKey);\n  }\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  public areKeyboardShortcutsAvailable(): boolean {\n    return this._keyMap.size !== 0;\n  }\n\n  /** Empties any Keyboard Shortcuts from this container */\n  public emptyData(): void {\n    this._keyMap.clear();\n    this._keyArray.length = 0;\n  }\n\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\n    return this._keyArray.slice();\n  }\n\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\n  public static generateKeyMapKey(\n    keyboardKey: string,\n    isAltKeyRequired: boolean,\n    isCtrlKeyRequired: boolean,\n    isShiftKeyRequired: boolean\n  ): string {\n    let keyMapKey = keyboardKey;\n\n    if (isAltKeyRequired) keyMapKey = `Alt+${keyMapKey}`;\n    if (isShiftKeyRequired) keyMapKey = `Shift+${keyMapKey}`;\n    if (isCtrlKeyRequired) keyMapKey = `Ctrl+${keyMapKey}`;\n\n    return keyMapKey;\n  }\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  public showShortcutsMenu() {\n    const offset = 8;\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: true,\n      menuX: UiFramework.keyboardShortcuts.cursorX - offset,\n      menuY: UiFramework.keyboardShortcuts.cursorY - offset,\n      shortcuts: this.getAvailableKeyboardShortcuts(),\n    });\n  }\n}\n"]}

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutMenu.d.ts

@@ -5,8 +5,9 @@ import * as React from "react";
 import type { CommonProps } from "@itwin/core-react";
 import type { KeyboardShortcut } from "./KeyboardShortcut";
 import { UiEvent } from "@itwin/appui-abstract";
-/** State for a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component
+/** State of a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component
  * @public
+ * @deprecated in 4.15.0. Used internally by {@link KeyboardShortcutMenu} component.
  */
 export interface KeyboardShortcutMenuState {
     menuVisible: boolean;
@@ -16,12 +17,13 @@ export interface KeyboardShortcutMenuState {
 }
 /** KeyboardShortcut Menu Event class.
  * @public
- * @deprecated in 4.13.x. This class should not be used by applications to instantiate objects.
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
  */
 export declare class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> {
 }
 /** React component that displays a context menu at the cursor containing keyboard shortcuts.
  * @public
+ * @deprecated in 4.15.0. Component used internally to display keyboard shortcuts in a context menu.
  */
 export declare class KeyboardShortcutMenu extends React.PureComponent<CommonProps, KeyboardShortcutMenuState> {
     /** @internal */

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutMenu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcutMenu.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAA2B,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAED;;;GAGG;AAEH,qBAAa,yBAA0B,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAAG;AAEpF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,KAAK,CAAC,aAAa,CAC3D,WAAW,EACX,yBAAyB,CAC1B;IACC,gBAAgB;IAChB,SAAyB,KAAK,EAAE,yBAAyB,CAIvD;IAEF,uCAAuC;IACvC,gBAAuB,2BAA2B,4BAChB;IAElB,iBAAiB;IAMjB,oBAAoB;IAMpC,OAAO,CAAC,gCAAgC,CAItC;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IA6BzC,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,mBAAmB;IAsD3B,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,WAAW,CAGjB;CACH"}
+{"version":3,"file":"KeyboardShortcutMenu.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAA2B,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIzE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAAG;AAEpF;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,KAAK,CAAC,aAAa,CAC3D,WAAW,EACX,yBAAyB,CAC1B;IACC,gBAAgB;IAChB,SAAyB,KAAK,EAAE,yBAAyB,CAIvD;IAEF,uCAAuC;IACvC,gBAAuB,2BAA2B,4BAChB;IAElB,iBAAiB;IAMjB,oBAAoB;IAMpC,OAAO,CAAC,gCAAgC,CAItC;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IA6BzC,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,mBAAmB;IAsD3B,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,WAAW,CAGjB;CACH"}

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

@@ -10,13 +10,13 @@ import { ContextMenuItem, ContextSubMenu, GlobalContextMenu, } from "@itwin/core
 import { ConditionalBooleanValue, UiEvent } from "@itwin/appui-abstract";
 /** KeyboardShortcut Menu Event class.
  * @public
- * @deprecated in 4.13.x. This class should not be used by applications to instantiate objects.
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
  */
-// eslint-disable-next-line deprecation/deprecation
 export class KeyboardShortcutMenuEvent extends UiEvent {
 }
 /** React component that displays a context menu at the cursor containing keyboard shortcuts.
  * @public
+ * @deprecated in 4.15.0. Component used internally to display keyboard shortcuts in a context menu.
  */
 export class KeyboardShortcutMenu extends React.PureComponent {
     constructor() {
@@ -90,5 +90,5 @@ export class KeyboardShortcutMenu extends React.PureComponent {
     }
 }
 /** Get KeyboardShortcut Menu Event. */
-KeyboardShortcutMenu.onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent(); // eslint-disable-line deprecation/deprecation
+KeyboardShortcutMenu.onKeyboardShortcutMenuEvent = new KeyboardShortcutMenuEvent();
 //# 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;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYzE;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,yBAA0B,SAAQ,OAAkC;CAAG;AAEpF;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK,CAAC,aAG/C;IAHD;;QAIE,gBAAgB;QACS,UAAK,GAA8B;YAC1D,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;SACT,CAAC;QAkBM,qCAAgC,GAAG,CACzC,KAAgC,EAChC,EAAE;YACF,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QAoGM,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;IA5HiB,iBAAiB;QAC/B,oBAAoB,CAAC,2BAA2B,CAAC,WAAW,CAC1D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAEe,oBAAoB;QAClC,oBAAoB,CAAC,2BAA2B,CAAC,cAAc,CAC7D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAQe,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,CAAC;YAChB,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;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAC1B,SAA8B;QAE9B,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,KAAa,EAAE,EAAE;gBAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvD,IAAI,IAAI;oBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,mBAAmB,CACzB,QAA0B,EAC1B,KAAa;QAEb,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAErE,gDAAgD;QAChD,IACE,WAAW,KAAK,QAAQ,CAAC,SAAS;YAClC,QAAQ,CAAC,aAAa;YACtB,QAAQ,CAAC,YAAY;YACrB,QAAQ;YAER,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,CAAC;YAC/D,MAAM,SAAS,GACb,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,IAAI,GAAG,CACL,oBAAC,cAAc,IACb,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,CAAC,UAAU,IAE5B,KAAK,CACS,CAClB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,GAAG,CACL,oBAAC,eAAe,IACd,GAAG,EAAE,KAAK,EACV,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,QAAQ,CAAC,UAAU,IAE5B,KAAK,CACU,CACnB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAtHD,uCAAuC;AAChB,gDAA2B,GAChD,IAAI,yBAAyB,EAAE,AADiB,CAChB,CAAC,8CAA8C","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 KeyboardShortcut\n */\n\nimport * as React from \"react\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport {\n  ContextMenuItem,\n  ContextSubMenu,\n  GlobalContextMenu,\n} from \"@itwin/core-react\";\nimport type { KeyboardShortcut } from \"./KeyboardShortcut\";\nimport { ConditionalBooleanValue, UiEvent } from \"@itwin/appui-abstract\";\n\n/** State for a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component\n * @public\n */\nexport interface KeyboardShortcutMenuState {\n  menuVisible: boolean;\n  menuX: number;\n  menuY: number;\n  shortcuts?: KeyboardShortcut[];\n}\n\n/** KeyboardShortcut Menu Event class.\n * @public\n * @deprecated in 4.13.x. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> {}\n\n/** React component that displays a context menu at the cursor containing keyboard shortcuts.\n * @public\n */\nexport class KeyboardShortcutMenu extends React.PureComponent<\n  CommonProps,\n  KeyboardShortcutMenuState\n> {\n  /** @internal */\n  public override readonly state: KeyboardShortcutMenuState = {\n    menuVisible: false,\n    menuX: 0,\n    menuY: 0,\n  };\n\n  /** Get KeyboardShortcut Menu Event. */\n  public static readonly onKeyboardShortcutMenuEvent =\n    new KeyboardShortcutMenuEvent(); // eslint-disable-line deprecation/deprecation\n\n  public override componentDidMount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  public override componentWillUnmount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  private _handleKeyboardShortcutMenuEvent = (\n    state: KeyboardShortcutMenuState\n  ) => {\n    this.setState(state);\n  };\n\n  public override render(): React.ReactNode {\n    const { shortcuts, menuX, menuY, menuVisible } = this.state;\n    const onClose = this._hideContextMenu;\n\n    if (menuVisible) {\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      return (\n        <GlobalContextMenu\n          className={this.props.className}\n          style={this.props.style}\n          identifier=\"keyboard-shortcuts\"\n          x={menuX}\n          y={menuY}\n          opened={menuVisible}\n          onEsc={onClose}\n          onOutsideClick={onClose}\n          edgeLimit={false}\n          autoflip={true}\n          ignoreNextKeyUp={true} // Executing the shortcut on the keydown, so ignore the keyup in the menu\n        >\n          {items}\n        </GlobalContextMenu>\n      );\n    }\n\n    return null;\n  }\n\n  private getShortcutMenuItems(\n    shortcuts?: KeyboardShortcut[]\n  ): React.ReactNode[] {\n    const items: React.ReactNode[] = [];\n\n    if (shortcuts) {\n      shortcuts.forEach((shortcut: KeyboardShortcut, index: number) => {\n        const item = this.getShortcutMenuItem(shortcut, index);\n        if (item) items.push(item);\n      });\n    }\n\n    return items;\n  }\n\n  private getShortcutMenuItem(\n    shortcut: KeyboardShortcut,\n    index: number\n  ): React.ReactNode {\n    const shortcutKey = shortcut.key;\n    const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);\n\n    // Only pure characters go into the context menu\n    if (\n      shortcutKey !== shortcut.keyMapKey ||\n      shortcut.isFunctionKey ||\n      shortcut.isSpecialKey ||\n      isHidden\n    )\n      return null;\n\n    let node: React.ReactNode = null;\n    let label = shortcut.label;\n    const iconSpec = shortcut.iconSpec;\n\n    label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;\n\n    if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n      const shortcuts =\n        shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      node = (\n        <ContextSubMenu\n          key={index}\n          icon={iconSpec}\n          label={label}\n          disabled={shortcut.isDisabled}\n        >\n          {items}\n        </ContextSubMenu>\n      );\n    } else {\n      const sel = () => this._itemPicked(shortcut);\n      node = (\n        <ContextMenuItem\n          key={index}\n          onSelect={sel}\n          icon={iconSpec}\n          disabled={shortcut.isDisabled}\n        >\n          {label}\n        </ContextMenuItem>\n      );\n    }\n\n    return node;\n  }\n\n  private _hideContextMenu = () => {\n    this.setState({ menuVisible: false, shortcuts: undefined });\n  };\n\n  private _itemPicked = (shortcut: KeyboardShortcut): void => {\n    this._hideContextMenu();\n    shortcut.itemPicked();\n  };\n}\n"]}
+{"version":3,"file":"KeyboardShortcutMenu.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAezE;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAkC;CAAG;AAEpF;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK,CAAC,aAG/C;IAHD;;QAIE,gBAAgB;QACS,UAAK,GAA8B;YAC1D,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;SACT,CAAC;QAkBM,qCAAgC,GAAG,CACzC,KAAgC,EAChC,EAAE;YACF,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QAoGM,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;IA5HiB,iBAAiB;QAC/B,oBAAoB,CAAC,2BAA2B,CAAC,WAAW,CAC1D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAEe,oBAAoB;QAClC,oBAAoB,CAAC,2BAA2B,CAAC,cAAc,CAC7D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAQe,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,CAAC;YAChB,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;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAC1B,SAA8B;QAE9B,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,KAAa,EAAE,EAAE;gBAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvD,IAAI,IAAI;oBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,mBAAmB,CACzB,QAA0B,EAC1B,KAAa;QAEb,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAErE,gDAAgD;QAChD,IACE,WAAW,KAAK,QAAQ,CAAC,SAAS;YAClC,QAAQ,CAAC,aAAa;YACtB,QAAQ,CAAC,YAAY;YACrB,QAAQ;YAER,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,CAAC;YAC/D,MAAM,SAAS,GACb,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,IAAI,GAAG,CACL,oBAAC,cAAc,IACb,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,CAAC,UAAU,IAE5B,KAAK,CACS,CAClB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,GAAG,CACL,oBAAC,eAAe,IACd,GAAG,EAAE,KAAK,EACV,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,QAAQ,CAAC,UAAU,IAE5B,KAAK,CACU,CACnB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAtHD,uCAAuC;AAChB,gDAA2B,GAChD,IAAI,yBAAyB,EAAE,AADiB,CAChB","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 KeyboardShortcut\n */\n\nimport * as React from \"react\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport {\n  ContextMenuItem,\n  ContextSubMenu,\n  GlobalContextMenu,\n} from \"@itwin/core-react\";\nimport type { KeyboardShortcut } from \"./KeyboardShortcut\";\nimport { ConditionalBooleanValue, UiEvent } from \"@itwin/appui-abstract\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** State of a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component\n * @public\n * @deprecated in 4.15.0. Used internally by {@link KeyboardShortcutMenu} component.\n */\nexport interface KeyboardShortcutMenuState {\n  menuVisible: boolean;\n  menuX: number;\n  menuY: number;\n  shortcuts?: KeyboardShortcut[];\n}\n\n/** KeyboardShortcut Menu Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> {}\n\n/** React component that displays a context menu at the cursor containing keyboard shortcuts.\n * @public\n * @deprecated in 4.15.0. Component used internally to display keyboard shortcuts in a context menu.\n */\nexport class KeyboardShortcutMenu extends React.PureComponent<\n  CommonProps,\n  KeyboardShortcutMenuState\n> {\n  /** @internal */\n  public override readonly state: KeyboardShortcutMenuState = {\n    menuVisible: false,\n    menuX: 0,\n    menuY: 0,\n  };\n\n  /** Get KeyboardShortcut Menu Event. */\n  public static readonly onKeyboardShortcutMenuEvent =\n    new KeyboardShortcutMenuEvent();\n\n  public override componentDidMount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  public override componentWillUnmount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  private _handleKeyboardShortcutMenuEvent = (\n    state: KeyboardShortcutMenuState\n  ) => {\n    this.setState(state);\n  };\n\n  public override render(): React.ReactNode {\n    const { shortcuts, menuX, menuY, menuVisible } = this.state;\n    const onClose = this._hideContextMenu;\n\n    if (menuVisible) {\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      return (\n        <GlobalContextMenu\n          className={this.props.className}\n          style={this.props.style}\n          identifier=\"keyboard-shortcuts\"\n          x={menuX}\n          y={menuY}\n          opened={menuVisible}\n          onEsc={onClose}\n          onOutsideClick={onClose}\n          edgeLimit={false}\n          autoflip={true}\n          ignoreNextKeyUp={true} // Executing the shortcut on the keydown, so ignore the keyup in the menu\n        >\n          {items}\n        </GlobalContextMenu>\n      );\n    }\n\n    return null;\n  }\n\n  private getShortcutMenuItems(\n    shortcuts?: KeyboardShortcut[]\n  ): React.ReactNode[] {\n    const items: React.ReactNode[] = [];\n\n    if (shortcuts) {\n      shortcuts.forEach((shortcut: KeyboardShortcut, index: number) => {\n        const item = this.getShortcutMenuItem(shortcut, index);\n        if (item) items.push(item);\n      });\n    }\n\n    return items;\n  }\n\n  private getShortcutMenuItem(\n    shortcut: KeyboardShortcut,\n    index: number\n  ): React.ReactNode {\n    const shortcutKey = shortcut.key;\n    const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);\n\n    // Only pure characters go into the context menu\n    if (\n      shortcutKey !== shortcut.keyMapKey ||\n      shortcut.isFunctionKey ||\n      shortcut.isSpecialKey ||\n      isHidden\n    )\n      return null;\n\n    let node: React.ReactNode = null;\n    let label = shortcut.label;\n    const iconSpec = shortcut.iconSpec;\n\n    label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;\n\n    if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n      const shortcuts =\n        shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      node = (\n        <ContextSubMenu\n          key={index}\n          icon={iconSpec}\n          label={label}\n          disabled={shortcut.isDisabled}\n        >\n          {items}\n        </ContextSubMenu>\n      );\n    } else {\n      const sel = () => this._itemPicked(shortcut);\n      node = (\n        <ContextMenuItem\n          key={index}\n          onSelect={sel}\n          icon={iconSpec}\n          disabled={shortcut.isDisabled}\n        >\n          {label}\n        </ContextMenuItem>\n      );\n    }\n\n    return node;\n  }\n\n  private _hideContextMenu = () => {\n    this.setState({ menuVisible: false, shortcuts: undefined });\n  };\n\n  private _itemPicked = (shortcut: KeyboardShortcut): void => {\n    this._hideContextMenu();\n    shortcut.itemPicked();\n  };\n}\n"]}

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutProps.d.ts

@@ -0,0 +1,60 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import type { Key } from "ts-key-enum";
+import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import type { ConditionalBooleanValue, ConditionalStringValue } from "../shared/ConditionalValue";
+import type { BadgeType, IconProps, IconSpec } from "@itwin/core-react";
+import type { StringGetter } from "@itwin/appui-abstract";
+/** Properties for a Keyboard Shortcut
+ * @public
+ */
+export interface KeyboardShortcutProps extends IconProps {
+    /** The key that invokes the shortcut.
+     * This is either an alphanumeric key, a function key or a special key.
+     */
+    key: string | Key;
+    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified.
+     * @deprecated in 4.15.0. Use properties of this object instead.
+     */
+    item?: ActionButtonItemDef;
+    /** Function to run when the keyboard shortcut is executed. */
+    execute?: () => void;
+    /** Nested array of shortcut props.
+     * @note `execute` is ignored if `shortcuts` is specified.
+     */
+    shortcuts?: KeyboardShortcutProps[];
+    /** Indicates whether the Alt key required. Default - false */
+    isAltKeyRequired?: boolean;
+    /** Indicates whether the Ctrl key required. Default - false */
+    isCtrlKeyRequired?: boolean;
+    /** Indicates whether the Shift key required. Default - false */
+    isShiftKeyRequired?: boolean;
+    /** if true component will be hidden - defaults to false */
+    isHidden?: boolean | ConditionalBooleanValue;
+    /** if true component will be disabled - defaults to false */
+    isDisabled?: boolean | ConditionalBooleanValue;
+    /** if set, component will be considered "active" an will display an "active stripe" - defaults to false */
+    isActive?: boolean;
+    /** if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. Typically used by buttons that toggle between two states. */
+    isPressed?: boolean;
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Badge to be overlaid on the item. */
+    badgeType?: BadgeType;
+    /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */
+    icon?: IconSpec;
+    /** if set, it is used to explicitly set the label shown by a component. */
+    label?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    labelKey?: string;
+    /** if set, it is used to explicitly set the description shown by a component. */
+    description?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */
+    descriptionKey?: string;
+    /** used to explicitly set the tooltip shown by a component. */
+    tooltip?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    tooltipKey?: string;
+}
+//# sourceMappingURL=KeyboardShortcutProps.d.ts.map

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAElB;;OAEG;IAEH,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEpC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAI7B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,2GAA2G;IAC3G,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2KAA2K;IAC3K,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,wCAAwC;IACxC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,2FAA2F;IAC3F,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IACvD,6IAA6I;IAC7I,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IAC7D,mJAAmJ;IACnJ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IACzD,6IAA6I;IAC7I,UAAU,CAAC,EAAE,MAAM,CAAC;CAGrB"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=KeyboardShortcutProps.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutProps.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutProps.ts"],"names":[],"mappings":"","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 KeyboardShortcut\n */\nimport type { Key } from \"ts-key-enum\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"../shared/ConditionalValue\";\nimport type { BadgeType, IconProps, IconSpec } from \"@itwin/core-react\";\nimport type { StringGetter } from \"@itwin/appui-abstract\";\n\n/** Properties for a Keyboard Shortcut\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface KeyboardShortcutProps extends IconProps {\n  /** The key that invokes the shortcut.\n   * This is either an alphanumeric key, a function key or a special key.\n   */\n  key: string | Key;\n\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  item?: ActionButtonItemDef;\n  /** Function to run when the keyboard shortcut is executed. */\n  execute?: () => void;\n\n  /** Nested array of shortcut props.\n   * @note `execute` is ignored if `shortcuts` is specified.\n   */\n  shortcuts?: KeyboardShortcutProps[];\n\n  /** Indicates whether the Alt key required. Default - false */\n  isAltKeyRequired?: boolean;\n  /** Indicates whether the Ctrl key required. Default - false */\n  isCtrlKeyRequired?: boolean;\n  /** Indicates whether the Shift key required. Default - false */\n  isShiftKeyRequired?: boolean;\n\n  // #region \"ItemProps\" properties previously extended from deprecated type.\n\n  /** if true component will be hidden - defaults to false */\n  isHidden?: boolean | ConditionalBooleanValue;\n  /** if true component will be disabled - defaults to false */\n  isDisabled?: boolean | ConditionalBooleanValue;\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\n  isActive?: boolean;\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  isPressed?: boolean;\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Badge to be overlaid on the item. */\n  badgeType?: BadgeType;\n  /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */\n  icon?: IconSpec;\n\n  /** if set, it is used to explicitly set the label shown by a component. */\n  label?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  labelKey?: string;\n\n  /** if set, it is used to explicitly set the description shown by a component. */\n  description?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */\n  descriptionKey?: string;\n  /** used to explicitly set the tooltip shown by a component. */\n  tooltip?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  tooltipKey?: string;\n\n  // #endregion \"ItemProps\"\n}\n"]}

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutUtilities.d.ts

@@ -0,0 +1,13 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import type { KeyboardShortcutProps } from "./KeyboardShortcutProps";
+import { type ToolType } from "@itwin/core-frontend";
+/** Helper class to create keyboard shortcuts.
+ * @beta
+ */
+export declare namespace KeyboardShortcutUtilities {
+    /** Creates an shortcut from the specified tool type. */
+    function createForTool(key: string, toolType: ToolType, overrides?: Partial<KeyboardShortcutProps>): KeyboardShortcutProps;
+}
+//# sourceMappingURL=KeyboardShortcutUtilities.d.ts.map

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcutUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcutUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhE;;GAEG;AACH,yBAAiB,yBAAyB,CAAC;IACzC,wDAAwD;IACxD,SAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,QAAQ,EAClB,SAAS,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACzC,qBAAqB,CAWvB;CACF"}