@itwin/itwinui-react 3.9.1 → 3.10.1

package/esm/utils/providers/ScopeProvider.js

@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import * as React from 'react';
+import { createStore, useAtomValue, useSetAtom } from 'jotai';
+const ScopeContext = React.createContext({
+    store: createStore(),
+    parentStore: null,
+});
+/**
+ * Provider that creates a fresh, isolated jotai store for its children.
+ *
+ * Should be used with `useScopedAtom` and/or `useScopedSetAtom`.
+ *
+ * @private
+ */
+export const ScopeProvider = ({ children }) => {
+    const store = React.useMemo(() => createStore(), []);
+    const parentStore = React.useContext(ScopeContext).store;
+    return (React.createElement(ScopeContext.Provider, { value: React.useMemo(() => ({ store, parentStore }), [store, parentStore]) }, children));
+};
+/**
+ * Wrapper over `useAtom` that uses the store from the nearest `ScopeProvider`.
+ *
+ * If the atom is not set in the current store, it will recursively look in the parent store(s).
+ * This is only useful for initial values. Future updates to the parent will not be reflected.
+ *
+ * @private
+ */
+export const useScopedAtom = (atom) => {
+    const { store, parentStore } = React.useContext(ScopeContext);
+    const setAtom = useScopedSetAtom(atom);
+    const value = useAtomValue(atom, { store });
+    const inheritedValue = useAtomValue(atom, { store: parentStore || store });
+    if (value == undefined && inheritedValue != undefined) {
+        setAtom(inheritedValue);
+    }
+    return [value, setAtom];
+};
+/**
+ * Wrapper over `useSetAtom` that uses the store from the nearest `ScopeProvider`.
+ * @private
+ */
+export const useScopedSetAtom = (atom) => {
+    const { store } = React.useContext(ScopeContext);
+    return useSetAtom(atom, { store });
+};

package/esm/utils/providers/index.d.ts

@@ -1 +1,2 @@
 export * from './HydrationProvider.js';
+export * from './ScopeProvider.js';

package/esm/utils/providers/index.js

@@ -3,3 +3,4 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 export * from './HydrationProvider.js';
+export * from './ScopeProvider.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/itwinui-react",
-  "version": "3.9.1",
+  "version": "3.10.1",
   "author": "Bentley Systems",
   "license": "MIT",
   "type": "module",
@@ -59,6 +59,7 @@
     "@floating-ui/react": "^0.26.10",
     "@itwin/itwinui-illustrations-react": "^2.1.0",
     "classnames": "^2.3.2",
+    "jotai": "^2.8.0",
     "react-table": "^7.8.0",
     "react-transition-group": "^4.4.5",
     "tslib": "^2.6.0"