@dxos/react-ui 0.8.4-main.c1de068 → 0.8.4-main.c351d160a8

package/src/components/ScrollArea/ScrollArea.stories.tsx

@@ -1,48 +1,177 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
-import '@dxos-theme';
-
-import React, { type PropsWithChildren } from 'react';
+import React, { useMemo } from 'react';
 
 import { faker } from '@dxos/random';
-import { activeSurface, surfaceShadow } from '@dxos/react-ui-theme';
+import { mx } from '@dxos/ui-theme';
+
+import { withLayout, withTheme } from '../../testing';
 
 import { ScrollArea } from './ScrollArea';
-import { withTheme } from '../../testing';
-
-faker.seed(1234);
-
-const DefaultStory = ({ children }: PropsWithChildren<{}>) => {
-  return (
-    <ScrollArea.Root
-      classNames={['is-[300px] bs-[400px] rounded', activeSurface, surfaceShadow({ elevation: 'positioned' })]}
-    >
-      <ScrollArea.Viewport classNames='rounded p-4'>
-        <p>{children}</p>
-      </ScrollArea.Viewport>
-      <ScrollArea.Scrollbar orientation='horizontal'>
-        <ScrollArea.Thumb />
-      </ScrollArea.Scrollbar>
-      <ScrollArea.Scrollbar orientation='vertical'>
-        <ScrollArea.Thumb />
-      </ScrollArea.Scrollbar>
-      <ScrollArea.Corner />
-    </ScrollArea.Root>
-  );
-};
+
+faker.seed(123);
 
 export default {
-  title: 'ui/react-ui-core/Scroll area',
+  title: 'ui/react-ui-core/components/ScrollArea',
   component: ScrollArea,
-  render: DefaultStory,
-  decorators: [withTheme],
-  parameters: { chromatic: { disableSnapshot: false } },
+  decorators: [withTheme()],
+  parameters: {
+    layout: 'centered',
+  },
+};
+
+const Column = () => (
+  <div>
+    {Array.from({ length: 50 }).map((_, index) => (
+      <div key={index} className='px-1 text-sm cursor-pointer hover:bg-hover-surface'>
+        Item {index + 1}
+      </div>
+    ))}
+  </div>
+);
+
+const Row = () => (
+  <div className='flex gap-2 w-max'>
+    {Array.from({ length: 50 }).map((_, index) => (
+      <div
+        key={index}
+        className='shrink-0 h-20 w-20 cursor-pointer border border-separator rounded-md flex items-center justify-center text-sm hover:bg-hover-surface'
+      >
+        {index + 1}
+      </div>
+    ))}
+  </div>
+);
+
+export const Vertical = {
+  render: () => (
+    <div className='h-72 w-48 p-2 border border-separator rounded-md'>
+      <ScrollArea.Root orientation='vertical' padding>
+        <ScrollArea.Viewport>
+          <Column />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </div>
+  ),
+};
+
+export const VerticalThin = {
+  render: () => (
+    <div className='h-72 w-48 p-2 border border-separator rounded-md'>
+      <ScrollArea.Root orientation='vertical' padding thin>
+        <ScrollArea.Viewport>
+          <Column />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </div>
+  ),
+};
+
+export const Horizontal = {
+  render: () => (
+    <div className='w-96 p-2 border border-separator rounded-md'>
+      <ScrollArea.Root orientation='horizontal' padding>
+        <ScrollArea.Viewport>
+          <Row />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </div>
+  ),
+};
+
+export const HorizontalThin = {
+  render: () => (
+    <div className='w-96 p-2 border border-separator rounded-md'>
+      <ScrollArea.Root orientation='horizontal' padding thin>
+        <ScrollArea.Viewport>
+          <Row />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </div>
+  ),
 };
 
-export const Default = {
-  args: {
-    children: faker.lorem.paragraphs(5),
+export const Both = {
+  render: () => (
+    <div className='h-96 w-96 p-2 border border-separator rounded-md'>
+      <ScrollArea.Root orientation='all' padding>
+        <ScrollArea.Viewport>
+          <div className='flex flex-col gap-2'>
+            {Array.from({ length: 50 }).map((_, rowIndex) => (
+              <div key={rowIndex} className='flex gap-2'>
+                {Array.from({ length: 50 }).map((_, colIndex) => (
+                  <div
+                    key={colIndex}
+                    className='shrink-0 h-20 w-20 flex items-center justify-center text-sm border border-separator font-mono'
+                  >
+                    [{colIndex}:{rowIndex}]
+                  </div>
+                ))}
+              </div>
+            ))}
+          </div>
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </div>
+  ),
+};
+
+export const NestedScrollAreas = {
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  render: () => {
+    const columns = useMemo(
+      () =>
+        Array.from({ length: 8 }).map((_, index) => ({
+          id: String(index),
+          count: faker.number.int({ min: 5, max: 20 }),
+        })),
+      [],
+    );
+
+    return (
+      <ScrollArea.Root thin orientation='horizontal'>
+        <ScrollArea.Viewport classNames='gap-4'>
+          {columns.map((column) => (
+            <section
+              key={column.id}
+              className='shrink-0 h-full w-[16rem] grid grid-rows-[min-content_1fr_min-content] border border-separator'
+            >
+              <header className='flex shrink-0 p-2 border-b border-separator'>Column {column.id}</header>
+              <ScrollArea.Root thin orientation='vertical'>
+                <ScrollArea.Viewport classNames='py-2 px-2 gap-2'>
+                  {Array.from({ length: column.count }, (_, i) => (
+                    <div key={i} role='listitem' className={`shrink-0 p-2 text-sm border border-separator rounded-xs`}>
+                      Item {i + 1}
+                    </div>
+                  ))}
+                </ScrollArea.Viewport>
+              </ScrollArea.Root>
+              <footer className={`p-2 text-subdued border-t border-separator`}>{column.count}</footer>
+            </section>
+          ))}
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    );
   },
 };
+
+export const NativeScroll = {
+  render: () => (
+    <div className='group h-48 w-48 border border-separator'>
+      <div
+        className={mx(
+          'group h-full w-full overflow-y-scroll',
+          '[&::-webkit-scrollbar]:w-3',
+          '[&::-webkit-scrollbar-thumb]:rounded-none',
+          '[&::-webkit-scrollbar-track]:bg-scrollbar-track',
+          '[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumbSubdued',
+          'group-hover:[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+        )}
+      >
+        <Column />
+      </div>
+    </div>
+  ),
+};

package/src/components/ScrollArea/ScrollArea.tsx

@@ -1,111 +1,113 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
-import {
-  Root as ScrollAreaPrimitiveRoot,
-  type ScrollAreaProps as ScrollAreaPrimitiveRootProps,
-  Viewport as ScrollAreaPrimitiveViewport,
-  type ScrollAreaViewportProps as ScrollAreaPrimitiveViewportProps,
-  Scrollbar as ScrollAreaPrimitiveScrollbar,
-  type ScrollAreaScrollbarProps as ScrollAreaPrimitiveScrollbarProps,
-  Thumb as ScrollAreaPrimitiveThumb,
-  type ScrollAreaThumbProps as ScrollAreaPrimitiveThumbProps,
-  Corner as ScrollAreaPrimitiveCorner,
-  type ScrollAreaCornerProps as ScrollAreaPrimitiveCornerProps,
-} from '@radix-ui/react-scroll-area';
-import React, { forwardRef } from 'react';
+import { createContext } from '@radix-ui/react-context';
+import { Primitive } from '@radix-ui/react-primitive';
+import { Slot } from '@radix-ui/react-slot';
+import React, { type HTMLAttributes, forwardRef } from 'react';
+
+import { composableProps } from '@dxos/ui-theme';
+import { type AllowedAxis, type SlottableProps, type ThemedClassName } from '@dxos/ui-types';
 
 import { useThemeContext } from '../../hooks';
-import { type ThemedClassName } from '../../util';
 
-type ScrollAreaVariant = 'coarse' | 'fine';
+//
+// Context
+//
 
-type ScrollAreaRootProps = ThemedClassName<ScrollAreaPrimitiveRootProps>;
+const SCROLLAREA_NAME = 'ScrollArea';
+
+type ScrollAreaContextType = {
+  /** Orientation of scrollbars. */
+  orientation: AllowedAxis;
+  /** Hide scrollbars when not scrolling. */
+  autoHide: boolean;
+  /** Apply padding to opposite side of scrollbar. */
+  margin?: boolean;
+  /** Apply padding. */
+  padding: boolean;
+  /** Use thin scrollbars. */
+  thin: boolean;
+  /** Enable snap scrolling. */
+  snap: boolean;
+};
+
+const [ScrollAreaProvider, useScrollAreaContext] = createContext<ScrollAreaContextType>(SCROLLAREA_NAME);
+
+//
+// Root
+//
+
+const SCROLLAREA_ROOT_NAME = 'ScrollArea.Root';
+
+type ScrollAreaRootProps = SlottableProps<HTMLDivElement, Partial<ScrollAreaContextType>>;
 
 /**
- * @deprecated
+ * ScrollArea provides native scrollbars with custom styling.
  */
-const ScrollAreaRoot = forwardRef<HTMLDivElement, ScrollAreaRootProps>(({ classNames, ...props }, forwardedRef) => {
-  const { tx } = useThemeContext();
-  return (
-    <ScrollAreaPrimitiveRoot
-      {...props}
-      className={tx('scrollArea.root', 'scroll-area', {}, classNames)}
-      ref={forwardedRef}
-    />
-  );
-});
-
-type ScrollAreaViewportProps = ThemedClassName<ScrollAreaPrimitiveViewportProps>;
-
-const ScrollAreaViewport = forwardRef<HTMLDivElement, ScrollAreaViewportProps>(
-  ({ classNames, ...props }, forwardedRef) => {
+const ScrollAreaRoot = forwardRef<HTMLDivElement, ScrollAreaRootProps>(
+  (
+    {
+      children,
+      asChild,
+      orientation = 'vertical',
+      autoHide = true,
+      margin = false,
+      padding = false,
+      thin = false,
+      snap = false,
+      ...props
+    },
+    forwardedRef,
+  ) => {
+    const { className, ...rest } = composableProps(props);
+    const Comp = asChild ? Slot : Primitive.div;
     const { tx } = useThemeContext();
+    const options = { orientation, autoHide, margin, padding, thin, snap };
+
     return (
-      <ScrollAreaPrimitiveViewport
-        {...props}
-        className={tx('scrollArea.viewport', 'scroll-area', {}, classNames)}
-        ref={forwardedRef}
-      />
+      <ScrollAreaProvider {...options}>
+        <Comp {...rest} className={tx('scrollArea.root', options, className)} ref={forwardedRef}>
+          {children}
+        </Comp>
+      </ScrollAreaProvider>
     );
   },
 );
 
-type ScrollAreaScrollbarProps = ThemedClassName<ScrollAreaPrimitiveScrollbarProps> & { variant?: ScrollAreaVariant };
+ScrollAreaRoot.displayName = SCROLLAREA_ROOT_NAME;
+
+//
+// Viewport
+//
+
+const SCROLLAREA_VIEWPORT_NAME = 'ScrollArea.Viewport';
+
+type ScrollAreaViewportProps = ThemedClassName<HTMLAttributes<HTMLDivElement>>;
 
-const ScrollAreaScrollbar = forwardRef<HTMLDivElement, ScrollAreaScrollbarProps>(
-  ({ classNames, variant = 'fine', ...props }, forwardedRef) => {
+const ScrollAreaViewport = forwardRef<HTMLDivElement, ScrollAreaViewportProps>(
+  ({ classNames, children, ...props }, forwardedRef) => {
     const { tx } = useThemeContext();
+    const options = useScrollAreaContext(SCROLLAREA_VIEWPORT_NAME);
+
     return (
-      <ScrollAreaPrimitiveScrollbar
-        data-variant={variant}
-        {...props}
-        className={tx('scrollArea.scrollbar', 'scroll-area__scrollbar', {}, classNames)}
-        ref={forwardedRef}
-      />
+      <div {...props} className={tx('scrollArea.viewport', options, classNames)} ref={forwardedRef}>
+        {children}
+      </div>
     );
   },
 );
 
-type ScrollAreaThumbProps = ThemedClassName<ScrollAreaPrimitiveThumbProps>;
-
-const ScrollAreaThumb = forwardRef<HTMLDivElement, ScrollAreaThumbProps>(({ classNames, ...props }, forwardedRef) => {
-  const { tx } = useThemeContext();
-  return (
-    <ScrollAreaPrimitiveThumb
-      {...props}
-      className={tx('scrollArea.thumb', 'scroll-area__thumb', {}, classNames)}
-      ref={forwardedRef}
-    />
-  );
-});
-
-type ScrollAreaCornerProps = ThemedClassName<ScrollAreaPrimitiveCornerProps>;
-
-const ScrollAreaCorner = forwardRef<HTMLDivElement, ScrollAreaCornerProps>(({ classNames, ...props }, forwardedRef) => {
-  const { tx } = useThemeContext();
-  return (
-    <ScrollAreaPrimitiveCorner
-      {...props}
-      className={tx('scrollArea.corner', 'scroll-area__corner', {}, classNames)}
-      ref={forwardedRef}
-    />
-  );
-});
+ScrollAreaViewport.displayName = SCROLLAREA_VIEWPORT_NAME;
+
+//
+// ScrollArea
+//
 
 export const ScrollArea = {
   Root: ScrollAreaRoot,
   Viewport: ScrollAreaViewport,
-  Scrollbar: ScrollAreaScrollbar,
-  Thumb: ScrollAreaThumb,
-  Corner: ScrollAreaCorner,
 };
 
-export type {
-  ScrollAreaRootProps,
-  ScrollAreaViewportProps,
-  ScrollAreaScrollbarProps,
-  ScrollAreaThumbProps,
-  ScrollAreaCornerProps,
-};
+export type { ScrollAreaRootProps, ScrollAreaViewportProps };

package/src/components/ScrollArea/index.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
 export * from './ScrollArea';

package/src/components/ScrollContainer/ScrollContainer.stories.tsx

@@ -0,0 +1,89 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useEffect, useRef, useState } from 'react';
+
+import { faker } from '@dxos/random';
+
+import { Panel } from '../../primitives';
+import { withLayout, withTheme } from '../../testing';
+import { Button } from '../Button';
+import { Toolbar } from '../Toolbar';
+
+import { ScrollContainer, type ScrollContainerRootProps, type ScrollController } from './ScrollContainer';
+
+type StoryProps = ScrollContainerRootProps & { running?: boolean; initialLines?: number };
+
+const DefaultStory = ({ initialLines = 0, running: runningProp, ...props }: StoryProps) => {
+  const [lines, setLines] = useState<string[]>([]);
+  const [running, setRunning] = useState(runningProp);
+  const scroller = useRef<ScrollController>(null);
+  useEffect(() => {
+    setLines(Array.from({ length: initialLines }, () => faker.lorem.paragraph()));
+  }, [initialLines]);
+  useEffect(() => {
+    if (!running) {
+      return;
+    }
+
+    const i = setInterval(() => {
+      setLines((lines) => [...lines, faker.lorem.paragraph()]);
+    }, 500);
+
+    return () => clearInterval(i);
+  }, [running]);
+
+  return (
+    <Panel.Root className='dx-document'>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root>
+          <Button onClick={() => setRunning((running) => !running)}>{running ? 'Stop' : 'Start'}</Button>
+          <Button onClick={() => scroller.current?.scrollToBottom()}>Scroll to bottom</Button>
+          <Toolbar.Separator />
+          <div className='px-1'>{lines.length}</div>
+        </Toolbar.Root>
+      </Panel.Toolbar>
+      <Panel.Content asChild>
+        <ScrollContainer.Root {...props} ref={scroller}>
+          <ScrollContainer.Viewport>
+            {lines.map((line, index) => (
+              <div key={index} className='p-2 text-description'>
+                {line}
+              </div>
+            ))}
+          </ScrollContainer.Viewport>
+          <ScrollContainer.ScrollDownButton />
+        </ScrollContainer.Root>
+      </Panel.Content>
+    </Panel.Root>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-core/components/ScrollContainer',
+  component: ScrollContainer.Root,
+  render: DefaultStory,
+  decorators: [withTheme(), withLayout({ layout: 'column', classNames: 'w-[30rem]' })],
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    pin: true,
+    fade: true,
+    running: true,
+  },
+};
+
+export const Large: Story = {
+  args: {
+    pin: true,
+    fade: true,
+    initialLines: 100,
+  },
+};