@adaptabletools/adaptable-react-aggrid 19.2.3 → 20.0.0-canary.0

package/src/components/useAdaptableState.js

@@ -0,0 +1,51 @@
+import { useAdaptableAgGridContext } from './AdaptableProvider';
+import { useEffect, useRef, useState } from 'react';
+export function useAdaptableState(selector) {
+    const { adaptableApi } = useAdaptableAgGridContext();
+    const adaptable = adaptableApi?.internalApi.getAdaptableInstance();
+    const store = adaptable?.adaptableStore;
+    const [_refreshKey, setRefreshKey] = useState(0);
+    const resultRef = useRef(null);
+    const getResult = () => {
+        if (!store) {
+            return null;
+        }
+        const state = store.getCurrentStorageState();
+        if (!state) {
+            return null;
+        }
+        return selector ? selector(state) : state;
+    };
+    useEffect(() => {
+        if (!store) {
+            return;
+        }
+        return store.onAny(() => {
+            const newResult = getResult();
+            if (newResult !== resultRef.current) {
+                //only refresh when the result has changed
+                setRefreshKey((prev) => prev + 1);
+            }
+        });
+    }, [store]);
+    if (!adaptable || !adaptable.isReady) {
+        return null;
+    }
+    const res = getResult();
+    resultRef.current = res;
+    return res;
+}
+export const useCurrentLayout = () => {
+    const { adaptableApi } = useAdaptableAgGridContext();
+    const layout = useAdaptableState((state) => {
+        const currentLayout = state.Layout.CurrentLayout;
+        return state.Layout.Layouts.find((layout) => layout.Name === currentLayout);
+    });
+    const setLayout = (layoutName) => {
+        if (!adaptableApi) {
+            return;
+        }
+        adaptableApi.layoutApi.setLayout(layoutName);
+    };
+    return [layout ?? null, setLayout];
+};

package/src/index.d.ts

@@ -2,3 +2,4 @@ export { AdaptableQL, AdaptableUpgradeHelper } from '@adaptabletools/adaptable/a
 export { AdaptableOptionsWizardView } from './components/AdaptableOptionsWizardView';
 export * from '@adaptabletools/adaptable/types';
 export { Adaptable } from './components/AdaptableProvider';
+export * from './components/useAdaptableState';

package/src/index.js

@@ -3,3 +3,4 @@ export { AdaptableQL, AdaptableUpgradeHelper } from '@adaptabletools/adaptable/a
 export { AdaptableOptionsWizardView } from './components/AdaptableOptionsWizardView';
 export * from '@adaptabletools/adaptable/types';
 export { Adaptable } from './components/AdaptableProvider';
+export * from './components/useAdaptableState';