@itwin/appui-react 4.17.0 → 5.0.0-dev.2

package/lib/appui-react/hooks/useActiveViewport.js

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useSyncExternalStore } from "react";
+import { IModelApp } from "@itwin/core-frontend";
+const subscribe = (onStoreChange) => {
+    return IModelApp.viewManager.onSelectedViewportChanged.addListener(onStoreChange);
+};
+const getSnapshot = () => {
+    return IModelApp.viewManager.selectedView;
+};
+/** React hook that maintains the active viewport.
+ * @public
+ */
+export function useActiveViewport() {
+    const activeViewport = useSyncExternalStore(subscribe, getSnapshot);
+    return activeViewport;
+}
+//# sourceMappingURL=useActiveViewport.js.map

package/lib/appui-react/hooks/useActiveViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useActiveViewport.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useActiveViewport.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,SAAS,GAAG,CAAC,aAAyB,EAAE,EAAE;IAC9C,OAAO,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAChE,aAAa,CACd,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,GAAG,EAAE;IACvB,OAAO,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;AAC5C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,cAAc,GAAG,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACpE,OAAO,cAAc,CAAC;AACxB,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 { useSyncExternalStore } from \"react\";\nimport type { ScreenViewport } from \"@itwin/core-frontend\";\nimport { IModelApp } from \"@itwin/core-frontend\";\n\nconst subscribe = (onStoreChange: () => void) => {\n  return IModelApp.viewManager.onSelectedViewportChanged.addListener(\n    onStoreChange\n  );\n};\n\nconst getSnapshot = () => {\n  return IModelApp.viewManager.selectedView;\n};\n\n/** React hook that maintains the active viewport.\n * @public\n */\nexport function useActiveViewport(): ScreenViewport | undefined {\n  const activeViewport = useSyncExternalStore(subscribe, getSnapshot);\n  return activeViewport;\n}\n"]}

package/lib/appui-react/hooks/useAnalysisAnimationDataProvider.d.ts

@@ -0,0 +1,10 @@
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { AnalysisAnimationTimelineDataProvider } from "../timeline/AnalysisAnimationProvider.js";
+import type { ScreenViewport } from "@itwin/core-frontend";
+/** Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data.
+ * @public
+ **/
+export declare function useAnalysisAnimationDataProvider(viewport: ScreenViewport | undefined): AnalysisAnimationTimelineDataProvider | undefined;
+//# sourceMappingURL=useAnalysisAnimationDataProvider.d.ts.map

package/lib/appui-react/hooks/useAnalysisAnimationDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAnalysisAnimationDataProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useAnalysisAnimationDataProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,qCAAqC,EAAE,MAAM,0CAA0C,CAAC;AACjG,OAAO,KAAK,EAAE,cAAc,EAAY,MAAM,sBAAsB,CAAC;AA6BrE;;IAEI;AACJ,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,cAAc,GAAG,SAAS,qDAsBrC"}

package/lib/appui-react/hooks/useAnalysisAnimationDataProvider.js

@@ -0,0 +1,56 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import * as React from "react";
+import { AnalysisAnimationTimelineDataProvider } from "../timeline/AnalysisAnimationProvider.js";
+/** @internal */
+function useSupportsAnalysisAnimation(viewport) {
+    const [supportsAnalysisAnimation, setSupportsAnalysisAnimation] = React.useState(!!viewport?.view?.analysisStyle);
+    React.useEffect(() => {
+        setSupportsAnalysisAnimation(!!viewport?.view?.analysisStyle);
+    }, [viewport]);
+    React.useEffect(() => {
+        return viewport?.onChangeView.addListener((vp) => {
+            const hasAnalysisData = !!vp?.view?.analysisStyle;
+            if (hasAnalysisData !== supportsAnalysisAnimation)
+                setSupportsAnalysisAnimation(hasAnalysisData);
+        });
+    }, [supportsAnalysisAnimation, viewport]);
+    React.useEffect(() => {
+        return viewport?.onDisplayStyleChanged.addListener((vp) => {
+            const hasAnalysisData = !!vp?.view?.analysisStyle;
+            if (hasAnalysisData !== supportsAnalysisAnimation)
+                setSupportsAnalysisAnimation(hasAnalysisData);
+        });
+    }, [viewport, supportsAnalysisAnimation]);
+    return supportsAnalysisAnimation;
+}
+/** Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data.
+ * @public
+ **/
+export function useAnalysisAnimationDataProvider(viewport) {
+    const supportsAnalysisAnimation = useSupportsAnalysisAnimation(viewport);
+    const [dataProvider, setDataProvider] = React.useState();
+    React.useEffect(() => {
+        async function fetchNewDataProvider(vp) {
+            let newProvider = new AnalysisAnimationTimelineDataProvider(vp.view, vp);
+            if (newProvider?.supportsTimelineAnimation) {
+                const dataLoaded = await newProvider.loadTimelineData();
+                if (!dataLoaded)
+                    newProvider = undefined;
+            }
+            setDataProvider(newProvider);
+        }
+        if (supportsAnalysisAnimation && viewport) {
+            void fetchNewDataProvider(viewport);
+        }
+        else
+            setDataProvider(undefined);
+    }, [supportsAnalysisAnimation, viewport]);
+    return dataProvider;
+}
+//# sourceMappingURL=useAnalysisAnimationDataProvider.js.map

package/lib/appui-react/hooks/useAnalysisAnimationDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAnalysisAnimationDataProvider.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useAnalysisAnimationDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,qCAAqC,EAAE,MAAM,0CAA0C,CAAC;AAGjG,gBAAgB;AAChB,SAAS,4BAA4B,CAAC,QAA8B;IAClE,MAAM,CAAC,yBAAyB,EAAE,4BAA4B,CAAC,GAC7D,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAElD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,4BAA4B,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;YAC/C,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC;YAClD,IAAI,eAAe,KAAK,yBAAyB;gBAC/C,4BAA4B,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;YACxD,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC;YAClD,IAAI,eAAe,KAAK,yBAAyB;gBAC/C,4BAA4B,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAC1C,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAED;;IAEI;AACJ,MAAM,UAAU,gCAAgC,CAC9C,QAAoC;IAEpC,MAAM,yBAAyB,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,EAEnD,CAAC;IACJ,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,CAAC;gBAC3C,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAI,CAAC,UAAU;oBAAE,WAAW,GAAG,SAAS,CAAC;YAC3C,CAAC;YACD,eAAe,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,yBAAyB,IAAI,QAAQ,EAAE,CAAC;YAC1C,KAAK,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;;YAAM,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC,EAAE,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE1C,OAAO,YAAY,CAAC;AACtB,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 { AnalysisAnimationTimelineDataProvider } from \"../timeline/AnalysisAnimationProvider.js\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\n\n/** @internal */\nfunction useSupportsAnalysisAnimation(viewport: Viewport | undefined) {\n  const [supportsAnalysisAnimation, setSupportsAnalysisAnimation] =\n    React.useState(!!viewport?.view?.analysisStyle);\n\n  React.useEffect(() => {\n    setSupportsAnalysisAnimation(!!viewport?.view?.analysisStyle);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    return viewport?.onChangeView.addListener((vp) => {\n      const hasAnalysisData = !!vp?.view?.analysisStyle;\n      if (hasAnalysisData !== supportsAnalysisAnimation)\n        setSupportsAnalysisAnimation(hasAnalysisData);\n    });\n  }, [supportsAnalysisAnimation, viewport]);\n\n  React.useEffect(() => {\n    return viewport?.onDisplayStyleChanged.addListener((vp) => {\n      const hasAnalysisData = !!vp?.view?.analysisStyle;\n      if (hasAnalysisData !== supportsAnalysisAnimation)\n        setSupportsAnalysisAnimation(hasAnalysisData);\n    });\n  }, [viewport, supportsAnalysisAnimation]);\n  return supportsAnalysisAnimation;\n}\n\n/** Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data.\n * @public\n **/\nexport function useAnalysisAnimationDataProvider(\n  viewport: ScreenViewport | undefined\n) {\n  const supportsAnalysisAnimation = useSupportsAnalysisAnimation(viewport);\n  const [dataProvider, setDataProvider] = React.useState<\n    AnalysisAnimationTimelineDataProvider | undefined\n  >();\n  React.useEffect(() => {\n    async function fetchNewDataProvider(vp: ScreenViewport) {\n      let newProvider: AnalysisAnimationTimelineDataProvider | undefined =\n        new AnalysisAnimationTimelineDataProvider(vp.view, vp);\n      if (newProvider?.supportsTimelineAnimation) {\n        const dataLoaded = await newProvider.loadTimelineData();\n        if (!dataLoaded) newProvider = undefined;\n      }\n      setDataProvider(newProvider);\n    }\n    if (supportsAnalysisAnimation && viewport) {\n      void fetchNewDataProvider(viewport);\n    } else setDataProvider(undefined);\n  }, [supportsAnalysisAnimation, viewport]);\n\n  return dataProvider;\n}\n"]}

package/lib/appui-react/hooks/useAvailableUiItemsProviders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAvailableUiItemsProviders.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useAvailableUiItemsProviders.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,SAAS,MAAM,EAAE,CAWhE"}

package/lib/appui-react/hooks/useAvailableUiItemsProviders.js

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useEffect, useState } from "react";
+import { UiItemsManager } from "../ui-items-provider/UiItemsManager.js";
+/** React hook that maintains the number of available UiItemsProviders. This allows components to use it to refresh when a
+ * UiItemsProviders is added or removed allowing the ui component to be re-rendered.
+ * @internal
+ */
+export function useAvailableUiItemsProviders() {
+    const [uiItemsProviderIds, setUiItemsProviderIds] = useState(UiItemsManager.registeredProviderIds);
+    useEffect(() => {
+        return UiItemsManager.onUiProviderRegisteredEvent.addListener(() => {
+            setUiItemsProviderIds(UiItemsManager.registeredProviderIds);
+        });
+    }, []);
+    return uiItemsProviderIds;
+}
+//# sourceMappingURL=useAvailableUiItemsProviders.js.map

package/lib/appui-react/hooks/useAvailableUiItemsProviders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAvailableUiItemsProviders.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useAvailableUiItemsProviders.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;;GAGG;AACH,MAAM,UAAU,4BAA4B;IAC1C,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAAG,QAAQ,CAC1D,cAAc,CAAC,qBAAqB,CACrC,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,cAAc,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YACjE,qBAAqB,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,kBAAkB,CAAC;AAC5B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport { UiItemsManager } from \"../ui-items-provider/UiItemsManager.js\";\n\n/** React hook that maintains the number of available UiItemsProviders. This allows components to use it to refresh when a\n * UiItemsProviders is added or removed allowing the ui component to be re-rendered.\n * @internal\n */\nexport function useAvailableUiItemsProviders(): readonly string[] {\n  const [uiItemsProviderIds, setUiItemsProviderIds] = useState(\n    UiItemsManager.registeredProviderIds\n  );\n  useEffect(() => {\n    return UiItemsManager.onUiProviderRegisteredEvent.addListener(() => {\n      setUiItemsProviderIds(UiItemsManager.registeredProviderIds);\n    });\n  }, []);\n\n  return uiItemsProviderIds;\n}\n"]}

package/lib/appui-react/hooks/useConditionalProp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConditionalProp.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useConditionalProp.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,qJAAqJ;AACrJ,UAAU,sBAAsB,CAAC,CAAC;IAChC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,EAAE,MAAM,OAAO,CAAC;IACvB,KAAK,EAAE,CAAC,CAAC;CACV;AAED,uDAAuD;AACvD,KAAK,eAAe,CAAC,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;AAepE,gBAAgB;AAChB,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,iBA4BxE"}

package/lib/appui-react/hooks/useConditionalProp.js

@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { useCallback, useSyncExternalStore } from "react";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher.js";
+/** Duck type the conditional. */
+function isConditionalValue(conditionalProp) {
+    return (typeof conditionalProp === "object" &&
+        conditionalProp &&
+        "syncEventIds" in conditionalProp &&
+        "refresh" in conditionalProp &&
+        "value" in conditionalProp);
+}
+/** @internal */
+export function useConditionalProp(conditionalProp) {
+    const subscribe = useCallback((onStoreChange) => {
+        if (isConditionalValue(conditionalProp)) {
+            return SyncUiEventDispatcher.onSyncUiEvent.addListener(({ eventIds }) => {
+                if (!SyncUiEventDispatcher.hasEventOfInterest(eventIds, conditionalProp.syncEventIds))
+                    return;
+                if (!conditionalProp.refresh())
+                    return;
+                onStoreChange();
+            });
+        }
+        return () => { };
+    }, [conditionalProp]);
+    const getSnapshot = useCallback(() => {
+        if (isConditionalValue(conditionalProp))
+            return conditionalProp.value;
+        return conditionalProp;
+    }, [conditionalProp]);
+    return useSyncExternalStore(subscribe, getSnapshot);
+}
+//# sourceMappingURL=useConditionalProp.js.map

package/lib/appui-react/hooks/useConditionalProp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConditionalProp.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useConditionalProp.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAY3E,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,kBAAkB,CAAI,eAAmC;IACvE,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,aAAyB,EAAE,EAAE;QAC5B,IAAI,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CACpD,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;gBACf,IACE,CAAC,qBAAqB,CAAC,kBAAkB,CACvC,QAAQ,EACR,eAAe,CAAC,YAAY,CAC7B;oBAED,OAAO;gBACT,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE;oBAAE,OAAO;gBAEvC,aAAa,EAAE,CAAC;YAClB,CAAC,CACF,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;IACF,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,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 { useCallback, useSyncExternalStore } from \"react\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher.js\";\n\n/** Defines a common interface for existing conditional value classes: `ConditionalBooleanValue`, `ConditionalStringValue`, `ConditionalIconItem`. */\ninterface CommonConditionalValue<T> {\n  syncEventIds: string[];\n  refresh: () => boolean;\n  value: T;\n}\n\n/** Type that is usually used in a conditional prop. */\ntype ConditionalProp<T> = CommonConditionalValue<T> | T | undefined;\n\n/** Duck type the conditional. */\nfunction isConditionalValue<T>(\n  conditionalProp: ConditionalProp<T>\n): conditionalProp is CommonConditionalValue<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 useConditionalProp<T>(conditionalProp: ConditionalProp<T>) {\n  const subscribe = useCallback(\n    (onStoreChange: () => void) => {\n      if (isConditionalValue(conditionalProp)) {\n        return SyncUiEventDispatcher.onSyncUiEvent.addListener(\n          ({ eventIds }) => {\n            if (\n              !SyncUiEventDispatcher.hasEventOfInterest(\n                eventIds,\n                conditionalProp.syncEventIds\n              )\n            )\n              return;\n            if (!conditionalProp.refresh()) return;\n\n            onStoreChange();\n          }\n        );\n      }\n      return () => {};\n    },\n    [conditionalProp]\n  );\n  const getSnapshot = useCallback(() => {\n    if (isConditionalValue(conditionalProp)) return conditionalProp.value;\n    return conditionalProp;\n  }, [conditionalProp]);\n  return useSyncExternalStore(subscribe, getSnapshot);\n}\n"]}

package/lib/appui-react/hooks/useConditionalValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConditionalValue.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useConditionalValue.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KA2B3E"}

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

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+import * as React from "react";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher.js";
+/** Hook that allows to get a value that depends on some sync UI events.
+ * @note This can be used as a replacement for a deprecated {@link @itwin/core-react#ConditionalIconItem}.
+ * @public
+ */
+export function useConditionalValue(getValue, eventIds) {
+    const [value, setValue] = React.useState(() => getValue());
+    const getValueRef = React.useRef(getValue);
+    React.useEffect(() => {
+        getValueRef.current = getValue;
+    }, [getValue]);
+    const eventIdsRef = React.useRef(eventIds);
+    React.useEffect(() => {
+        eventIdsRef.current = eventIds;
+    }, [eventIds]);
+    React.useEffect(() => {
+        return SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
+            if (!SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, eventIdsRef.current))
+                return;
+            setValue(getValueRef.current());
+        });
+    }, []);
+    return value;
+}
+//# sourceMappingURL=useConditionalValue.js.map

package/lib/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,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAI,QAAiB,EAAE,QAAkB;IAC1E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE3D,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAC;IACjC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAC;IACjC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YAC9D,IACE,CAAC,qBAAqB,CAAC,kBAAkB,CACvC,IAAI,CAAC,QAAQ,EACb,WAAW,CAAC,OAAO,CACpB;gBAED,OAAO;YACT,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,KAAK,CAAC;AACf,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 { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher.js\";\n\n/** Hook that allows to get a value that depends on some sync UI events.\n * @note This can be used as a replacement for a deprecated {@link @itwin/core-react#ConditionalIconItem}.\n * @public\n */\nexport function useConditionalValue<T>(getValue: () => T, eventIds: string[]) {\n  const [value, setValue] = React.useState(() => getValue());\n\n  const getValueRef = React.useRef(getValue);\n  React.useEffect(() => {\n    getValueRef.current = getValue;\n  }, [getValue]);\n\n  const eventIdsRef = React.useRef(eventIds);\n  React.useEffect(() => {\n    eventIdsRef.current = eventIds;\n  }, [eventIds]);\n\n  React.useEffect(() => {\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {\n      if (\n        !SyncUiEventDispatcher.hasEventOfInterest(\n          args.eventIds,\n          eventIdsRef.current\n        )\n      )\n        return;\n      setValue(getValueRef.current());\n    });\n  }, []);\n\n  return value;\n}\n"]}

package/lib/appui-react/hooks/useEscapeSetFocusToHome.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEscapeSetFocusToHome.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useEscapeSetFocusToHome.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,IAAI,CAInE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,kCAEtC"}

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

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import * as React from "react";
+import { Key } from "ts-key-enum";
+import { UiFramework } from "../UiFramework.js";
+/** Keyboard Event handler to set focus to Home on Escape key
+ * @internal
+ */
+export function onEscapeSetFocusToHome(e) {
+    if (e.key === Key.Escape.valueOf()) {
+        UiFramework.keyboardShortcuts.setFocusToHome();
+    }
+}
+/** useCallback Hook for Keyboard Event handler to set focus to Home on Escape key
+ * @internal
+ */
+export function useEscapeSetFocusToHome() {
+    return React.useCallback(onEscapeSetFocusToHome, []);
+}
+//# sourceMappingURL=useEscapeSetFocusToHome.js.map

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

@@ -0,0 +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,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,CAAsB;IAC3D,IAAI,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QACnC,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;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.js\";\n\n/** Keyboard Event handler to set focus to Home on Escape key\n * @internal\n */\nexport function onEscapeSetFocusToHome(e: React.KeyboardEvent): void {\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/appui-react/hooks/useScheduleAnimationDataProvider.d.ts

@@ -0,0 +1,10 @@
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { ScheduleAnimationTimelineDataProvider } from "../timeline/ScheduleAnimationProvider.js";
+import type { ScreenViewport } from "@itwin/core-frontend";
+/** Hook that returns either a ScheduleAnimationTimelineDataProvider or undefined based on if the supplied viewport contains schedule script.
+ * @public
+ **/
+export declare function useScheduleAnimationDataProvider(viewport: ScreenViewport | undefined): ScheduleAnimationTimelineDataProvider | undefined;
+//# sourceMappingURL=useScheduleAnimationDataProvider.d.ts.map

package/lib/appui-react/hooks/useScheduleAnimationDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScheduleAnimationDataProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useScheduleAnimationDataProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,qCAAqC,EAAE,MAAM,0CAA0C,CAAC;AACjG,OAAO,KAAK,EAAE,cAAc,EAAY,MAAM,sBAAsB,CAAC;AA8BrE;;IAEI;AACJ,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,cAAc,GAAG,SAAS,qDAqBrC"}

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

@@ -0,0 +1,55 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import * as React from "react";
+import { ScheduleAnimationTimelineDataProvider } from "../timeline/ScheduleAnimationProvider.js";
+/** @internal */
+function useSupportsScheduleScript(viewport) {
+    const [supportsScheduleScript, setSupportsScheduleScript] = React.useState(!!viewport?.view?.scheduleScript);
+    React.useEffect(() => {
+        setSupportsScheduleScript(!!viewport?.view?.scheduleScript);
+    }, [viewport]);
+    React.useEffect(() => {
+        return viewport?.onChangeView.addListener((vp) => {
+            const hasScheduleScript = !!vp?.view?.scheduleScript;
+            if (hasScheduleScript !== supportsScheduleScript)
+                setSupportsScheduleScript(hasScheduleScript);
+        });
+    }, [supportsScheduleScript, viewport]);
+    React.useEffect(() => {
+        return viewport?.onDisplayStyleChanged.addListener((vp) => {
+            const hasScheduleScript = !!vp?.view?.scheduleScript;
+            if (hasScheduleScript !== supportsScheduleScript)
+                setSupportsScheduleScript(hasScheduleScript);
+        });
+    }, [viewport, supportsScheduleScript]);
+    return supportsScheduleScript;
+}
+/** Hook that returns either a ScheduleAnimationTimelineDataProvider or undefined based on if the supplied viewport contains schedule script.
+ * @public
+ **/
+export function useScheduleAnimationDataProvider(viewport) {
+    const supportsScheduleScript = useSupportsScheduleScript(viewport);
+    const [dataProvider, setDataProvider] = React.useState();
+    React.useEffect(() => {
+        async function fetchNewDataProvider(vp) {
+            let newProvider = new ScheduleAnimationTimelineDataProvider(vp.view, vp);
+            if (newProvider?.supportsTimelineAnimation) {
+                const dataLoaded = await newProvider.loadTimelineData();
+                if (!dataLoaded)
+                    newProvider = undefined;
+            }
+            setDataProvider(newProvider);
+        }
+        if (supportsScheduleScript && viewport)
+            void fetchNewDataProvider(viewport);
+        else
+            setDataProvider(undefined);
+    }, [supportsScheduleScript, viewport]);
+    return dataProvider;
+}
+//# sourceMappingURL=useScheduleAnimationDataProvider.js.map

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

@@ -0,0 +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,0CAA0C,CAAC;AAGjG,gBAAgB;AAChB,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,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,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,CAAC;IACL,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;YACxD,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,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACvC,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;IAEI;AACJ,MAAM,UAAU,gCAAgC,CAC9C,QAAoC;IAEpC,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,EAEnD,CAAC;IACJ,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,CAAC;gBAC3C,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAI,CAAC,UAAU;oBAAE,WAAW,GAAG,SAAS,CAAC;YAC3C,CAAC;YACD,eAAe,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,sBAAsB,IAAI,QAAQ;YAAE,KAAK,oBAAoB,CAAC,QAAQ,CAAC,CAAC;;YACvE,eAAe,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC,EAAE,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvC,OAAO,YAAY,CAAC;AACtB,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.js\";\nimport type { ScreenViewport, Viewport } from \"@itwin/core-frontend\";\n\n/** @internal */\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    return viewport?.onChangeView.addListener((vp) => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\n    });\n  }, [supportsScheduleScript, viewport]);\n\n  React.useEffect(() => {\n    return viewport?.onDisplayStyleChanged.addListener((vp) => {\n      const hasScheduleScript = !!vp?.view?.scheduleScript;\n      if (hasScheduleScript !== supportsScheduleScript)\n        setSupportsScheduleScript(hasScheduleScript);\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 **/\nexport function useScheduleAnimationDataProvider(\n  viewport: ScreenViewport | undefined\n) {\n  const supportsScheduleScript = useSupportsScheduleScript(viewport);\n  const [dataProvider, setDataProvider] = React.useState<\n    ScheduleAnimationTimelineDataProvider | undefined\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      setDataProvider(newProvider);\n    }\n    if (supportsScheduleScript && viewport) void fetchNewDataProvider(viewport);\n    else setDataProvider(undefined);\n  }, [supportsScheduleScript, viewport]);\n\n  return dataProvider;\n}\n"]}

package/lib/appui-react/hooks/useSolarDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSolarDataProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useSolarDataProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAY,MAAM,sBAAsB,CAAC;AAqCrE;;IAEI;AACJ,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,cAAc,GAAG,SAAS,GACnC,iBAAiB,GAAG,SAAS,CAiB/B"}

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

@@ -0,0 +1,56 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import * as React from "react";
+import { SolarTimelineDataProvider } from "../timeline/SolarTimelineDataProvider.js";
+/** @internal */
+function useSupportsShadowDisplay(viewport) {
+    const [supportsShadows, setSupportsShadows] = React.useState(!!viewport?.displayStyle?.wantShadows);
+    React.useEffect(() => {
+        setSupportsShadows(!!viewport?.displayStyle?.wantShadows);
+    }, [viewport]);
+    React.useEffect(() => {
+        return viewport?.onChangeView.addListener((vp) => {
+            setSupportsShadows(!!vp?.displayStyle?.wantShadows);
+        });
+    }, [viewport]);
+    React.useEffect(() => {
+        const handleViewChanged = (vp) => {
+            const wantShadows = !!vp.displayStyle?.wantShadows;
+            if (wantShadows !== supportsShadows)
+                setSupportsShadows(wantShadows);
+        };
+        return viewport?.onChangeView.addListener(handleViewChanged);
+    }, [viewport, supportsShadows]);
+    React.useEffect(() => {
+        return viewport?.onDisplayStyleChanged.addListener((vp) => {
+            const wantShadows = !!vp.displayStyle?.wantShadows;
+            if (wantShadows !== supportsShadows)
+                setSupportsShadows(wantShadows);
+        });
+    }, [viewport, supportsShadows]);
+    return supportsShadows;
+}
+/** Hook that returns either a SolarTimelineDataProvider or undefined based on if the supplied viewport's display style is set to display shadows.
+ * @beta
+ **/
+export function useSolarDataProvider(viewport) {
+    const supportsShadowDisplay = useSupportsShadowDisplay(viewport);
+    const [solarDataProvider, setSolarDataProvider] = React.useState(() => {
+        return supportsShadowDisplay && viewport
+            ? new SolarTimelineDataProvider(viewport.view, viewport)
+            : undefined;
+    });
+    React.useEffect(() => {
+        const newSolarDataProvider = supportsShadowDisplay && viewport
+            ? new SolarTimelineDataProvider(viewport.view, viewport)
+            : undefined;
+        setSolarDataProvider(newSolarDataProvider);
+    }, [supportsShadowDisplay, viewport]);
+    return solarDataProvider;
+}
+//# sourceMappingURL=useSolarDataProvider.js.map

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

@@ -0,0 +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,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAErF,gBAAgB;AAChB,SAAS,wBAAwB,CAAC,QAAoC;IACpE,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,WAAW,CACtC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,kBAAkB,CAAC,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,EAAQ,EAAE;YACrD,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,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,GAAG,CAAC,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC;YACnD,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,OAAO,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;YACxD,MAAM,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC;YACnD,IAAI,WAAW,KAAK,eAAe;gBAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;IAEI;AACJ,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 { SolarTimelineDataProvider } from \"../timeline/SolarTimelineDataProvider.js\";\n\n/** @internal */\nfunction useSupportsShadowDisplay(viewport: ScreenViewport | undefined) {\n  const [supportsShadows, setSupportsShadows] = React.useState(\n    !!viewport?.displayStyle?.wantShadows\n  );\n\n  React.useEffect(() => {\n    setSupportsShadows(!!viewport?.displayStyle?.wantShadows);\n  }, [viewport]);\n\n  React.useEffect(() => {\n    return viewport?.onChangeView.addListener((vp): void => {\n      setSupportsShadows(!!vp?.displayStyle?.wantShadows);\n    });\n  }, [viewport]);\n\n  React.useEffect(() => {\n    const handleViewChanged = (vp: Viewport): void => {\n      const wantShadows = !!vp.displayStyle?.wantShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\n    };\n    return viewport?.onChangeView.addListener(handleViewChanged);\n  }, [viewport, supportsShadows]);\n\n  React.useEffect(() => {\n    return viewport?.onDisplayStyleChanged.addListener((vp) => {\n      const wantShadows = !!vp.displayStyle?.wantShadows;\n      if (wantShadows !== supportsShadows) setSupportsShadows(wantShadows);\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 **/\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/appui-react/hooks/useTranslation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTranslation.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useTranslation.tsx"],"names":[],"mappings":"AASA;;GAEG;AACH,wBAAgB,cAAc;;EAY7B"}

package/lib/appui-react/hooks/useTranslation.js

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import * as defaults from "../UiFramework.json";
+import * as React from "react";
+import { usePackageTranslation } from "@itwin/core-react/internal";
+import { UiFramework } from "../UiFramework.js";
+/** Returns a translation function.
+ * @internal
+ */
+export function useTranslation() {
+    const fallback = React.useCallback((key) => {
+        if (!UiFramework.initialized) {
+            return undefined;
+        }
+        return UiFramework.translate(key);
+    }, []);
+    return usePackageTranslation({
+        namespace: UiFramework.localizationNamespace,
+        fallback,
+        defaults,
+    });
+}
+//# sourceMappingURL=useTranslation.js.map

package/lib/appui-react/hooks/useTranslation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTranslation.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useTranslation.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,GAAW,EAAE,EAAE;QACjD,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,qBAAqB,CAAC;QAC3B,SAAS,EAAE,WAAW,CAAC,qBAAqB;QAC5C,QAAQ;QACR,QAAQ;KACT,CAAC,CAAC;AACL,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 *--------------------------------------------------------------------------------------------*/\nimport * as defaults from \"../UiFramework.json\";\nimport * as React from \"react\";\nimport { usePackageTranslation } from \"@itwin/core-react/internal\";\nimport { UiFramework } from \"../UiFramework.js\";\n\n/** Returns a translation function.\n * @internal\n */\nexport function useTranslation() {\n  const fallback = React.useCallback((key: string) => {\n    if (!UiFramework.initialized) {\n      return undefined;\n    }\n    return UiFramework.translate(key);\n  }, []);\n  return usePackageTranslation({\n    namespace: UiFramework.localizationNamespace,\n    fallback,\n    defaults,\n  });\n}\n"]}

package/lib/appui-react/hooks/useUiVisibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUiVisibility.d.ts","sourceRoot":"","sources":["../../../src/appui-react/hooks/useUiVisibility.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,gBAAgB;AAChB,wBAAgB,eAAe,YAS9B"}

package/lib/appui-react/hooks/useUiVisibility.js

@@ -0,0 +1,21 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useEffect, useState } from "react";
+import { UiFramework } from "../UiFramework.js";
+/** @internal */
+export function useUiVisibility() {
+    // eslint-disable-next-line deprecation/deprecation
+    const [uiIsVisible, setUiIsVisible] = useState(UiFramework.getIsUiVisible());
+    useEffect(() => {
+        return UiFramework.onUiVisibilityChanged.addListener((args) => {
+            setUiIsVisible(args.visible);
+        });
+    }, []);
+    return uiIsVisible;
+}
+//# sourceMappingURL=useUiVisibility.js.map

package/lib/appui-react/hooks/useUiVisibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUiVisibility.js","sourceRoot":"","sources":["../../../src/appui-react/hooks/useUiVisibility.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,gBAAgB;AAChB,MAAM,UAAU,eAAe;IAC7B,mDAAmD;IACnD,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7E,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,WAAW,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5D,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport { UiFramework } from \"../UiFramework.js\";\n\n/** @internal */\nexport function useUiVisibility() {\n  // eslint-disable-next-line deprecation/deprecation\n  const [uiIsVisible, setUiIsVisible] = useState(UiFramework.getIsUiVisible());\n  useEffect(() => {\n    return UiFramework.onUiVisibilityChanged.addListener((args) => {\n      setUiIsVisible(args.visible);\n    });\n  }, []);\n  return uiIsVisible;\n}\n"]}

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

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut.js";
+import type { KeyboardShortcutProps } from "./KeyboardShortcutProps.js";
+/** 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/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;AAKH,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAOxE;;GAEG;AACH,qBAAa,+BAA+B;IAC1C,OAAO,CAAC,MAAM,CAAC,UAAU,CACS;IAElC;;OAEG;WACW,UAAU,IAAI,IAAI;IAMhC,qDAAqD;WACvC,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMjE,sDAAsD;WACxC,YAAY,CAAC,aAAa,EAAE,qBAAqB;IAK/D,qEAAqE;WACvD,UAAU,CACtB,WAAW,EAAE,MAAM,EACnB,eAAe,GAAE,OAAe,EAChC,gBAAgB,GAAE,OAAe,EACjC,iBAAiB,GAAE,OAAe,GACjC,OAAO;IAiBV,qDAAqD;IACrD,WAAkB,iBAAiB,IAAI,yBAAyB,CAE/D;IAED,yDAAyD;WAC3C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1E,yCAAyC;IACzC,WAAkB,aAAa,IAAI,OAAO,CAGzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAQpC,yDAAyD;WAC3C,WAAW,IAAI,IAAI;IAMjC,yCAAyC;WAC3B,SAAS,IAAI,IAAI;IAS/B,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IACD,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAElC;IAED,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAuB/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAgB/B;CACH"}