@itwin/appui-react 4.10.0-dev.1 → 4.11.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"useConditionalValue.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useConditionalValue.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAYxE,iCAAiC;AACjC,SAAS,kBAAkB,CACzB,eAAmC;IAEnC,OAAO,CACL,OAAO,eAAe,KAAK,QAAQ;QACnC,eAAe;QACf,cAAc,IAAI,eAAe;QACjC,SAAS,IAAI,eAAe;QAC5B,OAAO,IAAI,eAAe,CAC3B,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,mBAAmB,CAAI,eAAmC;IACxE,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CACjC,CAAC,aAAyB,EAAE,EAAE;QAC5B,IAAI,kBAAkB,CAAC,eAAe,CAAC,EAAE;YACvC,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CACpD,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;gBACf,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC9D,OAAO;gBACT,eAAe,CAAC,OAAO,EAAE,CAAC;gBAC1B,aAAa,EAAE,CAAC;YAClB,CAAC,CACF,CAAC;SACH;QACD,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;IACF,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,IAAI,kBAAkB,CAAC,eAAe,CAAC;YAAE,OAAO,eAAe,CAAC,KAAK,CAAC;QACtE,OAAO,eAAe,CAAC;IACzB,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IACtB,OAAO,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AACtD,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 Utilities\n */\n\nimport * as React from \"react\";\nimport { useSyncExternalStore } from \"use-sync-external-store/shim\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\n\n/** Define a common interface for conditionals. */\ninterface ConditionalValue<T> {\n  syncEventIds: string[];\n  refresh: () => void;\n  value: T;\n}\n\n/** Type that is usually used in a conditional prop. */\ntype ConditionalProp<T> = ConditionalValue<T> | T | undefined;\n\n/** Duck type the conditional. */\nfunction isConditionalValue<T>(\n  conditionalProp: ConditionalProp<T>\n): conditionalProp is ConditionalValue<T> {\n  return (\n    typeof conditionalProp === \"object\" &&\n    conditionalProp &&\n    \"syncEventIds\" in conditionalProp &&\n    \"refresh\" in conditionalProp &&\n    \"value\" in conditionalProp\n  );\n}\n\n/** @internal */\nexport function useConditionalValue<T>(conditionalProp: ConditionalProp<T>) {\n  const subscribe = React.useCallback(\n    (onStoreChange: () => void) => {\n      if (isConditionalValue(conditionalProp)) {\n        return SyncUiEventDispatcher.onSyncUiEvent.addListener(\n          ({ eventIds }) => {\n            if (!conditionalProp.syncEventIds.some((id) => eventIds.has(id)))\n              return;\n            conditionalProp.refresh();\n            onStoreChange();\n          }\n        );\n      }\n      return () => {};\n    },\n    [conditionalProp]\n  );\n  const getSnapshot = React.useCallback(() => {\n    if (isConditionalValue(conditionalProp)) return conditionalProp.value;\n    return conditionalProp;\n  }, [conditionalProp]);\n  return useSyncExternalStore(subscribe, getSnapshot);\n}\n"]}

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

@@ -13,7 +13,7 @@ import { UiFramework } from "../UiFramework";
  */
 export function onEscapeSetFocusToHome(e) {
     // istanbul ignore else
-    if (e.key === Key.Escape) {
+    if (e.key === Key.Escape.valueOf()) {
         UiFramework.keyboardShortcuts.setFocusToHome();
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"useEscapeSetFocusToHome.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useEscapeSetFocusToHome.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,CAAsB;IAC3D,uBAAuB;IACvB,IAAI,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,EAAE;QACxB,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;KAChD;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,KAAK,CAAC,WAAW,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;AACvD,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 * as React from \"react\";\nimport { Key } from \"ts-key-enum\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** Keyboard Event handler to set focus to Home on Escape key\n * @internal\n */\nexport function onEscapeSetFocusToHome(e: React.KeyboardEvent): void {\n  // istanbul ignore else\n  if (e.key === Key.Escape) {\n    UiFramework.keyboardShortcuts.setFocusToHome();\n  }\n}\n\n/** useCallback Hook for Keyboard Event handler to set focus to Home on Escape key\n * @internal\n */\nexport function useEscapeSetFocusToHome() {\n  return React.useCallback(onEscapeSetFocusToHome, []);\n}\n"]}
+{"version":3,"file":"useEscapeSetFocusToHome.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useEscapeSetFocusToHome.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,CAAsB;IAC3D,uBAAuB;IACvB,IAAI,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;QAClC,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;KAChD;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,KAAK,CAAC,WAAW,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;AACvD,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 * as React from \"react\";\nimport { Key } from \"ts-key-enum\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** Keyboard Event handler to set focus to Home on Escape key\n * @internal\n */\nexport function onEscapeSetFocusToHome(e: React.KeyboardEvent): void {\n  // istanbul ignore else\n  if (e.key === Key.Escape.valueOf()) {\n    UiFramework.keyboardShortcuts.setFocusToHome();\n  }\n}\n\n/** useCallback Hook for Keyboard Event handler to set focus to Home on Escape key\n * @internal\n */\nexport function useEscapeSetFocusToHome() {\n  return React.useCallback(onEscapeSetFocusToHome, []);\n}\n"]}

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

@@ -10,25 +10,29 @@ import { ScheduleAnimationTimelineDataProvider } from "../timeline/ScheduleAnima
 /** @internal */
 // istanbul ignore next
 function useSupportsScheduleScript(viewport) {
-    const [supportsScheduleScript, setSupportsScheduleScript] = React.useState(!!viewport?.view?.scheduleScript);
+    var _a;
+    const [supportsScheduleScript, setSupportsScheduleScript] = React.useState(!!((_a = viewport === null || viewport === void 0 ? void 0 : viewport.view) === null || _a === void 0 ? void 0 : _a.scheduleScript));
     React.useEffect(() => {
-        setSupportsScheduleScript(!!viewport?.view?.scheduleScript);
+        var _a;
+        setSupportsScheduleScript(!!((_a = viewport === null || viewport === void 0 ? void 0 : viewport.view) === null || _a === void 0 ? void 0 : _a.scheduleScript));
     }, [viewport]);
     React.useEffect(() => {
         const handleViewChanged = (vp) => {
-            const hasScheduleScript = !!vp?.view?.scheduleScript;
+            var _a;
+            const hasScheduleScript = !!((_a = vp === null || vp === void 0 ? void 0 : vp.view) === null || _a === void 0 ? void 0 : _a.scheduleScript);
             if (hasScheduleScript !== supportsScheduleScript)
                 setSupportsScheduleScript(hasScheduleScript);
         };
-        return viewport?.onChangeView.addListener(handleViewChanged);
+        return viewport === null || viewport === void 0 ? void 0 : viewport.onChangeView.addListener(handleViewChanged);
     }, [supportsScheduleScript, viewport]);
     React.useEffect(() => {
         const handleDisplayStyleChange = (vp) => {
-            const hasScheduleScript = !!vp?.view?.scheduleScript;
+            var _a;
+            const hasScheduleScript = !!((_a = vp === null || vp === void 0 ? void 0 : vp.view) === null || _a === void 0 ? void 0 : _a.scheduleScript);
             if (hasScheduleScript !== supportsScheduleScript)
                 setSupportsScheduleScript(hasScheduleScript);
         };
-        return viewport?.onDisplayStyleChanged.addListener(handleDisplayStyleChange);
+        return viewport === null || viewport === void 0 ? void 0 : viewport.onDisplayStyleChanged.addListener(handleDisplayStyleChange);
     }, [viewport, supportsScheduleScript]);
     return supportsScheduleScript;
 }
@@ -49,7 +53,7 @@ export function useScheduleAnimationDataProvider(viewport) {
     React.useEffect(() => {
         async function fetchNewDataProvider(vp) {
             let newProvider = new ScheduleAnimationTimelineDataProvider(vp.view, vp);
-            if (newProvider?.supportsTimelineAnimation) {
+            if (newProvider === null || newProvider === void 0 ? void 0 : newProvider.supportsTimelineAnimation) {
                 const dataLoaded = await newProvider.loadTimelineData();
                 if (!dataLoaded)
                     newProvider = undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"useScheduleAnimationDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useScheduleAnimationDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,qCAAqC,EAAE,MAAM,uCAAuC,CAAC;AAG9F,gBAAgB;AAChB,uBAAuB;AACvB,SAAS,yBAAyB,CAAC,QAA8B;IAC/D,MAAM,CAAC,sBAAsB,EAAE,yBAAyB,CAAC,GAAG,KAAK,CAAC,QAAQ,CACxE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CACjC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,yBAAyB,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IAC9D,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;YAC/C,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,cAAc,CAAC;YACrD,IAAI,iBAAiB,KAAK,sBAAsB;gBAC9C,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,wBAAwB,GAAG,CAAC,EAAY,EAAQ,EAAE;YACtD,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,cAAc,CAAC;YACrD,IAAI,iBAAiB,KAAK,sBAAsB;gBAC9C,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,OAAO,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAChD,wBAAwB,CACzB,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACvC,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;IAEI;AACJ,uBAAuB;AACvB,MAAM,UAAU,gCAAgC,CAC9C,QAAoC;IAEpC,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnE,MAAM,CACJ,qCAAqC,EACrC,wCAAwC,EACzC,GAAG,KAAK,CAAC,QAAQ,EAAqD,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEzC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAC5B,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,KAAK,UAAU,oBAAoB,CAAC,EAAkB;YACpD,IAAI,WAAW,GACb,IAAI,qCAAqC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzD,IAAI,WAAW,EAAE,yBAAyB,EAAE;gBAC1C,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAI,CAAC,UAAU;oBAAE,WAAW,GAAG,SAAS,CAAC;aAC1C;YACD,YAAY,CAAC,OAAO;gBAClB,wCAAwC,CAAC,WAAW,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,sBAAsB,IAAI,QAAQ;YAAE,KAAK,oBAAoB,CAAC,QAAQ,CAAC,CAAC;;YAE1E,YAAY,CAAC,OAAO;gBAClB,wCAAwC,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,OAAO,qCAAqC,CAAC;AAC/C,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 * as React from \"react\";\nimport { ScheduleAnimationTimelineDataProvider } from \"../timeline/ScheduleAnimationProvider\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\n\n/** @internal */\n// istanbul ignore next\nfunction useSupportsScheduleScript(viewport: Viewport | undefined) {\n  const [supportsScheduleScript, setSupportsScheduleScript] = React.useState(\n    !!viewport?.view?.scheduleScript\n  );\n\n  React.useEffect(() => {\n    setSupportsScheduleScript(!!viewport?.view?.scheduleScript);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [supportsScheduleScript, viewport]);\n\n  React.useEffect(() => {\n    const handleDisplayStyleChange = (vp: Viewport): void => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\n    };\n    return viewport?.onDisplayStyleChanged.addListener(\n      handleDisplayStyleChange\n    );\n  }, [viewport, supportsScheduleScript]);\n  return supportsScheduleScript;\n}\n\n/** Hook that returns either a ScheduleAnimationTimelineDataProvider or undefined based on if the supplied viewport contains schedule script.\n * @public\n **/\n// istanbul ignore next\nexport function useScheduleAnimationDataProvider(\n  viewport: ScreenViewport | undefined\n) {\n  const supportsScheduleScript = useSupportsScheduleScript(viewport);\n  const [\n    scheduleAnimationTimelineDataProvider,\n    setScheduleAnimationTimelineDataProvider,\n  ] = React.useState<ScheduleAnimationTimelineDataProvider | undefined>();\n  const isMountedRef = React.useRef(false);\n\n  React.useEffect(() => {\n    isMountedRef.current = true;\n    return () => {\n      isMountedRef.current = false;\n    };\n  }, []);\n\n  React.useEffect(() => {\n    async function fetchNewDataProvider(vp: ScreenViewport) {\n      let newProvider: ScheduleAnimationTimelineDataProvider | undefined =\n        new ScheduleAnimationTimelineDataProvider(vp.view, vp);\n      if (newProvider?.supportsTimelineAnimation) {\n        const dataLoaded = await newProvider.loadTimelineData();\n        if (!dataLoaded) newProvider = undefined;\n      }\n      isMountedRef.current &&\n        setScheduleAnimationTimelineDataProvider(newProvider);\n    }\n    if (supportsScheduleScript && viewport) void fetchNewDataProvider(viewport);\n    else\n      isMountedRef.current &&\n        setScheduleAnimationTimelineDataProvider(undefined);\n  }, [supportsScheduleScript, viewport]);\n\n  return scheduleAnimationTimelineDataProvider;\n}\n"]}
+{"version":3,"file":"useScheduleAnimationDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useScheduleAnimationDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,qCAAqC,EAAE,MAAM,uCAAuC,CAAC;AAG9F,gBAAgB;AAChB,uBAAuB;AACvB,SAAS,yBAAyB,CAAC,QAA8B;;IAC/D,MAAM,CAAC,sBAAsB,EAAE,yBAAyB,CAAC,GAAG,KAAK,CAAC,QAAQ,CACxE,CAAC,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,cAAc,CAAA,CACjC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,yBAAyB,CAAC,CAAC,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,cAAc,CAAA,CAAC,CAAC;IAC9D,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;;YAC/C,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,0CAAE,cAAc,CAAA,CAAC;YACrD,IAAI,iBAAiB,KAAK,sBAAsB;gBAC9C,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,wBAAwB,GAAG,CAAC,EAAY,EAAQ,EAAE;;YACtD,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,0CAAE,cAAc,CAAA,CAAC;YACrD,IAAI,iBAAiB,KAAK,sBAAsB;gBAC9C,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,qBAAqB,CAAC,WAAW,CAChD,wBAAwB,CACzB,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACvC,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;IAEI;AACJ,uBAAuB;AACvB,MAAM,UAAU,gCAAgC,CAC9C,QAAoC;IAEpC,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnE,MAAM,CACJ,qCAAqC,EACrC,wCAAwC,EACzC,GAAG,KAAK,CAAC,QAAQ,EAAqD,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEzC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAC5B,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,KAAK,UAAU,oBAAoB,CAAC,EAAkB;YACpD,IAAI,WAAW,GACb,IAAI,qCAAqC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,yBAAyB,EAAE;gBAC1C,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAI,CAAC,UAAU;oBAAE,WAAW,GAAG,SAAS,CAAC;aAC1C;YACD,YAAY,CAAC,OAAO;gBAClB,wCAAwC,CAAC,WAAW,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,sBAAsB,IAAI,QAAQ;YAAE,KAAK,oBAAoB,CAAC,QAAQ,CAAC,CAAC;;YAE1E,YAAY,CAAC,OAAO;gBAClB,wCAAwC,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,OAAO,qCAAqC,CAAC;AAC/C,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 * as React from \"react\";\nimport { ScheduleAnimationTimelineDataProvider } from \"../timeline/ScheduleAnimationProvider\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\n\n/** @internal */\n// istanbul ignore next\nfunction useSupportsScheduleScript(viewport: Viewport | undefined) {\n  const [supportsScheduleScript, setSupportsScheduleScript] = React.useState(\n    !!viewport?.view?.scheduleScript\n  );\n\n  React.useEffect(() => {\n    setSupportsScheduleScript(!!viewport?.view?.scheduleScript);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [supportsScheduleScript, viewport]);\n\n  React.useEffect(() => {\n    const handleDisplayStyleChange = (vp: Viewport): void => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\n    };\n    return viewport?.onDisplayStyleChanged.addListener(\n      handleDisplayStyleChange\n    );\n  }, [viewport, supportsScheduleScript]);\n  return supportsScheduleScript;\n}\n\n/** Hook that returns either a ScheduleAnimationTimelineDataProvider or undefined based on if the supplied viewport contains schedule script.\n * @public\n **/\n// istanbul ignore next\nexport function useScheduleAnimationDataProvider(\n  viewport: ScreenViewport | undefined\n) {\n  const supportsScheduleScript = useSupportsScheduleScript(viewport);\n  const [\n    scheduleAnimationTimelineDataProvider,\n    setScheduleAnimationTimelineDataProvider,\n  ] = React.useState<ScheduleAnimationTimelineDataProvider | undefined>();\n  const isMountedRef = React.useRef(false);\n\n  React.useEffect(() => {\n    isMountedRef.current = true;\n    return () => {\n      isMountedRef.current = false;\n    };\n  }, []);\n\n  React.useEffect(() => {\n    async function fetchNewDataProvider(vp: ScreenViewport) {\n      let newProvider: ScheduleAnimationTimelineDataProvider | undefined =\n        new ScheduleAnimationTimelineDataProvider(vp.view, vp);\n      if (newProvider?.supportsTimelineAnimation) {\n        const dataLoaded = await newProvider.loadTimelineData();\n        if (!dataLoaded) newProvider = undefined;\n      }\n      isMountedRef.current &&\n        setScheduleAnimationTimelineDataProvider(newProvider);\n    }\n    if (supportsScheduleScript && viewport) void fetchNewDataProvider(viewport);\n    else\n      isMountedRef.current &&\n        setScheduleAnimationTimelineDataProvider(undefined);\n  }, [supportsScheduleScript, viewport]);\n\n  return scheduleAnimationTimelineDataProvider;\n}\n"]}

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

@@ -11,36 +11,41 @@ import { SolarTimelineDataProvider } from "../timeline/SolarTimelineDataProvider
 /** @internal */
 // istanbul ignore next
 function useSupportsShadowDisplay(viewport) {
-    const [supportsShadows, setSupportsShadows] = React.useState(!!viewport?.displayStyle?.wantShadows &&
+    var _a;
+    const [supportsShadows, setSupportsShadows] = React.useState(!!((_a = viewport === null || viewport === void 0 ? void 0 : viewport.displayStyle) === null || _a === void 0 ? void 0 : _a.wantShadows) &&
         !!IModelApp.renderSystem.options.displaySolarShadows);
     React.useEffect(() => {
-        setSupportsShadows(!!viewport?.displayStyle?.wantShadows &&
+        var _a;
+        setSupportsShadows(!!((_a = viewport === null || viewport === void 0 ? void 0 : viewport.displayStyle) === null || _a === void 0 ? void 0 : _a.wantShadows) &&
             !!IModelApp.renderSystem.options.displaySolarShadows);
     }, [viewport]);
     React.useEffect(() => {
         const handleViewChanged = (vp) => {
-            setSupportsShadows(!!vp?.displayStyle?.wantShadows &&
+            var _a;
+            setSupportsShadows(!!((_a = vp === null || vp === void 0 ? void 0 : vp.displayStyle) === null || _a === void 0 ? void 0 : _a.wantShadows) &&
                 !!IModelApp.renderSystem.options.displaySolarShadows);
         };
-        return viewport?.onChangeView.addListener(handleViewChanged);
+        return viewport === null || viewport === void 0 ? void 0 : viewport.onChangeView.addListener(handleViewChanged);
     }, [viewport]);
     React.useEffect(() => {
         const handleViewChanged = (vp) => {
-            const wantShadows = !!vp.displayStyle?.wantShadows &&
+            var _a;
+            const wantShadows = !!((_a = vp.displayStyle) === null || _a === void 0 ? void 0 : _a.wantShadows) &&
                 !!IModelApp.renderSystem.options.displaySolarShadows;
             if (wantShadows !== supportsShadows)
                 setSupportsShadows(wantShadows);
         };
-        return viewport?.onChangeView.addListener(handleViewChanged);
+        return viewport === null || viewport === void 0 ? void 0 : viewport.onChangeView.addListener(handleViewChanged);
     }, [viewport, supportsShadows]);
     React.useEffect(() => {
         const handleDisplayStyleChange = (vp) => {
-            const wantShadows = !!vp.displayStyle?.wantShadows &&
+            var _a;
+            const wantShadows = !!((_a = vp.displayStyle) === null || _a === void 0 ? void 0 : _a.wantShadows) &&
                 !!IModelApp.renderSystem.options.displaySolarShadows;
             if (wantShadows !== supportsShadows)
                 setSupportsShadows(wantShadows);
         };
-        return viewport?.onDisplayStyleChanged.addListener(handleDisplayStyleChange);
+        return viewport === null || viewport === void 0 ? void 0 : viewport.onDisplayStyleChanged.addListener(handleDisplayStyleChange);
     }, [viewport, supportsShadows]);
     return supportsShadows;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"useSolarDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useSolarDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAElF,gBAAgB;AAChB,uBAAuB;AACvB,SAAS,wBAAwB,CAAC,QAAoC;IACpE,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,WAAW;QACnC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,kBAAkB,CAChB,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,WAAW;YACnC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;YAC/C,kBAAkB,CAChB,CAAC,CAAC,EAAE,EAAE,YAAY,EAAE,WAAW;gBAC7B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;YAC/C,MAAM,WAAW,GACf,CAAC,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW;gBAC9B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACvD,IAAI,WAAW,KAAK,eAAe;gBAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,wBAAwB,GAAG,CAAC,EAAY,EAAQ,EAAE;YACtD,MAAM,WAAW,GACf,CAAC,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW;gBAC9B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACvD,IAAI,WAAW,KAAK,eAAe;gBAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAChD,wBAAwB,CACzB,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;IAEI;AACJ,uBAAuB;AACvB,MAAM,UAAU,oBAAoB,CAClC,QAAoC;IAEpC,MAAM,qBAAqB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;QACpE,OAAO,qBAAqB,IAAI,QAAQ;YACtC,CAAC,CAAC,IAAI,yBAAyB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,oBAAoB,GACxB,qBAAqB,IAAI,QAAQ;YAC/B,CAAC,CAAC,IAAI,yBAAyB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;QAChB,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAC7C,CAAC,EAAE,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEtC,OAAO,iBAAiB,CAAC;AAC3B,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 * as React from \"react\";\nimport type { SolarDataProvider } from \"@itwin/imodel-components-react\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { SolarTimelineDataProvider } from \"../timeline/SolarTimelineDataProvider\";\n\n/** @internal */\n// istanbul ignore next\nfunction useSupportsShadowDisplay(viewport: ScreenViewport | undefined) {\n  const [supportsShadows, setSupportsShadows] = React.useState(\n    !!viewport?.displayStyle?.wantShadows &&\n      !!IModelApp.renderSystem.options.displaySolarShadows\n  );\n\n  React.useEffect(() => {\n    setSupportsShadows(\n      !!viewport?.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows\n    );\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      setSupportsShadows(\n        !!vp?.displayStyle?.wantShadows &&\n          !!IModelApp.renderSystem.options.displaySolarShadows\n      );\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      const wantShadows =\n        !!vp.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [viewport, supportsShadows]);\n\n  React.useEffect(() => {\n    const handleDisplayStyleChange = (vp: Viewport): void => {\n      const wantShadows =\n        !!vp.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\n    };\n    return viewport?.onDisplayStyleChanged.addListener(\n      handleDisplayStyleChange\n    );\n  }, [viewport, supportsShadows]);\n\n  return supportsShadows;\n}\n\n/** Hook that returns either a SolarTimelineDataProvider or undefined based on if the supplied viewport's display style is set to display shadows.\n * @beta\n **/\n// istanbul ignore next\nexport function useSolarDataProvider(\n  viewport: ScreenViewport | undefined\n): SolarDataProvider | undefined {\n  const supportsShadowDisplay = useSupportsShadowDisplay(viewport);\n  const [solarDataProvider, setSolarDataProvider] = React.useState(() => {\n    return supportsShadowDisplay && viewport\n      ? new SolarTimelineDataProvider(viewport.view, viewport)\n      : undefined;\n  });\n\n  React.useEffect(() => {\n    const newSolarDataProvider =\n      supportsShadowDisplay && viewport\n        ? new SolarTimelineDataProvider(viewport.view, viewport)\n        : undefined;\n    setSolarDataProvider(newSolarDataProvider);\n  }, [supportsShadowDisplay, viewport]);\n\n  return solarDataProvider;\n}\n"]}
+{"version":3,"file":"useSolarDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useSolarDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAElF,gBAAgB;AAChB,uBAAuB;AACvB,SAAS,wBAAwB,CAAC,QAAoC;;IACpE,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,CAAC,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,0CAAE,WAAW,CAAA;QACnC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,kBAAkB,CAChB,CAAC,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,0CAAE,WAAW,CAAA;YACnC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;;YAC/C,kBAAkB,CAChB,CAAC,CAAC,CAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,YAAY,0CAAE,WAAW,CAAA;gBAC7B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CACvD,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,EAAY,EAAQ,EAAE;;YAC/C,MAAM,WAAW,GACf,CAAC,CAAC,CAAA,MAAA,EAAE,CAAC,YAAY,0CAAE,WAAW,CAAA;gBAC9B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACvD,IAAI,WAAW,KAAK,eAAe;gBAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,wBAAwB,GAAG,CAAC,EAAY,EAAQ,EAAE;;YACtD,MAAM,WAAW,GACf,CAAC,CAAC,CAAA,MAAA,EAAE,CAAC,YAAY,0CAAE,WAAW,CAAA;gBAC9B,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACvD,IAAI,WAAW,KAAK,eAAe;gBAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,qBAAqB,CAAC,WAAW,CAChD,wBAAwB,CACzB,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;IAEI;AACJ,uBAAuB;AACvB,MAAM,UAAU,oBAAoB,CAClC,QAAoC;IAEpC,MAAM,qBAAqB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;QACpE,OAAO,qBAAqB,IAAI,QAAQ;YACtC,CAAC,CAAC,IAAI,yBAAyB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,oBAAoB,GACxB,qBAAqB,IAAI,QAAQ;YAC/B,CAAC,CAAC,IAAI,yBAAyB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;QAChB,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAC7C,CAAC,EAAE,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEtC,OAAO,iBAAiB,CAAC;AAC3B,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 * as React from \"react\";\nimport type { SolarDataProvider } from \"@itwin/imodel-components-react\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { SolarTimelineDataProvider } from \"../timeline/SolarTimelineDataProvider\";\n\n/** @internal */\n// istanbul ignore next\nfunction useSupportsShadowDisplay(viewport: ScreenViewport | undefined) {\n  const [supportsShadows, setSupportsShadows] = React.useState(\n    !!viewport?.displayStyle?.wantShadows &&\n      !!IModelApp.renderSystem.options.displaySolarShadows\n  );\n\n  React.useEffect(() => {\n    setSupportsShadows(\n      !!viewport?.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows\n    );\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      setSupportsShadows(\n        !!vp?.displayStyle?.wantShadows &&\n          !!IModelApp.renderSystem.options.displaySolarShadows\n      );\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      const wantShadows =\n        !!vp.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [viewport, supportsShadows]);\n\n  React.useEffect(() => {\n    const handleDisplayStyleChange = (vp: Viewport): void => {\n      const wantShadows =\n        !!vp.displayStyle?.wantShadows &&\n        !!IModelApp.renderSystem.options.displaySolarShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\n    };\n    return viewport?.onDisplayStyleChanged.addListener(\n      handleDisplayStyleChange\n    );\n  }, [viewport, supportsShadows]);\n\n  return supportsShadows;\n}\n\n/** Hook that returns either a SolarTimelineDataProvider or undefined based on if the supplied viewport's display style is set to display shadows.\n * @beta\n **/\n// istanbul ignore next\nexport function useSolarDataProvider(\n  viewport: ScreenViewport | undefined\n): SolarDataProvider | undefined {\n  const supportsShadowDisplay = useSupportsShadowDisplay(viewport);\n  const [solarDataProvider, setSolarDataProvider] = React.useState(() => {\n    return supportsShadowDisplay && viewport\n      ? new SolarTimelineDataProvider(viewport.view, viewport)\n      : undefined;\n  });\n\n  React.useEffect(() => {\n    const newSolarDataProvider =\n      supportsShadowDisplay && viewport\n        ? new SolarTimelineDataProvider(viewport.view, viewport)\n        : undefined;\n    setSolarDataProvider(newSolarDataProvider);\n  }, [supportsShadowDisplay, viewport]);\n\n  return solarDataProvider;\n}\n"]}

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;YACd,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;SACtE;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,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;SACJ;aAAM;YACL,mDAAmD;YACnD,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CACzE,CAAC;SACH;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;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC;SACJ;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;IA2ExE,CAAC;IAzEC,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;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,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,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,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\",\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        // istanbul ignore else\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      // istanbul ignore else\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    // istanbul ignore else\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;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;YACd,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;SACtE;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,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;SACJ;aAAM;YACL,mDAAmD;YACnD,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CACzE,CAAC;SACH;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;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC;SACJ;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;IA2ExE,CAAC;IAzEC,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;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,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,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,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        // istanbul ignore else\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      // istanbul ignore else\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    // istanbul ignore else\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/keyins/Keyins.d.ts

@@ -0,0 +1,35 @@
+/** @packageDocumentation
+ *  @module Tools
+ */
+import type { ToolList } from "@itwin/core-frontend";
+import type { IMatch } from "../utils/matchesWords";
+/**
+ * Defines a keyin entry to show/filter in UI
+ * @public
+ */
+export interface KeyinEntry {
+    /** string that matched a filter string */
+    value: string;
+    /** define array of start and end positions of filter matches. */
+    matches?: IMatch[];
+    /** true if entry was loaded from key-in history */
+    isHistory?: boolean;
+}
+/**
+ * Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
+ * @public
+ */
+export declare enum KeyinFieldLocalization {
+    /** Include only non-localized key-in strings. */
+    NonLocalized = 0,
+    /** Include only localized key-in strings. */
+    Localized = 1,
+    /** Include localized and non-localized strings for each key-in. */
+    Both = 2
+}
+/**
+ * Parses a given ToolList for its tools keyins, filtering based on a KeyinFieldLocalization value.
+ * @internal
+ */
+export declare function getKeyinsFromToolList(toolList: ToolList, localizedKeyinPreference?: KeyinFieldLocalization): KeyinEntry[];
+//# sourceMappingURL=Keyins.d.ts.map

package/lib/esm/appui-react/keyins/Keyins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Keyins.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyins/Keyins.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,iDAAiD;IACjD,YAAY,IAAA;IACZ,6CAA6C;IAC7C,SAAS,IAAA;IACT,mEAAmE;IACnE,IAAI,IAAA;CACL;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,EAClB,wBAAwB,GAAE,sBAA4D,GACrF,UAAU,EAAE,CA0Bd"}

package/lib/esm/appui-react/keyins/Keyins.js

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ *  @module Tools
+ */
+/**
+ * Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
+ * @public
+ */
+export var KeyinFieldLocalization;
+(function (KeyinFieldLocalization) {
+    /** Include only non-localized key-in strings. */
+    KeyinFieldLocalization[KeyinFieldLocalization["NonLocalized"] = 0] = "NonLocalized";
+    /** Include only localized key-in strings. */
+    KeyinFieldLocalization[KeyinFieldLocalization["Localized"] = 1] = "Localized";
+    /** Include localized and non-localized strings for each key-in. */
+    KeyinFieldLocalization[KeyinFieldLocalization["Both"] = 2] = "Both";
+})(KeyinFieldLocalization || (KeyinFieldLocalization = {}));
+/**
+ * Parses a given ToolList for its tools keyins, filtering based on a KeyinFieldLocalization value.
+ * @internal
+ */
+export function getKeyinsFromToolList(toolList, localizedKeyinPreference = KeyinFieldLocalization.NonLocalized) {
+    const toolKeyins = [];
+    for (const tool of toolList) {
+        switch (localizedKeyinPreference) {
+            case KeyinFieldLocalization.Localized:
+                toolKeyins.push({ value: tool.keyin });
+                break;
+            case KeyinFieldLocalization.Both:
+                toolKeyins.push({ value: tool.keyin });
+                // istanbul ignore else
+                if (tool.keyin === tool.englishKeyin)
+                    break;
+            // istanbul ignore next
+            default: // eslint-disable-line no-fallthrough
+            case KeyinFieldLocalization.NonLocalized:
+                // istanbul ignore next
+                if (KeyinFieldLocalization.NonLocalized === localizedKeyinPreference ||
+                    (KeyinFieldLocalization.Both === localizedKeyinPreference &&
+                        tool.englishKeyin !== tool.keyin))
+                    toolKeyins.push({ value: tool.englishKeyin });
+                break;
+        }
+    }
+    return toolKeyins;
+}
+//# sourceMappingURL=Keyins.js.map

package/lib/esm/appui-react/keyins/Keyins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Keyins.js","sourceRoot":"","sources":["../../../../src/appui-react/keyins/Keyins.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAiBH;;;GAGG;AACH,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,iDAAiD;IACjD,mFAAY,CAAA;IACZ,6CAA6C;IAC7C,6EAAS,CAAA;IACT,mEAAmE;IACnE,mEAAI,CAAA;AACN,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAkB,EAClB,2BAAmD,sBAAsB,CAAC,YAAY;IAEtF,MAAM,UAAU,GAAiB,EAAE,CAAC;IACpC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;QAC3B,QAAQ,wBAAwB,EAAE;YAChC,KAAK,sBAAsB,CAAC,SAAS;gBACnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBACvC,MAAM;YACR,KAAK,sBAAsB,CAAC,IAAI;gBAC9B,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBACvC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,YAAY;oBAAE,MAAM;YAC9C,uBAAuB;YACvB,QAAQ,CAAC,qCAAqC;YAC9C,KAAK,sBAAsB,CAAC,YAAY;gBACtC,uBAAuB;gBACvB,IACE,sBAAsB,CAAC,YAAY,KAAK,wBAAwB;oBAChE,CAAC,sBAAsB,CAAC,IAAI,KAAK,wBAAwB;wBACvD,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC;oBAEnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;gBAChD,MAAM;SACT;KACF;IAED,OAAO,UAAU,CAAC;AACpB,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 Tools\n */\n\nimport type { ToolList } from \"@itwin/core-frontend\";\nimport type { IMatch } from \"../utils/matchesWords\";\n/**\n * Defines a keyin entry to show/filter in UI\n * @public\n */\nexport interface KeyinEntry {\n  /** string that matched a filter string */\n  value: string;\n  /** define array of start and end positions of filter matches. */\n  matches?: IMatch[];\n  /** true if entry was loaded from key-in history */\n  isHistory?: boolean;\n}\n\n/**\n * Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.\n * @public\n */\nexport enum KeyinFieldLocalization {\n  /** Include only non-localized key-in strings. */\n  NonLocalized,\n  /** Include only localized key-in strings. */\n  Localized,\n  /** Include localized and non-localized strings for each key-in. */\n  Both,\n}\n\n/**\n * Parses a given ToolList for its tools keyins, filtering based on a KeyinFieldLocalization value.\n * @internal\n */\nexport function getKeyinsFromToolList(\n  toolList: ToolList,\n  localizedKeyinPreference: KeyinFieldLocalization = KeyinFieldLocalization.NonLocalized\n): KeyinEntry[] {\n  const toolKeyins: KeyinEntry[] = [];\n  for (const tool of toolList) {\n    switch (localizedKeyinPreference) {\n      case KeyinFieldLocalization.Localized:\n        toolKeyins.push({ value: tool.keyin });\n        break;\n      case KeyinFieldLocalization.Both:\n        toolKeyins.push({ value: tool.keyin });\n        // istanbul ignore else\n        if (tool.keyin === tool.englishKeyin) break;\n      // istanbul ignore next\n      default: // eslint-disable-line no-fallthrough\n      case KeyinFieldLocalization.NonLocalized:\n        // istanbul ignore next\n        if (\n          KeyinFieldLocalization.NonLocalized === localizedKeyinPreference ||\n          (KeyinFieldLocalization.Both === localizedKeyinPreference &&\n            tool.englishKeyin !== tool.keyin)\n        )\n          toolKeyins.push({ value: tool.englishKeyin });\n        break;\n    }\n  }\n\n  return toolKeyins;\n}\n"]}

package/lib/esm/appui-react/layers.scss

@@ -0,0 +1,11 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+@layer appui {
+  @layer layout, component, preview;
+
+  @layer preview {
+    @layer horizontal-panel-alignment, enable-maximized-widget;
+  }
+}

package/lib/esm/appui-react/layout/StandardLayout.d.ts

@@ -0,0 +1,24 @@
+/** @packageDocumentation
+ * @module WidgetPanels
+ */
+import "./StandardLayout.scss";
+import * as React from "react";
+import type { CommonProps } from "@itwin/core-react";
+interface StandardLayoutProps extends CommonProps {
+    /** Main content area of the application (i.e. viewport) that will change bounds based on panel pinned state. */
+    children?: React.ReactNode;
+    /** Component that displays center content (i.e. toolbars). Content is always bound by widget panels. */
+    centerContent?: React.ReactNode;
+    toolSettings?: React.ReactNode;
+    statusBar?: React.ReactNode;
+    topPanel?: React.ReactNode;
+    leftPanel?: React.ReactNode;
+    rightPanel?: React.ReactNode;
+    bottomPanel?: React.ReactNode;
+}
+/** Component that displays widgets in a standard layout.
+ * @internal
+ */
+export declare function StandardLayout(props: StandardLayoutProps): React.JSX.Element;
+export {};
+//# sourceMappingURL=StandardLayout.d.ts.map

package/lib/esm/appui-react/layout/StandardLayout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StandardLayout.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/layout/StandardLayout.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,uBAAuB,CAAC;AAE/B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAQrD,UAAU,mBAAoB,SAAQ,WAAW;IAC/C,gHAAgH;IAChH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,wGAAwG;IACxG,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAChC,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,qBAsBxD"}

package/lib/esm/appui-react/layout/StandardLayout.js

@@ -0,0 +1,52 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module WidgetPanels
+ */
+import "./StandardLayout.scss";
+import classnames from "classnames";
+import * as React from "react";
+import { useLayout } from "./base/LayoutStore";
+import { useContentAlwaysMaxSize } from "../preview/content-always-max-size/useContentAlwaysMaxSize";
+import { useMaximizedPanelLayout } from "../preview/enable-maximized-widget/useMaximizedWidget";
+import { useHorizontalPanelAlignment } from "../preview/horizontal-panel-alignment/useHorizontalPanelAlignment";
+import { usePanelsAutoCollapse } from "./widget-panels/usePanelsAutoCollapse";
+/** Component that displays widgets in a standard layout.
+ * @internal
+ */
+export function StandardLayout(props) {
+    const pinned = usePinnedPanels();
+    const appContentRef = usePanelsAutoCollapse();
+    const className = classnames("nz-standardLayout", pinned, props.className);
+    const contentAlwaysMaxSize = useContentAlwaysMaxSize();
+    return (React.createElement("div", { className: className, style: props.style },
+        React.createElement("div", { className: classnames("nz-appContent", contentAlwaysMaxSize), ref: appContentRef }, props.children),
+        React.createElement("div", { className: "nz-centerContent" }, props.centerContent),
+        React.createElement(Panel, { side: "left" }, props.leftPanel),
+        React.createElement(Panel, { side: "right" }, props.rightPanel),
+        React.createElement(Panel, { side: "top" }, props.topPanel),
+        React.createElement(Panel, { side: "bottom" }, props.bottomPanel),
+        React.createElement("div", { className: "nz-toolSettings" }, props.toolSettings),
+        React.createElement("div", { className: "nz-statusBar" }, props.statusBar)));
+}
+function Panel({ children, side }) {
+    const maximizedWidget = useMaximizedPanelLayout(side);
+    const horizontalAlignment = useHorizontalPanelAlignment(side);
+    const className = classnames(`nz-standardLayout_${side}Panel`, maximizedWidget, horizontalAlignment.classNames);
+    return (React.createElement("div", { className: className, ...horizontalAlignment.attributes }, children));
+}
+function usePinnedPanels() {
+    const leftPinned = useLayout((state) => state.panels.left.pinned);
+    const rightPinned = useLayout((state) => state.panels.right.pinned);
+    const topPinned = useLayout((state) => state.panels.top.pinned);
+    const bottomPinned = useLayout((state) => state.panels.bottom.pinned);
+    return {
+        "nz-pinned-left": leftPinned,
+        "nz-pinned-right": rightPinned,
+        "nz-pinned-top": topPinned,
+        "nz-pinned-bottom": bottomPinned,
+    };
+}
+//# sourceMappingURL=StandardLayout.js.map

package/lib/esm/appui-react/layout/StandardLayout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StandardLayout.js","sourceRoot":"","sources":["../../../../src/appui-react/layout/StandardLayout.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,uBAAuB,CAAC;AAC/B,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,4DAA4D,CAAC;AACrG,OAAO,EAAE,uBAAuB,EAAE,MAAM,uDAAuD,CAAC;AAChG,OAAO,EAAE,2BAA2B,EAAE,MAAM,mEAAmE,CAAC;AAChH,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAgB9E;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,KAA0B;IACvD,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;IACjC,MAAM,aAAa,GAAG,qBAAqB,EAAkB,CAAC;IAC9D,MAAM,SAAS,GAAG,UAAU,CAAC,mBAAmB,EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3E,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAC;IACvD,OAAO,CACL,6BAAK,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK;QAC3C,6BACE,SAAS,EAAE,UAAU,CAAC,eAAe,EAAE,oBAAoB,CAAC,EAC5D,GAAG,EAAE,aAAa,IAEjB,KAAK,CAAC,QAAQ,CACX;QACN,6BAAK,SAAS,EAAC,kBAAkB,IAAE,KAAK,CAAC,aAAa,CAAO;QAC7D,oBAAC,KAAK,IAAC,IAAI,EAAC,MAAM,IAAE,KAAK,CAAC,SAAS,CAAS;QAC5C,oBAAC,KAAK,IAAC,IAAI,EAAC,OAAO,IAAE,KAAK,CAAC,UAAU,CAAS;QAC9C,oBAAC,KAAK,IAAC,IAAI,EAAC,KAAK,IAAE,KAAK,CAAC,QAAQ,CAAS;QAC1C,oBAAC,KAAK,IAAC,IAAI,EAAC,QAAQ,IAAE,KAAK,CAAC,WAAW,CAAS;QAChD,6BAAK,SAAS,EAAC,iBAAiB,IAAE,KAAK,CAAC,YAAY,CAAO;QAC3D,6BAAK,SAAS,EAAC,cAAc,IAAE,KAAK,CAAC,SAAS,CAAO,CACjD,CACP,CAAC;AACJ,CAAC;AAMD,SAAS,KAAK,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAuC;IACpE,MAAM,eAAe,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,UAAU,CAC1B,qBAAqB,IAAI,OAAO,EAChC,eAAe,EACf,mBAAmB,CAAC,UAAU,CAC/B,CAAC;IACF,OAAO,CACL,6BAAK,SAAS,EAAE,SAAS,KAAM,mBAAmB,CAAC,UAAU,IAC1D,QAAQ,CACL,CACP,CAAC;AACJ,CAAC;AAED,SAAS,eAAe;IACtB,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtE,OAAO;QACL,gBAAgB,EAAE,UAAU;QAC5B,iBAAiB,EAAE,WAAW;QAC9B,eAAe,EAAE,SAAS;QAC1B,kBAAkB,EAAE,YAAY;KACjC,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 WidgetPanels\n */\n\nimport \"./StandardLayout.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport { useLayout } from \"./base/LayoutStore\";\nimport { useContentAlwaysMaxSize } from \"../preview/content-always-max-size/useContentAlwaysMaxSize\";\nimport { useMaximizedPanelLayout } from \"../preview/enable-maximized-widget/useMaximizedWidget\";\nimport { useHorizontalPanelAlignment } from \"../preview/horizontal-panel-alignment/useHorizontalPanelAlignment\";\nimport { usePanelsAutoCollapse } from \"./widget-panels/usePanelsAutoCollapse\";\nimport type { PanelSide } from \"./widget-panels/PanelTypes\";\n\ninterface StandardLayoutProps extends CommonProps {\n  /** Main content area of the application (i.e. viewport) that will change bounds based on panel pinned state. */\n  children?: React.ReactNode;\n  /** Component that displays center content (i.e. toolbars). Content is always bound by widget panels. */\n  centerContent?: React.ReactNode;\n  toolSettings?: React.ReactNode;\n  statusBar?: React.ReactNode;\n  topPanel?: React.ReactNode;\n  leftPanel?: React.ReactNode;\n  rightPanel?: React.ReactNode;\n  bottomPanel?: React.ReactNode;\n}\n\n/** Component that displays widgets in a standard layout.\n * @internal\n */\nexport function StandardLayout(props: StandardLayoutProps) {\n  const pinned = usePinnedPanels();\n  const appContentRef = usePanelsAutoCollapse<HTMLDivElement>();\n  const className = classnames(\"nz-standardLayout\", pinned, props.className);\n  const contentAlwaysMaxSize = useContentAlwaysMaxSize();\n  return (\n    <div className={className} style={props.style}>\n      <div\n        className={classnames(\"nz-appContent\", contentAlwaysMaxSize)}\n        ref={appContentRef}\n      >\n        {props.children}\n      </div>\n      <div className=\"nz-centerContent\">{props.centerContent}</div>\n      <Panel side=\"left\">{props.leftPanel}</Panel>\n      <Panel side=\"right\">{props.rightPanel}</Panel>\n      <Panel side=\"top\">{props.topPanel}</Panel>\n      <Panel side=\"bottom\">{props.bottomPanel}</Panel>\n      <div className=\"nz-toolSettings\">{props.toolSettings}</div>\n      <div className=\"nz-statusBar\">{props.statusBar}</div>\n    </div>\n  );\n}\n\ninterface PanelProps {\n  side: PanelSide;\n}\n\nfunction Panel({ children, side }: React.PropsWithChildren<PanelProps>) {\n  const maximizedWidget = useMaximizedPanelLayout(side);\n  const horizontalAlignment = useHorizontalPanelAlignment(side);\n  const className = classnames(\n    `nz-standardLayout_${side}Panel`,\n    maximizedWidget,\n    horizontalAlignment.classNames\n  );\n  return (\n    <div className={className} {...horizontalAlignment.attributes}>\n      {children}\n    </div>\n  );\n}\n\nfunction usePinnedPanels() {\n  const leftPinned = useLayout((state) => state.panels.left.pinned);\n  const rightPinned = useLayout((state) => state.panels.right.pinned);\n  const topPinned = useLayout((state) => state.panels.top.pinned);\n  const bottomPinned = useLayout((state) => state.panels.bottom.pinned);\n  return {\n    \"nz-pinned-left\": leftPinned,\n    \"nz-pinned-right\": rightPinned,\n    \"nz-pinned-top\": topPinned,\n    \"nz-pinned-bottom\": bottomPinned,\n  };\n}\n"]}

package/lib/esm/appui-react/layout/StandardLayout.scss

@@ -0,0 +1,94 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
+
+@layer appui.component {
+  .nz-standardLayout {
+    position: relative;
+    height: 100%;
+    background-color: $buic-background-widget-panel;
+    overflow: hidden;
+
+    display: grid;
+    grid-template-columns:
+      [lp-start] minmax(0, auto) [lp-end] 1fr [rp-start] minmax(0, auto)
+      [rp-end];
+    grid-template-rows:
+      minmax(0, auto) [ts-end] minmax(0, auto) [tp-end] 1fr [bp-start] minmax(
+        0,
+        auto
+      )
+      [bp-end]
+      minmax(0, auto);
+    grid-template-areas:
+      "ts ts ts"
+      "tp tp tp"
+      "lp cc rp"
+      "bp bp bp"
+      "sb sb sb";
+
+    > .nz-appContent {
+      grid-row: 1 / -1;
+      grid-column: 1 / -1;
+
+      // TODO: clean-up #uifw-contentlayout-div
+      position: relative;
+    }
+
+    > .nz-toolSettings {
+      grid-area: ts;
+    }
+
+    > .nz-centerContent {
+      grid-area: cc;
+
+      pointer-events: none;
+    }
+
+    > .nz-statusBar {
+      grid-area: sb;
+    }
+
+    &.nz-pinned-left {
+      > .nz-appContent {
+        grid-column-start: 2;
+      }
+    }
+
+    &.nz-pinned-right {
+      > .nz-appContent {
+        grid-column-end: -2;
+      }
+    }
+
+    &.nz-pinned-top {
+      > .nz-appContent {
+        grid-row-start: tp-end;
+      }
+    }
+
+    &.nz-pinned-bottom {
+      > .nz-appContent {
+        grid-row-end: bp-start;
+      }
+    }
+  }
+
+  .nz-standardLayout_topPanel {
+    grid-area: tp;
+  }
+
+  .nz-standardLayout_leftPanel {
+    grid-area: lp;
+  }
+
+  .nz-standardLayout_rightPanel {
+    grid-area: rp;
+  }
+
+  .nz-standardLayout_bottomPanel {
+    grid-area: bp;
+  }
+}

package/lib/esm/appui-react/layout/_widgetopacity.scss

@@ -6,8 +6,10 @@
 
 @mixin nz-widget-opacity {
   opacity: $buic-widget-opacity;
+  transition: opacity var(--iui-duration-1) ease;
 
-  &:hover {
+  &:hover,
+  &:focus-within {
     opacity: 1;
   }
 }

package/lib/esm/appui-react/layout/backstage/Backstage.js

@@ -20,7 +20,7 @@ class Backstage extends React.PureComponent {
             this.props.onClose && this.props.onClose();
         };
         this._onEsc = (event) => {
-            if (this.props.isOpen && event.key === Key.Escape) {
+            if (this.props.isOpen && event.key === Key.Escape.valueOf()) {
                 this._onClose();
             }
         };