@react-aria/utils 3.0.0-nightly-641446f65-240905

package/src/useResizeObserver.ts

@@ -0,0 +1,48 @@
+
+import {RefObject} from '@react-types/shared';
+import {useEffect} from 'react';
+
+function hasResizeObserver() {
+  return typeof window.ResizeObserver !== 'undefined';
+}
+
+type useResizeObserverOptionsType<T> = {
+  ref: RefObject<T | undefined | null> | undefined,
+  box?: ResizeObserverBoxOptions,
+  onResize: () => void
+}
+
+export function useResizeObserver<T extends Element>(options: useResizeObserverOptionsType<T>) {
+  const {ref, box, onResize} = options;
+
+  useEffect(() => {
+    let element = ref?.current;
+    if (!element) {
+      return;
+    }
+
+    if (!hasResizeObserver()) {
+      window.addEventListener('resize', onResize, false);
+      return () => {
+        window.removeEventListener('resize', onResize, false);
+      };
+    } else {
+
+      const resizeObserverInstance = new window.ResizeObserver((entries) => {
+        if (!entries.length) {
+          return;
+        }
+
+        onResize();
+      });
+      resizeObserverInstance.observe(element, {box});
+
+      return () => {
+        if (element) {
+          resizeObserverInstance.unobserve(element);
+        }
+      };
+    }
+
+  }, [onResize, ref, box]);
+}

package/src/useSyncRef.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {MutableRefObject} from 'react';
+import {RefObject} from '@react-types/shared';
+import {useLayoutEffect} from './';
+
+interface ContextValue<T> {
+  ref?: MutableRefObject<T | null>
+}
+
+// Syncs ref from context with ref passed to hook
+export function useSyncRef<T>(context?: ContextValue<T> | null, ref?: RefObject<T | null>) {
+  useLayoutEffect(() => {
+    if (context && context.ref && ref) {
+      context.ref.current = ref.current;
+      return () => {
+        if (context.ref) {
+          context.ref.current = null;
+        }
+      };
+    }
+  });
+}

package/src/useUpdateEffect.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {EffectCallback, useEffect, useRef} from 'react';
+
+// Like useEffect, but only called for updates after the initial render.
+export function useUpdateEffect(effect: EffectCallback, dependencies: any[]) {
+  const isInitialMount = useRef(true);
+  const lastDeps = useRef<any[] | null>(null);
+
+  useEffect(() => {
+    isInitialMount.current = true;
+    return () => {
+      isInitialMount.current = false;
+    };
+  }, []);
+
+  useEffect(() => {
+    if (isInitialMount.current) {
+      isInitialMount.current = false;
+    } else if (!lastDeps.current || dependencies.some((dep, i) => !Object.is(dep, lastDeps[i]))) {
+      effect();
+    }
+    lastDeps.current = dependencies;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, dependencies);
+}

package/src/useValueEffect.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {Dispatch, MutableRefObject, useRef, useState} from 'react';
+import {useEffectEvent, useLayoutEffect} from './';
+
+type SetValueAction<S> = (prev: S) => Generator<any, void, unknown>;
+
+// This hook works like `useState`, but when setting the value, you pass a generator function
+// that can yield multiple values. Each yielded value updates the state and waits for the next
+// layout effect, then continues the generator. This allows sequential updates to state to be
+// written linearly.
+export function useValueEffect<S>(defaultValue: S | (() => S)): [S, Dispatch<SetValueAction<S>>] {
+  let [value, setValue] = useState(defaultValue);
+  let effect: MutableRefObject<Generator<S> | null> = useRef<Generator<S> | null>(null);
+
+  // Store the function in a ref so we can always access the current version
+  // which has the proper `value` in scope.
+  let nextRef = useEffectEvent(() => {
+    if (!effect.current) {
+      return;
+    }
+    // Run the generator to the next yield.
+    let newValue = effect.current.next();
+
+    // If the generator is done, reset the effect.
+    if (newValue.done) {
+      effect.current = null;
+      return;
+    }
+
+    // If the value is the same as the current value,
+    // then continue to the next yield. Otherwise,
+    // set the value in state and wait for the next layout effect.
+    if (value === newValue.value) {
+      nextRef();
+    } else {
+      setValue(newValue.value);
+    }
+  });
+
+  useLayoutEffect(() => {
+    // If there is an effect currently running, continue to the next yield.
+    if (effect.current) {
+      nextRef();
+    }
+  });
+
+  let queue = useEffectEvent(fn => {
+    effect.current = fn(value);
+    nextRef();
+  });
+
+  return [value, queue];
+}

package/src/useViewportSize.ts

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {useEffect, useState} from 'react';
+import {useIsSSR} from '@react-aria/ssr';
+
+interface ViewportSize {
+  width: number,
+  height: number
+}
+
+// @ts-ignore
+let visualViewport = typeof document !== 'undefined' && window.visualViewport;
+
+export function useViewportSize(): ViewportSize {
+  let isSSR = useIsSSR();
+  let [size, setSize] = useState(() => isSSR ? {width: 0, height: 0} : getViewportSize());
+
+  useEffect(() => {
+    // Use visualViewport api to track available height even on iOS virtual keyboard opening
+    let onResize = () => {
+      setSize(size => {
+        let newSize = getViewportSize();
+        if (newSize.width === size.width && newSize.height === size.height) {
+          return size;
+        }
+        return newSize;
+      });
+    };
+
+    if (!visualViewport) {
+      window.addEventListener('resize', onResize);
+    } else {
+      visualViewport.addEventListener('resize', onResize);
+    }
+
+    return () => {
+      if (!visualViewport) {
+        window.removeEventListener('resize', onResize);
+      } else {
+        visualViewport.removeEventListener('resize', onResize);
+      }
+    };
+  }, []);
+
+  return size;
+}
+
+function getViewportSize(): ViewportSize {
+  return {
+    width: (visualViewport && visualViewport?.width) || window.innerWidth,
+    height: (visualViewport && visualViewport?.height) || window.innerHeight
+  };
+}