@itwin/appui-react 3.6.1 → 3.7.0-dev.2

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.d.ts

@@ -1,36 +1,36 @@
-/** @packageDocumentation
- * @module IModelComponents
- */
-/// <reference types="react" />
-import "./SpatialContainmentTree.scss";
-import { IModelConnection } from "@itwin/core-frontend";
-import { Ruleset } from "@itwin/presentation-common";
-import { ClassGroupingOption } from "../Common";
-/** @internal */
-export declare const RULESET_SPATIAL_BREAKDOWN: Ruleset;
-/** @internal */
-export declare const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset;
-/**
- * Properties for the [[SpatialContainmentTree]] component
- * @public
- * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
- */
-export interface SpatialContainmentTreeProps {
-    iModel: IModelConnection;
-    /** Width of the component */
-    width: number;
-    /** Height of the component */
-    height: number;
-    /**
-     * Should the tree group displayed element nodes by class.
-     * @beta
-     */
-    enableElementsClassGrouping?: ClassGroupingOption;
-}
-/**
- * Tree which displays and manages models or categories contained in an iModel.
- * @public
- * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
- */
-export declare function SpatialContainmentTree(props: SpatialContainmentTreeProps): JSX.Element;
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+/// <reference types="react" />
+import "./SpatialContainmentTree.scss";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Ruleset } from "@itwin/presentation-common";
+import { ClassGroupingOption } from "../Common";
+/** @internal */
+export declare const RULESET_SPATIAL_BREAKDOWN: Ruleset;
+/** @internal */
+export declare const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset;
+/**
+ * Properties for the [[SpatialContainmentTree]] component
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export interface SpatialContainmentTreeProps {
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+    /**
+     * Should the tree group displayed element nodes by class.
+     * @beta
+     */
+    enableElementsClassGrouping?: ClassGroupingOption;
+}
+/**
+ * Tree which displays and manages models or categories contained in an iModel.
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export declare function SpatialContainmentTree(props: SpatialContainmentTreeProps): JSX.Element;
 //# sourceMappingURL=SpatialContainmentTree.d.ts.map

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.js

@@ -1,40 +1,40 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module IModelComponents
- */
-/* eslint-disable deprecation/deprecation */
-import "./SpatialContainmentTree.scss";
-import * as React from "react";
-import { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from "@itwin/presentation-components";
-import { ControlledTree, SelectionMode, useTreeModel } from "@itwin/components-react";
-import { useDisposable } from "@itwin/core-react";
-import { ClassGroupingOption } from "../Common";
-const PAGING_SIZE = 20;
-/** @internal */
-export const RULESET_SPATIAL_BREAKDOWN = require("./SpatialBreakdown.json"); // eslint-disable-line @typescript-eslint/no-var-requires
-/** @internal */
-export const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS = require("./SpatialBreakdown.GroupedByClass.json"); // eslint-disable-line @typescript-eslint/no-var-requires
-/**
- * Tree which displays and manages models or categories contained in an iModel.
- * @public
- * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
- */
-export function SpatialContainmentTree(props) {
-    const { nodeLoader } = usePresentationTreeNodeLoader({
-        imodel: props.iModel,
-        ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,
-        appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),
-        pagingSize: PAGING_SIZE,
-    });
-    const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({
-        nodeLoader,
-        collapsedChildrenDisposalEnabled: true,
-    }), [nodeLoader]));
-    const treeModel = useTreeModel(nodeLoader.modelSource);
-    return (React.createElement("div", { className: "ui-fw-spatial-tree" },
-        React.createElement(ControlledTree, { model: treeModel, nodeLoader: nodeLoader, eventsHandler: eventHandler, selectionMode: SelectionMode.Extended, width: props.width, height: props.height })));
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+/* eslint-disable deprecation/deprecation */
+import "./SpatialContainmentTree.scss";
+import * as React from "react";
+import { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from "@itwin/presentation-components";
+import { ControlledTree, SelectionMode, useTreeModel } from "@itwin/components-react";
+import { useDisposable } from "@itwin/core-react";
+import { ClassGroupingOption } from "../Common";
+const PAGING_SIZE = 20;
+/** @internal */
+export const RULESET_SPATIAL_BREAKDOWN = require("./SpatialBreakdown.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/** @internal */
+export const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS = require("./SpatialBreakdown.GroupedByClass.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/**
+ * Tree which displays and manages models or categories contained in an iModel.
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export function SpatialContainmentTree(props) {
+    const { nodeLoader } = usePresentationTreeNodeLoader({
+        imodel: props.iModel,
+        ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,
+        appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),
+        pagingSize: PAGING_SIZE,
+    });
+    const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({
+        nodeLoader,
+        collapsedChildrenDisposalEnabled: true,
+    }), [nodeLoader]));
+    const treeModel = useTreeModel(nodeLoader.modelSource);
+    return (React.createElement("div", { className: "ui-fw-spatial-tree" },
+        React.createElement(ControlledTree, { model: treeModel, nodeLoader: nodeLoader, eventsHandler: eventHandler, selectionMode: SelectionMode.Extended, width: props.width, height: props.height })));
+}
 //# sourceMappingURL=SpatialContainmentTree.js.map

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpatialContainmentTree.js","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,+BAA+B,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,gCAAgC,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACjH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAY,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,yDAAyD;AAC/I,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAAY,OAAO,CAAC,wCAAwC,CAAC,CAAC,CAAC,yDAAyD;AAoB/K;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,EAAE,UAAU,EAAE,GAAG,6BAA6B,CAAC;QACnD,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,0BAA0B,CAAC,0CAA0C;QACjJ,mCAAmC,EAAE,CAAC,KAAK,CAAC,2BAA2B,KAAK,mBAAmB,CAAC,aAAa,CAAC;QAC9G,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,gCAAgC,CAAC;QAC9F,UAAU;QACV,gCAAgC,EAAE,IAAI;KACvC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,CACL,6BAAK,SAAS,EAAC,oBAAoB;QACjC,oBAAC,cAAc,IACb,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,YAAY,EAC3B,aAAa,EAAE,aAAa,CAAC,QAAQ,EACrC,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB,CACE,CACP,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelComponents\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport \"./SpatialContainmentTree.scss\";\r\nimport * as React from \"react\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { Ruleset } from \"@itwin/presentation-common\";\r\nimport { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\r\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\r\nimport { useDisposable } from \"@itwin/core-react\";\r\nimport { ClassGroupingOption } from \"../Common\";\r\n\r\nconst PAGING_SIZE = 20;\r\n\r\n/** @internal */\r\nexport const RULESET_SPATIAL_BREAKDOWN: Ruleset = require(\"./SpatialBreakdown.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n/** @internal */\r\nexport const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset = require(\"./SpatialBreakdown.GroupedByClass.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n\r\n/**\r\n * Properties for the [[SpatialContainmentTree]] component\r\n * @public\r\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\r\n */\r\nexport interface SpatialContainmentTreeProps {\r\n  iModel: IModelConnection;\r\n  /** Width of the component */\r\n  width: number;\r\n  /** Height of the component */\r\n  height: number;\r\n  /**\r\n   * Should the tree group displayed element nodes by class.\r\n   * @beta\r\n   */\r\n  enableElementsClassGrouping?: ClassGroupingOption;\r\n}\r\n\r\n/**\r\n * Tree which displays and manages models or categories contained in an iModel.\r\n * @public\r\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\r\n */\r\nexport function SpatialContainmentTree(props: SpatialContainmentTreeProps) {\r\n  const { nodeLoader } = usePresentationTreeNodeLoader({\r\n    imodel: props.iModel,\r\n    ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,\r\n    appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),\r\n    pagingSize: PAGING_SIZE,\r\n  });\r\n\r\n  const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({\r\n    nodeLoader,\r\n    collapsedChildrenDisposalEnabled: true,\r\n  }), [nodeLoader]));\r\n  const treeModel = useTreeModel(nodeLoader.modelSource);\r\n\r\n  return (\r\n    <div className=\"ui-fw-spatial-tree\">\r\n      <ControlledTree\r\n        model={treeModel}\r\n        nodeLoader={nodeLoader}\r\n        eventsHandler={eventHandler}\r\n        selectionMode={SelectionMode.Extended}\r\n        width={props.width}\r\n        height={props.height}\r\n      />\r\n    </div>\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"SpatialContainmentTree.js","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,+BAA+B,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,gCAAgC,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACjH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAY,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,yDAAyD;AAC/I,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAAY,OAAO,CAAC,wCAAwC,CAAC,CAAC,CAAC,yDAAyD;AAoB/K;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,EAAE,UAAU,EAAE,GAAG,6BAA6B,CAAC;QACnD,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,0BAA0B,CAAC,0CAA0C;QACjJ,mCAAmC,EAAE,CAAC,KAAK,CAAC,2BAA2B,KAAK,mBAAmB,CAAC,aAAa,CAAC;QAC9G,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,gCAAgC,CAAC;QAC9F,UAAU;QACV,gCAAgC,EAAE,IAAI;KACvC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,CACL,6BAAK,SAAS,EAAC,oBAAoB;QACjC,oBAAC,cAAc,IACb,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,YAAY,EAC3B,aAAa,EAAE,aAAa,CAAC,QAAQ,EACrC,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB,CACE,CACP,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module IModelComponents\n */\n\n/* eslint-disable deprecation/deprecation */\n\nimport \"./SpatialContainmentTree.scss\";\nimport * as React from \"react\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { Ruleset } from \"@itwin/presentation-common\";\nimport { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\nimport { useDisposable } from \"@itwin/core-react\";\nimport { ClassGroupingOption } from \"../Common\";\n\nconst PAGING_SIZE = 20;\n\n/** @internal */\nexport const RULESET_SPATIAL_BREAKDOWN: Ruleset = require(\"./SpatialBreakdown.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n/** @internal */\nexport const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset = require(\"./SpatialBreakdown.GroupedByClass.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n\n/**\n * Properties for the [[SpatialContainmentTree]] component\n * @public\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\n */\nexport interface SpatialContainmentTreeProps {\n  iModel: IModelConnection;\n  /** Width of the component */\n  width: number;\n  /** Height of the component */\n  height: number;\n  /**\n   * Should the tree group displayed element nodes by class.\n   * @beta\n   */\n  enableElementsClassGrouping?: ClassGroupingOption;\n}\n\n/**\n * Tree which displays and manages models or categories contained in an iModel.\n * @public\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\n */\nexport function SpatialContainmentTree(props: SpatialContainmentTreeProps) {\n  const { nodeLoader } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,\n    appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),\n    pagingSize: PAGING_SIZE,\n  });\n\n  const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({\n    nodeLoader,\n    collapsedChildrenDisposalEnabled: true,\n  }), [nodeLoader]));\n  const treeModel = useTreeModel(nodeLoader.modelSource);\n\n  return (\n    <div className=\"ui-fw-spatial-tree\">\n      <ControlledTree\n        model={treeModel}\n        nodeLoader={nodeLoader}\n        eventsHandler={eventHandler}\n        selectionMode={SelectionMode.Extended}\n        width={props.width}\n        height={props.height}\n      />\n    </div>\n  );\n}\n"]}

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.scss

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-@import "../VisibilityTreeBase";
-
-.ui-fw-spatial-tree {
-  @include ui-fw-visibility-tree-base;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "../VisibilityTreeBase";
+
+.ui-fw-spatial-tree {
+  @include ui-fw-visibility-tree-base;
+}

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

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut";
+/** Keyboard Shortcut Manager
+ * @internal
+ */
+export declare class InternalKeyboardShortcutManager {
+    private static _shortcuts;
+    /** Initialize the Keyboard Shortcut manager
+     * @internal
+    */
+    static initialize(): void;
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer(): KeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome(): boolean;
+    /** Sets focus to Home */
+    static setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    static closeMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX(): number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY(): number;
+    private static _handleSyncUiEvent;
+    private static _traverseShortcuts;
+}
+//# sourceMappingURL=InternalKeyboardShortcut.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalKeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAEhF,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAKjF;;GAEG;AACH,qBAAa,+BAA+B;IAE1C,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8D;IAEvF;;MAEE;WACY,UAAU,IAAI,IAAI;IAIhC,qDAAqD;WACvC,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMjE,sDAAsD;WACxC,YAAY,CAAC,aAAa,EAAE,qBAAqB;IAK/D,qEAAqE;WACvD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,EAAE,gBAAgB,GAAE,OAAe,EAAE,iBAAiB,GAAE,OAAe,GAAG,OAAO;IAY/J,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,CAAsC;IACzE,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAAsC;IAEzE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAa/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAS/B;CAEH"}

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

@@ -0,0 +1,108 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { ConditionalBooleanValue } from "@itwin/appui-abstract";
+import { CursorInformation } from "../cursor/CursorInformation";
+import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu";
+import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+/** Keyboard Shortcut Manager
+ * @internal
+ */
+export class InternalKeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @internal
+    */
+    static initialize() {
+        SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);
+    }
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadShortcuts(shortcutList) {
+        shortcutList.forEach((shortcutProps) => {
+            this.loadShortcut(shortcutProps);
+        });
+    }
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadShortcut(shortcutProps) {
+        const shortcut = new KeyboardShortcut(shortcutProps);
+        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
+    }
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey, isAltKeyPressed = false, isCtrlKeyPressed = false, isShiftKeyPressed = false) {
+        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
+        const shortcut = this.getShortcut(keyMapKey);
+        if (shortcut) {
+            shortcut.itemPicked();
+            return true;
+        }
+        return false;
+    }
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer() {
+        return this._shortcuts;
+    }
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey) {
+        return this._shortcuts.findKey(keyMapKey);
+    }
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome() {
+        const element = document.activeElement;
+        return element && element === document.body;
+    }
+    /** Sets focus to Home */
+    static setFocusToHome() {
+        const element = document.activeElement;
+        if (element && element !== document.body) {
+            element.blur();
+            document.body.focus();
+        }
+    }
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayMenu() {
+        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
+            this._shortcuts.showShortcutsMenu();
+        }
+    }
+    /** Closes the Keyboard Shortcuts menu */
+    static closeMenu() {
+        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
+            menuVisible: false,
+            menuX: 0,
+            menuY: 0,
+            shortcuts: undefined,
+        });
+    }
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX() { return CursorInformation.cursorX; }
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY() { return CursorInformation.cursorY; }
+}
+InternalKeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
+InternalKeyboardShortcutManager._handleSyncUiEvent = (args) => {
+    const updateBooleanValue = (booleanValue) => {
+        if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
+            booleanValue.refresh();
+    };
+    const handleForSyncIds = (shortcut) => {
+        if (shortcut.isDisabled instanceof ConditionalBooleanValue)
+            updateBooleanValue(shortcut.isDisabled);
+        if (shortcut.isHidden instanceof ConditionalBooleanValue)
+            updateBooleanValue(shortcut.isHidden);
+    };
+    InternalKeyboardShortcutManager._traverseShortcuts(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);
+};
+InternalKeyboardShortcutManager._traverseShortcuts = (shortcuts, callback) => {
+    shortcuts.forEach((shortcut) => {
+        callback(shortcut);
+        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
+            const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
+            InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);
+        }
+    });
+};
+//# sourceMappingURL=InternalKeyboardShortcut.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAmB,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAIxE;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAI1C;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IACtG,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,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QAEjI,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;SACb;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;YACxC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;SACvB;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;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,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAhF1D,0CAAU,GAA8B,IAAI,yBAAyB,EAAE,CAAC;AAkFxE,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC;YACpF,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,CAAC,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACnJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAAC,SAA6B,EAAE,QAAwB,EAAE,EAAE;IAC9F,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAClF,+BAA+B,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SAC9E;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, UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\nimport { KeyboardShortcut, KeyboardShortcutContainer } from \"./KeyboardShortcut\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\n\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\n\n/** Keyboard Shortcut Manager\n * @internal\n */\nexport class InternalKeyboardShortcutManager {\n\n  private static _shortcuts: KeyboardShortcutContainer = new KeyboardShortcutContainer();\n\n  /** Initialize the Keyboard Shortcut manager\n   * @internal\n  */\n  public static initialize(): void {\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);\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(keyboardKey: string, isAltKeyPressed: boolean = false, isCtrlKeyPressed: boolean = false, isShiftKeyPressed: boolean = false): boolean {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\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 { return CursorInformation.cursorX; }\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  public static get cursorY(): number { return CursorInformation.cursorY; }\n\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))\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(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);\n  };\n\n  private static _traverseShortcuts = (shortcuts: KeyboardShortcut[], callback: OnShortcutFunc) => {\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\n      callback(shortcut);\n\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n        const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n        InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);\n      }\n    });\n  };\n\n}\n"]}

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

@@ -1,117 +1,97 @@
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
-import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
-import { ItemDefBase } from "../shared/ItemDefBase";
-import { ItemProps } from "../shared/ItemProps";
-/** Properties for a Keyboard Shortcut
- * @public
- */
-export interface KeyboardShortcutProps extends ItemProps {
-    /** The key that invokes the shortcut.
-     * This is either an alphanumeric key, a function key or a special key.
-     */
-    key: string | FunctionKey | SpecialKey;
-    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
-    item?: ActionButtonItemDef;
-    /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be 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;
-}
-/** Keyboard Shortcut used to execute an action
- * @public
- */
-export declare class KeyboardShortcut extends ItemDefBase {
-    private _key;
-    private _item?;
-    private _shortcuts;
-    private _isAltKeyRequired;
-    private _isCtrlKeyRequired;
-    private _isShiftKeyRequired;
-    private _isFunctionKey;
-    private _isSpecialKey;
-    constructor(props: KeyboardShortcutProps);
-    /** Returns the id for this shortcut */
-    get id(): string;
-    /** Returns the shortcut container */
-    get shortcutContainer(): KeyboardShortcutContainer;
-    /** Finds a shortcut with a given key in the shortcut's container */
-    getShortcut(mapKey: string): KeyboardShortcut | undefined;
-    /** Returns the shortcut's key map key used as the id */
-    get keyMapKey(): string;
-    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
-    get item(): ActionButtonItemDef | undefined;
-    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
-    itemPicked(): void;
-    /** Gets the keyboard key */
-    get key(): string;
-    /** Gets whether the Alt key required. */
-    get isAltKeyRequired(): boolean;
-    /** Gets whether the Ctrl key required. */
-    get isCtrlKeyRequired(): boolean;
-    /** Gets whether the Shift key required. */
-    get isShiftKeyRequired(): boolean;
-    /** Gets whether this is a Function key. */
-    get isFunctionKey(): boolean;
-    /** Gets whether this is a Special key. */
-    get isSpecialKey(): boolean;
-}
-/** Keyboard Shortcut Container
- * @public
- */
-export declare class KeyboardShortcutContainer {
-    private _keyMap;
-    private _keyArray;
-    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
-    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
-    /** Finds a Keyboard Shortcut associated with a given key */
-    findKey(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if any Keyboard Shortcuts are available in this container */
-    areKeyboardShortcutsAvailable(): boolean;
-    /** Empties any Keyboard Shortcuts from this container */
-    emptyData(): void;
-    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
-    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
-    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
-    /** Displays a menu for the Keyboard Shortcuts in this container */
-    showShortcutsMenu(): void;
-}
-/** Keyboard Shortcut Manager
- * @public
- */
-export declare class KeyboardShortcutManager {
-    private static _shortcuts;
-    /** Initialize the Keyboard Shortcut manager */
-    static initialize(): void;
-    /** Loads Keyboard Shortcuts into the managed list */
-    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
-    /** Loads a Keyboard Shortcut into the managed list */
-    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
-    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
-    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
-    /** Returns the managed list of Keyboard Shortcuts */
-    static get shortcutContainer(): KeyboardShortcutContainer;
-    /** Returns a Keyboard Shortcut from the managed lists */
-    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if focus is set to Home */
-    static get isFocusOnHome(): boolean;
-    /** Sets focus to Home */
-    static setFocusToHome(): void;
-    /** Displays the Keyboard Shortcuts menu at the cursor */
-    static displayShortcutsMenu(): void;
-    /** Closes the Keyboard Shortcuts menu */
-    static closeShortcutsMenu(): void;
-    /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX(): number;
-    /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY(): number;
-    private static _handleSyncUiEvent;
-    private static _traverseShortcuts;
-}
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export declare class KeyboardShortcut extends ItemDefBase {
+    private _key;
+    private _item?;
+    private _shortcuts;
+    private _isAltKeyRequired;
+    private _isCtrlKeyRequired;
+    private _isShiftKeyRequired;
+    private _isFunctionKey;
+    private _isSpecialKey;
+    constructor(props: KeyboardShortcutProps);
+    /** Returns the id for this shortcut */
+    get id(): string;
+    /** Returns the shortcut container */
+    get shortcutContainer(): KeyboardShortcutContainer;
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey: string): KeyboardShortcut | undefined;
+    /** Returns the shortcut's key map key used as the id */
+    get keyMapKey(): string;
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    get item(): ActionButtonItemDef | undefined;
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked(): void;
+    /** Gets the keyboard key */
+    get key(): string;
+    /** Gets whether the Alt key required. */
+    get isAltKeyRequired(): boolean;
+    /** Gets whether the Ctrl key required. */
+    get isCtrlKeyRequired(): boolean;
+    /** Gets whether the Shift key required. */
+    get isShiftKeyRequired(): boolean;
+    /** Gets whether this is a Function key. */
+    get isFunctionKey(): boolean;
+    /** Gets whether this is a Special key. */
+    get isSpecialKey(): boolean;
+}
+/** Keyboard Shortcut Container
+ * @public
+ */
+export declare class KeyboardShortcutContainer {
+    private _keyMap;
+    private _keyArray;
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable(): boolean;
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData(): void;
+    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
+    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
+    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu(): void;
+}
+/** Keyboard Shortcut Manager
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
+ */
+export declare class KeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize(): void;
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer(): KeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome(): boolean;
+    /** Sets focus to Home */
+    static setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayShortcutsMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    static closeShortcutsMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX(): number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY(): number;
+}
 //# sourceMappingURL=KeyboardShortcut.d.ts.map

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;AAEH,OAAO,EAA2B,WAAW,EAAE,UAAU,EAA4B,MAAM,uBAAuB,CAAC;AAEnH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAKhD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAEvC,yGAAyG;IACzG,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,sFAAsF;IACtF,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;CAC9B;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/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;IA2CxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAA2B;IAElD,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,CAG7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAYzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAAsB;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAAmC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAAoC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAAgC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAA+B;CAElE;AAED;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAAsE;IACrF,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAwBjG,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,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM;IAahJ,mEAAmE;IAC5D,iBAAiB;CASzB;AAID;;GAEG;AACH,qBAAa,uBAAuB;IAElC,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8D;IAEvF,+CAA+C;WACjC,UAAU,IAAI,IAAI;IAIhC,qDAAqD;WACvC,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMzE,sDAAsD;WACxC,oBAAoB,CAAC,aAAa,EAAE,qBAAqB;IAKvE,qEAAqE;WACvD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,EAAE,gBAAgB,GAAE,OAAe,EAAE,iBAAiB,GAAE,OAAe,GAAG,OAAO;IAY/J,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,oBAAoB,IAAI,IAAI;IAM1C,yCAAyC;WAC3B,kBAAkB,IAAI,IAAI;IASxC,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAAsC;IACzE,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAAsC;IAEzE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAa/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAS/B;CAEH"}
+{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAKhF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/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;IA2CxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAA2B;IAElD,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,CAG7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAYzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAAsB;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAAmC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAAoC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAAgC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAA+B;CAElE;AAED;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAAsE;IACrF,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAwBjG,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,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM;IAahJ,mEAAmE;IAC5D,iBAAiB;CASzB;AAED;;;GAGG;AACH,qBAAa,uBAAuB;IAClC;;MAEE;WACY,UAAU,IAAI,IAAI;IAIhC,qDAAqD;WACvC,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAIzE,sDAAsD;WACxC,oBAAoB,CAAC,aAAa,EAAE,qBAAqB;IAIvE,qEAAqE;WACvD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,EAAE,gBAAgB,GAAE,OAAe,EAAE,iBAAiB,GAAE,OAAe,GAAG,OAAO;IAI/J,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,CAEzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAIpC,yDAAyD;WAC3C,oBAAoB,IAAI,IAAI;IAI1C,yCAAyC;WAC3B,kBAAkB,IAAI,IAAI;IAIxC,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAA6B;IAChE,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAA6B;CACjE"}