@dxos/react-ui 0.8.4-main.bc674ce → 0.8.4-main.bd9b33e6c8

package/src/components/ScrollContainer/ScrollContainer.tsx

@@ -4,8 +4,8 @@
 
 import { createContext } from '@radix-ui/react-context';
 import React, {
-  type HTMLAttributes,
   type PropsWithChildren,
+  type RefObject,
   forwardRef,
   useCallback,
   useEffect,
@@ -15,14 +15,15 @@ import React, {
   useState,
 } from 'react';
 
-// TODO(burdon): Move these deps to @dxos/dom-util.
 import { addEventListener, combine } from '@dxos/async';
 import { invariant } from '@dxos/invariant';
-import { useForwardedRef } from '@dxos/react-hooks';
-import { mx } from '@dxos/ui-theme';
+import { useMergeRefs } from '@dxos/react-hooks';
+import { composableProps, mx } from '@dxos/ui-theme';
+import { SlottableProps } from '@dxos/ui-types';
 
 import { type ThemedClassName } from '../../util';
 import { IconButton } from '../Button';
+import { ScrollArea } from '../ScrollArea';
 
 const isBottom = (el: HTMLElement | null) => {
   return !!(el && el.scrollHeight - el.scrollTop === el.clientHeight);
@@ -35,9 +36,15 @@ export interface ScrollController {
 }
 
 type ScrollContainerContextValue = {
-  scrollToBottom: (behavior?: ScrollBehavior) => void;
   controller?: ScrollController;
   pinned?: boolean;
+  overflow?: boolean;
+  /** Called by Viewport to register/unregister the scroll element. */
+  setViewport: (el: HTMLDivElement | null) => void;
+  /** Called by Viewport on wheel events to update pinned state. */
+  setPinned: (value: boolean) => void;
+  /** Called by Viewport on scroll events to update overflow state. */
+  setOverflow: (value: boolean) => void;
 };
 
 const [ScrollContainerProvider, useScrollContainerContext] =
@@ -50,98 +57,86 @@ const [ScrollContainerProvider, useScrollContainerContext] =
 type RootProps = ThemedClassName<
   PropsWithChildren<{
     pin?: boolean;
-    fade?: boolean;
     behavior?: ScrollBehavior;
   }>
 >;
 
 /**
- * Scroll container that automatically scrolls to the bottom when new content is added.
+ * Headless scroll container that provides context for scroll state.
+ * Render ScrollContainer.Viewport as a child to provide the scrollable area.
  */
 const Root = forwardRef<ScrollController, RootProps>(
-  ({ children, classNames, pin, fade, behavior: behaviorProp = 'smooth' }, forwardedRef) => {
-    const scrollerRef = useRef<HTMLDivElement>(null);
+  ({ children, pin, behavior: behaviorProp = 'smooth' }, forwardedRef) => {
+    const scrollerRef = useRef<HTMLDivElement | null>(null);
     const autoScrollRef = useRef(false);
-    const [overflow, setOverflow] = useState(false);
     const [pinned, setPinned] = useState(pin);
+    const [overflow, setOverflow] = useState(false);
 
     const timeoutRef = useRef<NodeJS.Timeout>(undefined);
-    const scrollToBottom = useCallback((behavior: ScrollBehavior = behaviorProp) => {
-      if (scrollerRef.current) {
-        // Temporarily hide scrollbar to prevent flicker.
-        autoScrollRef.current = true;
-        scrollerRef.current.classList.add('scrollbar-none');
-        scrollerRef.current.scrollTo({
-          top: scrollerRef.current.scrollHeight,
-          behavior,
-        });
-
-        clearTimeout(timeoutRef.current);
-        if (behavior !== 'instant') {
-          timeoutRef.current = setTimeout(() => {
-            scrollerRef.current?.classList.remove('scrollbar-none');
-            autoScrollRef.current = false;
-          }, 500);
+    const scrollToBottom = useCallback(
+      (behavior: ScrollBehavior = behaviorProp) => {
+        if (scrollerRef.current) {
+          if (behavior !== 'instant') {
+            // Temporarily hide scrollbar to prevent flickering during smooth scroll.
+            // For instant scrolling we skip this — there's no animation to hide,
+            // and adding the class changes element size which re-fires the ResizeObserver.
+            autoScrollRef.current = true;
+            scrollerRef.current.classList.add('scrollbar-none');
+            clearTimeout(timeoutRef.current);
+            timeoutRef.current = setTimeout(() => {
+              scrollerRef.current?.classList.remove('scrollbar-none');
+              autoScrollRef.current = false;
+            }, 500);
+          }
+
+          scrollerRef.current.scrollTo({
+            top: scrollerRef.current.scrollHeight,
+            behavior,
+          });
+
+          setPinned(true);
         }
-        setPinned(true);
-      }
-    }, []);
+      },
+      [behaviorProp],
+    );
 
-    const controller = useMemo(
+    const controller = useMemo<ScrollController>(
       () => ({
-        viewport: scrollerRef.current,
+        get viewport() {
+          return scrollerRef.current;
+        },
         scrollToTop: () => {
           invariant(scrollerRef.current);
           scrollerRef.current.scrollTo({ top: 0, behavior: 'smooth' });
           setPinned(false);
         },
-        scrollToBottom: () => {
-          scrollToBottom('smooth');
+        scrollToBottom: (behavior = 'smooth' as ScrollBehavior) => {
+          scrollToBottom(behavior);
         },
       }),
-      [scrollToBottom, scrollerRef.current],
+      [scrollToBottom],
     );
 
     // Scroll controller imperative ref.
     useImperativeHandle(forwardedRef, () => controller, [controller]);
 
-    // Listen for scroll events.
-    useEffect(() => {
-      if (!scrollerRef.current) {
-        return;
-      }
-
-      return combine(
-        // Check if user scrolls.
-        addEventListener(scrollerRef.current, 'wheel', () => {
-          setPinned(isBottom(scrollerRef.current));
-        }),
-        // Check if scrolls.
-        addEventListener(scrollerRef.current, 'scroll', () => {
-          setOverflow((scrollerRef.current?.scrollTop ?? 0) > 0);
-        }),
-      );
+    // Called by Viewport when the scroll element mounts/unmounts.
+    const setViewport = useCallback((el: HTMLDivElement | null) => {
+      scrollerRef.current = el;
     }, []);
 
     return (
-      <ScrollContainerProvider pinned={pinned} controller={controller} scrollToBottom={scrollToBottom}>
-        <div className='relative grid flex-1 min-bs-0 overflow-hidden'>
-          {fade && (
-            <div
-              role='none'
-              data-visible={overflow}
-              className={mx(
-                // NOTE: Gradients may not be visible with dark reader extensions.
-                'z-10 absolute block-start-0 inset-inline-0 bs-24 is-full',
-                'opacity-0 duration-200 transition-opacity data-[visible="true"]:opacity-100',
-                'bg-gradient-to-b from-[--surface-bg] to-transparent pointer-events-none',
-              )}
-            />
-          )}
-          <div className={mx('flex flex-col min-bs-0 overflow-y-auto scrollbar-thin', classNames)} ref={scrollerRef}>
-            {children}
-          </div>
-        </div>
+      <ScrollContainerProvider
+        pinned={pinned}
+        overflow={overflow}
+        controller={controller}
+        setViewport={setViewport}
+        setPinned={setPinned}
+        setOverflow={setOverflow}
+      >
+        <ScrollArea.Root thin centered padding className='relative'>
+          {children}
+        </ScrollArea.Root>
       </ScrollContainerProvider>
     );
   },
@@ -153,43 +148,133 @@ Root.displayName = 'ScrollContainer.Root';
 // Viewport
 //
 
-type ViewportProps = ThemedClassName<PropsWithChildren<Omit<HTMLAttributes<HTMLDivElement>, 'className'>>>;
+const VIEWPORT_NAME = 'ScrollContainer.Viewport';
+
+type ViewportProps = SlottableProps;
 
-const Viewport = forwardRef<HTMLDivElement, ViewportProps>(({ classNames, children, ...props }, forwardedRef) => {
-  const contentRef = useForwardedRef(forwardedRef);
-  const { pinned, scrollToBottom } = useScrollContainerContext(Viewport.displayName!);
+const Viewport = forwardRef<HTMLDivElement, ViewportProps>(({ children, ...props }, forwardedRef) => {
+  const scrollerRef = useRef<HTMLDivElement>(null);
+  const mergedRef = useMergeRefs([forwardedRef, scrollerRef]);
+  const { setViewport, setPinned, setOverflow } = useScrollContainerContext(VIEWPORT_NAME);
 
+  // Register the scroll element with Root and set up wheel/scroll listeners.
   useEffect(() => {
-    if (!pinned || !contentRef.current) {
+    const el = scrollerRef.current;
+    if (!el) {
       return;
     }
 
-    // Scroll instantly otherwise it might move while we're scrolling.
-    scrollToBottom();
+    setViewport(el);
 
-    // Setup resize observer to detect content changes.
-    const resizeObserver = new ResizeObserver(() => scrollToBottom());
-    resizeObserver.observe(contentRef.current);
-    return () => resizeObserver.disconnect();
-  }, [pinned, scrollToBottom]);
+    return combine(
+      addEventListener(el, 'wheel', () => setPinned(isBottom(el))),
+      addEventListener(el, 'scroll', () => setOverflow((el.scrollTop ?? 0) > 0)),
+      () => setViewport(null),
+    );
+  }, [setViewport, setPinned, setOverflow]);
 
   return (
-    <div className={mx('is-full', classNames)} {...props} ref={contentRef}>
-      {children}
-    </div>
+    <>
+      <ScrollArea.Viewport {...composableProps(props)} ref={mergedRef}>
+        {children}
+      </ScrollArea.Viewport>
+      <PinEffect scrollerRef={scrollerRef} />
+    </>
   );
 });
 
-Viewport.displayName = 'ScrollContainer.Viewport';
+Viewport.displayName = VIEWPORT_NAME;
+
+/**
+ * Isolated component that consumes pinned/controller from context.
+ * Kept separate so that Viewport does not re-render when pinned changes.
+ */
+const PIN_EFFECT_NAME = 'ScrollContainer.PinEffect';
+
+const PinEffect = ({ scrollerRef }: { scrollerRef: RefObject<HTMLDivElement | null> }) => {
+  const { pinned, controller } = useScrollContainerContext(PIN_EFFECT_NAME);
+
+  // Pin scroll to bottom when content changes.
+  useEffect(() => {
+    const viewport = scrollerRef.current;
+    if (!pinned || !viewport) {
+      return;
+    }
+
+    // Scroll instantly so we don't visually jump while content is being added.
+    controller?.scrollToBottom('instant');
+
+    // Setup resize observer on content children to detect size changes (e.g. streaming).
+    // We observe children rather than the viewport itself, because the viewport's size
+    // stays fixed — only its content grows.
+    // Use instant scroll in the callback — smooth scrolling adds/removes the
+    // scrollbar-none class, which changes the element size and re-fires the
+    // observer, creating an infinite loop.
+    const resizeObserver = new ResizeObserver(() => controller?.scrollToBottom('smooth'));
+    Array.from(viewport.children).forEach((child) => {
+      resizeObserver.observe(child);
+    });
+
+    // Watch for added/removed children.
+    const mutationObserver = new MutationObserver((mutations) => {
+      mutations.forEach((mutation) => {
+        mutation.addedNodes.forEach((node) => {
+          if (node instanceof Element) {
+            resizeObserver.observe(node);
+          }
+        });
+      });
+
+      controller?.scrollToBottom('smooth');
+    });
+    mutationObserver.observe(viewport, { childList: true });
+
+    return () => {
+      resizeObserver.disconnect();
+      mutationObserver.disconnect();
+    };
+  }, [pinned, controller, scrollerRef]);
+
+  return null;
+};
+
+//
+// Fade
+//
+
+const FADE_NAME = 'ScrollContainer.Fade';
+
+type FadeProps = {};
+
+const Fade = () => {
+  const { overflow } = useScrollContainerContext(FADE_NAME);
+
+  return (
+    <div
+      role='none'
+      data-visible={overflow}
+      className={mx(
+        // NOTE: Gradients may not be visible with dark reader extensions.
+        'z-10 absolute top-0 inset-x-0 h-24 w-full',
+        'opacity-0 duration-200 transition-opacity data-[visible="true"]:opacity-100',
+        'bg-gradient-to-b from-(--surface-bg) to-transparent pointer-events-none',
+      )}
+    />
+  );
+};
+
+Fade.displayName = FADE_NAME;
 
 //
 // ScrollDownButton
 //
 
+const SCROLL_DOWN_BUTTON_NAME = 'ScrollContainer.ScrollDownButton';
+
 type ScrollDownButtonProps = ThemedClassName;
 
 const ScrollDownButton = ({ classNames }: ScrollDownButtonProps) => {
-  const { pinned, scrollToBottom } = useScrollContainerContext(ScrollDownButton.displayName!);
+  const { pinned, controller } = useScrollContainerContext(SCROLL_DOWN_BUTTON_NAME);
 
   return (
     <div
@@ -206,13 +291,13 @@ const ScrollDownButton = ({ classNames }: ScrollDownButtonProps) => {
         iconOnly
         size={4}
         label='Scroll down'
-        onClick={() => scrollToBottom()}
+        onClick={() => controller?.scrollToBottom()}
       />
     </div>
   );
 };
 
-ScrollDownButton.displayName = 'ScrollContainer.ScrollDownButton';
+ScrollDownButton.displayName = SCROLL_DOWN_BUTTON_NAME;
 
 //
 // ScrollContainer
@@ -223,11 +308,13 @@ export { useScrollContainerContext };
 export const ScrollContainer = {
   Root,
   Viewport,
+  Fade,
   ScrollDownButton,
 };
 
 export type {
   RootProps as ScrollContainerRootProps,
   ViewportProps as ScrollContainerViewportProps,
+  FadeProps as ScrollContainerFadeProps,
   ScrollDownButtonProps as ScrollContainerScrollDownButtonProps,
 };

package/src/components/Select/Select.stories.tsx

@@ -16,9 +16,9 @@ faker.seed(1234);
 
 type ItemProps = { id: string; text: string };
 
-type StoryProps = { items: ItemProps[] };
+type DefaultStoryProps = { items: ItemProps[] };
 
-const DefaultStory = ({ items = [] }: StoryProps) => {
+const DefaultStory = ({ items = [] }: DefaultStoryProps) => {
   const [value, setValue] = useState<string>();
   return (
     <Select.Root value={value} onValueChange={setValue}>
@@ -42,9 +42,9 @@ const DefaultStory = ({ items = [] }: StoryProps) => {
 };
 
 const meta = {
-  title: 'ui/react-ui-core/Select',
+  title: 'ui/react-ui-core/components/Select',
   render: DefaultStory,
-  decorators: [withTheme, withLayoutVariants()],
+  decorators: [withTheme(), withLayoutVariants()],
 } satisfies Meta<typeof DefaultStory>;
 
 export default meta;

package/src/components/Select/Select.tsx

@@ -39,7 +39,7 @@ const SelectTriggerButton = forwardRef<HTMLButtonElement, SelectTriggerButtonPro
       <SelectPrimitive.Trigger asChild ref={forwardedRef}>
         <Button {...props}>
           <SelectPrimitive.Value placeholder={placeholder}>{children}</SelectPrimitive.Value>
-          <span className='is-1 flex-1' />
+          <span className='w-1 flex-1' />
           <SelectPrimitive.Icon asChild>
             <Icon size={3} icon='ph--caret-down--bold' />
           </SelectPrimitive.Icon>
@@ -61,7 +61,7 @@ const SelectContent = forwardRef<HTMLDivElement, SelectContentProps>(
         {...props}
         data-arrow-keys='up down'
         collisionPadding={safeCollisionPadding}
-        className={tx('select.content', 'select__content', { elevation }, classNames)}
+        className={tx('select.content', { elevation }, classNames)}
         position='popper'
         ref={forwardedRef}
       >
@@ -79,7 +79,7 @@ const SelectScrollUpButton = forwardRef<HTMLDivElement, SelectScrollUpButtonProp
     return (
       <SelectPrimitive.SelectScrollUpButton
         {...props}
-        className={tx('select.scrollButton', 'select__scroll-button--up', {}, classNames)}
+        className={tx('select.scrollButton', {}, classNames)}
         ref={forwardedRef}
       >
         {children ?? <Icon size={3} icon='ph--caret-up--bold' />}
@@ -96,7 +96,7 @@ const SelectScrollDownButton = forwardRef<HTMLDivElement, SelectScrollDownButton
     return (
       <SelectPrimitive.SelectScrollDownButton
         {...props}
-        className={tx('select.scrollButton', 'select__scroll-button--down', {}, classNames)}
+        className={tx('select.scrollButton', {}, classNames)}
         ref={forwardedRef}
       >
         {children ?? <Icon size={3} icon='ph--caret-down--bold' />}
@@ -111,11 +111,7 @@ const SelectViewport = forwardRef<HTMLDivElement, SelectViewportProps>(
   ({ classNames, children, ...props }, forwardedRef) => {
     const { tx } = useThemeContext();
     return (
-      <SelectPrimitive.SelectViewport
-        {...props}
-        className={tx('select.viewport', 'select__viewport', {}, classNames)}
-        ref={forwardedRef}
-      >
+      <SelectPrimitive.SelectViewport {...props} className={tx('select.viewport', {}, classNames)} ref={forwardedRef}>
         {children}
       </SelectPrimitive.SelectViewport>
     );
@@ -126,7 +122,7 @@ type SelectItemProps = ThemedClassName<SelectPrimitive.SelectItemProps>;
 
 const SelectItem = forwardRef<HTMLDivElement, SelectItemProps>(({ classNames, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
-  return <SelectPrimitive.Item {...props} className={tx('select.item', 'option', {}, classNames)} ref={forwardedRef} />;
+  return <SelectPrimitive.Item {...props} className={tx('select.item', {}, classNames)} ref={forwardedRef} />;
 });
 
 type SelectItemTextProps = SelectPrimitive.SelectItemTextProps;
@@ -141,7 +137,7 @@ const SelectItemIndicator = forwardRef<HTMLDivElement, SelectItemIndicatorProps>
     return (
       <SelectPrimitive.ItemIndicator
         {...props}
-        className={tx('select.itemIndicator', 'option__indicator', {}, classNames)}
+        className={tx('select.itemIndicator', {}, classNames)}
         ref={forwardedRef}
       >
         {children}
@@ -156,9 +152,9 @@ type SelectOptionProps = SelectItemProps;
 const SelectOption = forwardRef<HTMLDivElement, SelectItemProps>(({ children, classNames, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
   return (
-    <SelectPrimitive.Item {...props} className={tx('select.item', 'option', {}, classNames)} ref={forwardedRef}>
+    <SelectPrimitive.Item {...props} className={tx('select.item', {}, classNames)} ref={forwardedRef}>
       <SelectPrimitive.ItemText>{children}</SelectPrimitive.ItemText>
-      <span className='grow is-1' />
+      <span className='grow w-1' />
       {/* <SelectPrimitive.ItemIndicator className={tx('select.itemIndicator', 'option__indicator', {})}> */}
       <Icon icon='ph--check--regular' />
       {/* </SelectPrimitive.ItemIndicator> */}
@@ -178,26 +174,14 @@ type SelectSeparatorProps = ThemedClassName<SelectPrimitive.SelectSeparatorProps
 
 const SelectSeparator = forwardRef<HTMLDivElement, SelectSeparatorProps>(({ classNames, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
-  return (
-    <SelectPrimitive.Separator
-      {...props}
-      className={tx('select.separator', 'select__separator', {}, classNames)}
-      ref={forwardedRef}
-    />
-  );
+  return <SelectPrimitive.Separator {...props} className={tx('select.separator', {}, classNames)} ref={forwardedRef} />;
 });
 
 type SelectArrowProps = ThemedClassName<SelectPrimitive.SelectArrowProps>;
 
 const SelectArrow = forwardRef<SVGSVGElement, SelectArrowProps>(({ classNames, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
-  return (
-    <SelectPrimitive.Arrow
-      {...props}
-      className={tx('select.arrow', 'select__arrow', {}, classNames)}
-      ref={forwardedRef}
-    />
-  );
+  return <SelectPrimitive.Arrow {...props} className={tx('select.arrow', {}, classNames)} ref={forwardedRef} />;
 });
 
 export const Select = {

package/src/components/Separator/Separator.tsx

@@ -1,25 +1,22 @@
 //
 // Copyright 2023 DXOS.org
 //
-import {
-  Separator as SeparatorPrimitive,
-  type SeparatorProps as SeparatorPrimitiveProps,
-} from '@radix-ui/react-separator';
+import * as SeparatorPrimitive from '@radix-ui/react-separator';
 import React, { forwardRef } from 'react';
 
 import { useThemeContext } from '../../hooks';
 import { type ThemedClassName } from '../../util';
 
-type SeparatorProps = ThemedClassName<SeparatorPrimitiveProps> & { subdued?: boolean };
+type SeparatorProps = ThemedClassName<SeparatorPrimitive.SeparatorProps> & { subdued?: boolean };
 
 const Separator = forwardRef<HTMLDivElement, SeparatorProps>(
   ({ classNames, orientation = 'horizontal', subdued, ...props }, forwardedRef) => {
     const { tx } = useThemeContext();
     return (
-      <SeparatorPrimitive
-        orientation={orientation}
+      <SeparatorPrimitive.Root
         {...props}
-        className={tx('separator.root', 'separator', { orientation, subdued }, classNames)}
+        orientation={orientation}
+        className={tx('separator.root', { orientation, subdued }, classNames)}
         ref={forwardedRef}
       />
     );

package/src/components/Skeleton/Skeleton.stories.tsx

@@ -0,0 +1,52 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { withTheme } from '../../testing';
+
+import { Skeleton } from './Skeleton';
+
+export default {
+  title: 'ui/react-ui-core/components/Skeleton',
+  component: Skeleton,
+  decorators: [withTheme()],
+  parameters: {
+    layout: 'centered',
+  },
+};
+
+export const Default = {
+  render: () => (
+    <div className='flex flex-col gap-4 p-4 border border-separator rounded-xs'>
+      <div className='flex w-fit items-center gap-4'>
+        <Skeleton classNames='size-10 shrink-0 rounded-full' />
+        <div className='grid gap-2'>
+          <Skeleton classNames='h-4 w-[150px]' />
+          <Skeleton classNames='h-4 w-[100px]' />
+        </div>
+      </div>
+    </div>
+  ),
+};
+
+export const Card = {
+  render: () => (
+    <div className='flex flex-col gap-3 w-96 p-4 border border-separator rounded-xs'>
+      <div className='flex items-center gap-3'>
+        <Skeleton variant='circle' classNames='h-12 w-12 rounded-full' />
+        <div className='flex flex-col gap-2 flex-1'>
+          <Skeleton classNames='h-4 w-24' />
+          <Skeleton classNames='h-3 w-32' />
+        </div>
+      </div>
+      <Skeleton classNames='h-32 w-full rounded-sm' />
+      <div className='flex flex-col gap-2'>
+        <Skeleton classNames='h-3 w-full' />
+        <Skeleton classNames='h-3 w-5/6' />
+        <Skeleton classNames='h-3 w-4/6' />
+      </div>
+    </div>
+  ),
+};

package/src/components/Skeleton/Skeleton.tsx

@@ -0,0 +1,26 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { type ComponentPropsWithRef, forwardRef } from 'react';
+
+import { useThemeContext } from '../../hooks';
+import { type ThemedClassName } from '../../util';
+
+type SkeletonProps = ThemedClassName<ComponentPropsWithRef<'div'>> & {
+  variant?: 'default' | 'circle' | 'text';
+};
+
+/**
+ * A skeleton loading component that displays a placeholder while content is loading.
+ */
+const Skeleton = forwardRef<HTMLDivElement, SkeletonProps>(
+  ({ classNames, variant = 'default', ...props }, forwardedRef) => {
+    const { tx } = useThemeContext();
+    return <div {...props} className={tx('skeleton.root', { variant }, classNames)} ref={forwardedRef} />;
+  },
+);
+
+export { Skeleton };
+
+export type { SkeletonProps };

package/src/components/Skeleton/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './Skeleton';