@dxos/react-hooks 0.8.4-main.e098934 → 0.8.4-main.e8ec1fe

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-hooks",
-  "version": "0.8.4-main.e098934",
+  "version": "0.8.4-main.e8ec1fe",
   "description": "React hooks supporting DXOS React primitives.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -26,21 +26,23 @@
   ],
   "dependencies": {
     "@preact-signals/safe-react": "^0.9.0",
+    "@radix-ui/react-use-controllable-state": "^1.2.2",
     "alea": "^1.0.1",
     "lodash.defaultsdeep": "^4.6.1",
-    "@dxos/async": "0.8.4-main.e098934",
-    "@dxos/log": "0.8.4-main.e098934"
+    "mini-virtual-list": "^0.3.2",
+    "@dxos/async": "0.8.4-main.e8ec1fe",
+    "@dxos/log": "0.8.4-main.e8ec1fe"
   },
   "devDependencies": {
     "@types/lodash.defaultsdeep": "^4.6.6",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0"
+    "@types/react": "~19.2.2",
+    "@types/react-dom": "~19.2.2",
+    "react": "~19.2.0",
+    "react-dom": "~19.2.0"
   },
   "peerDependencies": {
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -16,8 +16,9 @@ export * from './useIsFocused';
 export * from './useMediaQuery';
 export * from './useMulticastObservable';
 export * from './useRefCallback';
-export * from './useResize';
+export * from './useViewportResize';
 export * from './useSignals';
 export * from './useTimeout';
-export * from './useTrackProps';
 export * from './useTransitions';
+
+export { useSize, useScroller } from 'mini-virtual-list';

package/src/useControlledState.ts

@@ -2,27 +2,37 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Dispatch, type SetStateAction, useEffect, useState } from 'react';
+import { type Dispatch, type SetStateAction, useCallback, useEffect, useRef, useState } from 'react';
+
+import { useDynamicRef } from './useDynamicRef';
 
 /**
  * A stateful hook with a controlled value.
- * NOTE: Be careful not to provide an inlinde default array.
+ * @deprecated Use Radix `useControllableState` (NOTE: `useControlledState` is not compatible with `useControllableState`)
  */
 export const useControlledState = <T>(
-  controlledValue: T,
+  valueParam: T,
   onChange?: (value: T) => void,
-  ...deps: any[]
 ): [T, Dispatch<SetStateAction<T>>] => {
-  const [value, setValue] = useState<T>(controlledValue);
+  const [value, setControlledValue] = useState(valueParam);
   useEffect(() => {
-    if (controlledValue !== undefined) {
-      setValue(controlledValue);
-    }
-  }, [controlledValue, ...deps]);
+    setControlledValue(valueParam);
+  }, [valueParam]);
 
-  useEffect(() => {
-    onChange?.(value);
-  }, [value, onChange]);
+  const onChangeRef = useRef(onChange);
+  const valueRef = useDynamicRef(valueParam);
+  const setValue = useCallback<Dispatch<SetStateAction<T>>>(
+    (nextValue) => {
+      const value = isFunction(nextValue) ? nextValue(valueRef.current) : nextValue;
+      setControlledValue(value);
+      onChangeRef.current?.(value);
+    },
+    [valueRef, onChangeRef],
+  );
 
   return [value, setValue];
 };
+
+function isFunction(value: unknown): value is (...args: any[]) => any {
+  return typeof value === 'function';
+}

package/src/useDebugDeps.ts

@@ -7,12 +7,12 @@ import { type DependencyList, useEffect, useRef } from 'react';
 /**
  * Util to log deps that have changed.
  */
-export const useDebugDeps = (deps: DependencyList = []) => {
+export const useDebugDeps = (deps: DependencyList = [], active = true) => {
   const lastDeps = useRef<DependencyList>([]);
   useEffect(() => {
     console.group('deps changed', { previous: lastDeps.current.length, current: deps.length });
     for (let i = 0; i < Math.max(lastDeps.current.length ?? 0, deps.length ?? 0); i++) {
-      if (lastDeps.current[i] !== deps[i]) {
+      if (lastDeps.current[i] !== deps[i] && active) {
         console.log('changed', {
           index: i,
           previous: lastDeps.current[i],

package/src/useDynamicRef.ts

@@ -3,14 +3,14 @@
 //
 
 import { useCallback } from '@preact-signals/safe-react/react';
-import { type Dispatch, type MutableRefObject, type SetStateAction, useEffect, useRef, useState } from 'react';
+import { type Dispatch, type RefObject, type SetStateAction, useEffect, useRef, useState } from 'react';
 
 /**
  * Like `useState` but with an additional dynamic value.
  */
-export const useStateWithRef = <T>(value$: T): [T, Dispatch<SetStateAction<T>>, MutableRefObject<T>] => {
-  const [value, setValue] = useState<T>(value$);
-  const valueRef = useRef<T>(value$);
+export const useStateWithRef = <T>(valueParam: T): [T, Dispatch<SetStateAction<T>>, RefObject<T>] => {
+  const [value, setValue] = useState<T>(valueParam);
+  const valueRef = useRef<T>(valueParam);
   const setter = useCallback<Dispatch<SetStateAction<T>>>((value) => {
     if (typeof value === 'function') {
       setValue((current) => {
@@ -29,7 +29,7 @@ export const useStateWithRef = <T>(value$: T): [T, Dispatch<SetStateAction<T>>,
 /**
  * Ref that is updated by a dependency.
  */
-export const useDynamicRef = <T>(value: T): MutableRefObject<T> => {
+export const useDynamicRef = <T>(value: T): RefObject<T> => {
   const valueRef = useRef<T>(value);
   useEffect(() => {
     valueRef.current = value;

package/src/useForwardedRef.ts

@@ -2,25 +2,60 @@
 // Copyright 2022 DXOS.org
 //
 
-import { type ForwardedRef, useEffect, useRef } from 'react';
+import { type ForwardedRef, type Ref, type RefCallback, useEffect, useMemo, useRef } from 'react';
 
 /**
  * Combines a possibly undefined forwarded ref with a locally defined ref.
- * @deprecated Use @radix-ui/react-compose-refs
+ * Returns a stable ref object that synchronizes with the forwarded ref.
+ *
+ * Best practice: This hook creates a stable local ref and synchronizes it with the forwarded ref.
+ * The returned ref object is stable across renders, preventing infinite loops caused by ref identity changes.
+ *
+ * NOTE: This pattern doesn't update refs once they are set. If this is required, use `useMergeRefs`.
  */
-export const useForwardedRef = <T>(ref: ForwardedRef<T>) => {
-  const innerRef = useRef<T>(null);
+export const useForwardedRef = <T>(forwardedRef: ForwardedRef<T>) => {
+  const localRef = useRef<T>(null as T);
   useEffect(() => {
-    if (!ref) {
-      return;
-    }
+    setRef(forwardedRef, localRef.current);
+  }, [forwardedRef]);
+
+  return localRef;
+};
+
+/**
+ * Sets a value on a React ref, handling both callback refs and ref objects.
+ * Returns a cleanup function if the ref is a callback ref.
+ */
+export function setRef<T>(ref: Ref<T> | undefined | null, value: T | null): ReturnType<RefCallback<T>> {
+  if (typeof ref === 'function') {
+    return ref(value);
+  } else if (ref) {
+    ref.current = value;
+  }
+}
 
-    if (typeof ref === 'function') {
-      ref(innerRef.current);
-    } else {
-      ref.current = innerRef.current;
+/**
+ * Merges multiple refs into a single ref callback.
+ * Returns a ref callback that synchronizes all provided refs and handles cleanup.
+ */
+export const mergeRefs = <T>(refs: (Ref<T> | undefined)[]): Ref<T> => {
+  return (value: T | null) => {
+    const cleanups: (() => void)[] = [];
+    for (const ref of refs) {
+      const cleanup = setRef(ref, value);
+      cleanups.push(typeof cleanup === 'function' ? cleanup : () => setRef(ref, null));
     }
-  });
 
-  return innerRef;
+    return () => {
+      for (const cleanup of cleanups) cleanup();
+    };
+  };
+};
+
+/**
+ * Hook that merges multiple refs into a single stable ref callback.
+ * The returned ref is memoized and only changes when the refs array changes.
+ */
+export const useMergeRefs = <T>(refs: (Ref<T> | undefined)[]): Ref<T> => {
+  return useMemo(() => mergeRefs(refs), refs);
 };

package/src/useIsFocused.ts

@@ -7,7 +7,7 @@
 
 import { type RefObject, useEffect, useRef, useState } from 'react';
 
-export const useIsFocused = (inputRef: RefObject<HTMLInputElement>) => {
+export const useIsFocused = (inputRef: RefObject<HTMLInputElement | null>) => {
   const [isFocused, setIsFocused] = useState<boolean | undefined>(undefined);
   const isFocusedRef = useRef<boolean | undefined>(isFocused);
 

package/src/useMediaQuery.ts

@@ -6,12 +6,7 @@
 
 import { useEffect, useState } from 'react';
 
-export type UseMediaQueryOptions = {
-  fallback?: boolean | boolean[];
-  ssr?: boolean;
-};
-
-// TODO(thure): This should be derived from the same source of truth as the Tailwind theme config
+// TODO(thure): This should be derived from the same source of truth as the Tailwind theme config.
 const breakpointMediaQueries: Record<string, string> = {
   sm: '(min-width: 640px)',
   md: '(min-width: 768px)',
@@ -20,8 +15,13 @@ const breakpointMediaQueries: Record<string, string> = {
   '2xl': '(min-width: 1536px)',
 };
 
+export type UseMediaQueryOptions = {
+  fallback?: boolean | boolean[];
+  ssr?: boolean;
+};
+
 /**
- * React hook that tracks state of a CSS media query
+ * React hook that tracks state of a CSS media query.
  *
  * @param query the media query to match, or a recognized breakpoint token
  * @param options the media query options { fallback, ssr }
@@ -29,8 +29,7 @@ const breakpointMediaQueries: Record<string, string> = {
  * @see Docs https://chakra-ui.com/docs/hooks/use-media-query
  */
 export const useMediaQuery = (query: string | string[], options: UseMediaQueryOptions = {}): boolean[] => {
-  // TODO(wittjosiah): Why is the default here true?
-  const { ssr = true, fallback } = options;
+  const { ssr = false, fallback } = options;
 
   const queries = (Array.isArray(query) ? query : [query]).map((query) =>
     query in breakpointMediaQueries ? breakpointMediaQueries[query] : query,

package/src/{useMulticastObservable.test.tsx → useMulticastObservable.test.ts}

@@ -15,9 +15,7 @@ describe('useMulticastObservable', () => {
     const observable = MulticastObservable.from(event, 0);
     const { result } = renderHook(() => useMulticastObservable(observable));
     expect(result.current).toEqual(0);
-
-    await act(() => event.emit(1));
-
+    act(() => event.emit(1));
     await expect.poll(() => result.current).toEqual(1);
   });
 });

package/src/useTransitions.ts

@@ -48,7 +48,9 @@ export const useDidTransition = <T>(
  * Executes a callback function when a specified transition occurs in a value.
  *
  * This function utilizes the `useDidTransition` hook to monitor changes in `currentValue`.
- * When `currentValue` transitions from `fromValue` to `toValue`, the provided `callback` function is executed. */
+ * When `currentValue` transitions from `fromValue` to `toValue`, the provided `callback` function is executed.
+ */
+// TODO(wittjosiah): Seems overwrought.
 export const useOnTransition = <T>(
   currentValue: T,
   fromValue: T | ((value: T) => boolean),

package/src/{useResize.ts → useViewportResize.ts}

@@ -4,7 +4,7 @@
 
 import { useLayoutEffect, useMemo } from 'react';
 
-export const useResize = (
+export const useViewportResize = (
   handler: (event?: Event) => void,
   deps: Parameters<typeof useLayoutEffect>[1] = [],
   delay: number = 800,

package/dist/types/src/useAsyncEffect.stories.d.ts

@@ -1,9 +0,0 @@
-import '@dxos-theme';
-import { type StoryObj } from '@storybook/react-vite';
-declare const meta: {
-    title: string;
-};
-export default meta;
-type Story = StoryObj<typeof meta>;
-export declare const Default: Story;
-//# sourceMappingURL=useAsyncEffect.stories.d.ts.map

package/dist/types/src/useAsyncEffect.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAsyncEffect.stories.d.ts","sourceRoot":"","sources":["../../../src/useAsyncEffect.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAOjE,QAAA,MAAM,IAAI;;CAEM,CAAC;AAEjB,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnC,eAAO,MAAM,OAAO,EAAE,KAYrB,CAAC"}

package/dist/types/src/useResize.d.ts

@@ -1,3 +0,0 @@
-import { useLayoutEffect } from 'react';
-export declare const useResize: (handler: (event?: Event) => void, deps?: Parameters<typeof useLayoutEffect>[1], delay?: number) => void;
-//# sourceMappingURL=useResize.d.ts.map

package/dist/types/src/useResize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useResize.d.ts","sourceRoot":"","sources":["../../../src/useResize.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAW,MAAM,OAAO,CAAC;AAEjD,eAAO,MAAM,SAAS,GACpB,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,EAChC,OAAM,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAM,EAChD,QAAO,MAAY,SAiBpB,CAAC"}

package/dist/types/src/useTrackProps.d.ts

@@ -1,5 +0,0 @@
-/**
- * Use to debug which props have changed to trigger re-renders in a React component.
- */
-export declare const useTrackProps: <T extends Record<string, unknown>>(props: T, componentName?: string, active?: boolean) => void;
-//# sourceMappingURL=useTrackProps.d.ts.map

package/dist/types/src/useTrackProps.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTrackProps.d.ts","sourceRoot":"","sources":["../../../src/useTrackProps.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,OAAO,CAAC,EACR,sBAA2B,EAC3B,gBAAa,SAyBd,CAAC"}

package/src/useAsyncEffect.stories.tsx

@@ -1,34 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useState } from 'react';
-
-import { sleep } from '@dxos/async';
-
-import { useAsyncEffect } from './useAsyncEffect';
-
-const meta = {
-  title: 'ui/react-hooks/useAsyncEffect',
-} satisfies Meta;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  render: () => {
-    const [value, setValue] = useState(0);
-    useAsyncEffect(async (controller) => {
-      await sleep(100);
-      if (!controller.signal.aborted) {
-        setValue((value) => value + 1);
-      }
-    }, []);
-
-    return <div>{value}</div>;
-  },
-};

package/src/useTrackProps.ts

@@ -1,40 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { useEffect, useRef } from 'react';
-
-import { log } from '@dxos/log';
-
-/**
- * Use to debug which props have changed to trigger re-renders in a React component.
- */
-export const useTrackProps = <T extends Record<string, unknown>>(
-  props: T,
-  componentName = 'Component',
-  active = true,
-) => {
-  const prevProps = useRef<T>(props);
-  useEffect(() => {
-    const changes = Object.entries(props).filter(([key]) => props[key] !== prevProps.current[key]);
-    if (changes.length > 0) {
-      if (active) {
-        log.info('props changed', {
-          componentName,
-          keys: changes.map(([key]) => key).join(','),
-          props: Object.fromEntries(
-            changes.map(([key]) => [
-              key,
-              {
-                from: prevProps.current[key],
-                to: props[key],
-              },
-            ]),
-          ),
-        });
-      }
-    }
-
-    prevProps.current = props;
-  });
-};