@dxos/react-ui 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

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

@@ -1,49 +1,236 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
-import '@dxos-theme';
+import React, { PropsWithChildren, useMemo } from 'react';
 
-import React, { type PropsWithChildren } from 'react';
+import { random } from '@dxos/random';
+import { mx } from '@dxos/ui-theme';
+import { ThemedClassName } from '@dxos/ui-types';
 
-import { faker } from '@dxos/random';
-import { activeSurface, surfaceShadow } from '@dxos/react-ui-theme';
+import { withLayout, withTheme } from '../../testing';
+import { Column } from '../Column';
+import { Input } from '../Input';
+import { ScrollArea } from './ScrollArea';
 
-import { withTheme } from '../../testing';
+random.seed(123);
 
-import { ScrollArea } from './ScrollArea';
+export default {
+  title: 'ui/react-ui-core/components/ScrollArea',
+  component: ScrollArea,
+  decorators: [withTheme()],
+  parameters: {
+    layout: 'centered',
+  },
+};
+
+const List = ({ items = 50 }: { items?: number }) => (
+  <div>
+    {Array.from({ length: items }).map((_, index) => (
+      <div key={index} className='px-1 cursor-pointer hover:bg-hover-surface'>
+        Item {index + 1}
+      </div>
+    ))}
+  </div>
+);
+
+const Row = ({ items = 50 }: { items?: number }) => (
+  <div className='flex gap-2 w-max'>
+    {Array.from({ length: items }).map((_, index) => (
+      <div
+        key={index}
+        className='shrink-0 h-20 w-20 cursor-pointer border border-separator rounded-md flex items-center justify-center hover:bg-hover-surface'
+      >
+        {index + 1}
+      </div>
+    ))}
+  </div>
+);
+
+const Container = ({ classNames, children }: ThemedClassName<PropsWithChildren>) => {
+  return <div className={mx('border border-separator rounded-md overflow-hidden', classNames)}>{children}</div>;
+};
+
+export const Vertical = {
+  render: () => (
+    <Container classNames='h-72 w-48'>
+      <ScrollArea.Root orientation='vertical'>
+        <ScrollArea.Viewport>
+          <List />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </Container>
+  ),
+};
+
+export const VerticalThin = {
+  render: () => (
+    <Container classNames='h-72 w-48'>
+      <ScrollArea.Root orientation='vertical' thin>
+        <ScrollArea.Viewport>
+          <List />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </Container>
+  ),
+};
 
-faker.seed(1234);
+export const VerticalPadded = {
+  render: () => (
+    <Container classNames='h-72 w-48'>
+      <ScrollArea.Root orientation='vertical' centered padding thin>
+        <ScrollArea.Viewport>
+          <List />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </Container>
+  ),
+};
+
+export const VerticalColumn = {
+  render: () => (
+    <Container classNames='h-72 w-48'>
+      <Column.Root gutter='sm' classNames='h-full overflow-hidden'>
+        <ScrollArea.Root orientation='vertical' padding thin>
+          <ScrollArea.Viewport classNames='py-2'>
+            <Input.Root>
+              <Input.TextInput classNames='p-1' />
+            </Input.Root>
+            <List />
+          </ScrollArea.Viewport>
+        </ScrollArea.Root>
+      </Column.Root>
+    </Container>
+  ),
+};
+
+export const Horizontal = {
+  render: () => (
+    <Container classNames='w-96'>
+      <ScrollArea.Root orientation='horizontal'>
+        <ScrollArea.Viewport>
+          <Row />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </Container>
+  ),
+};
+
+export const HorizontalThin = {
+  render: () => (
+    <Container classNames='w-96'>
+      <ScrollArea.Root orientation='horizontal' thin>
+        <ScrollArea.Viewport>
+          <Row />
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    </Container>
+  ),
+};
 
-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>
+export const Both = {
+  render: () => (
+    <Container classNames='w-96 h-96'>
+      <ScrollArea.Root orientation='all'>
+        <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>
+    </Container>
+  ),
+};
+
+export const Fullscreen = {
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  render: () => (
+    <ScrollArea.Root orientation='all' thin>
+      <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.Scrollbar orientation='horizontal'>
-        <ScrollArea.Thumb />
-      </ScrollArea.Scrollbar>
-      <ScrollArea.Scrollbar orientation='vertical'>
-        <ScrollArea.Thumb />
-      </ScrollArea.Scrollbar>
-      <ScrollArea.Corner />
     </ScrollArea.Root>
-  );
+  ),
 };
 
-export default {
-  title: 'ui/react-ui-core/Scroll area',
-  component: ScrollArea,
-  render: DefaultStory,
-  decorators: [withTheme],
-  parameters: { chromatic: { disableSnapshot: false } },
-};
+export const NestedScrollAreas = {
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  render: () => {
+    const columns = useMemo(
+      () =>
+        Array.from({ length: 8 }).map((_, index) => ({
+          id: String(index),
+          count: random.number.int({ min: 5, max: 20 }),
+        })),
+      [],
+    );
 
-export const Default = {
-  args: {
-    children: faker.lorem.paragraphs(5),
+    return (
+      <ScrollArea.Root orientation='horizontal' thin padding>
+        <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',
+        )}
+      >
+        <List />
+      </div>
+    </div>
+  ),
+};

package/src/components/ScrollArea/ScrollArea.theme.ts

@@ -0,0 +1,107 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { mx } from '@dxos/ui-theme';
+import { type AllowedAxis, type ComponentFunction, type Theme } from '@dxos/ui-types';
+
+import { withColumn } from '../Column/withColumn';
+
+export type ScrollAreaStyleProps = {
+  orientation?: AllowedAxis;
+  autoHide?: boolean;
+  /** Balance left/right, top/bottom offset with scrollbar. */
+  centered?: boolean;
+  /** Add default padding. */
+  /** TODO(burdon): Integrate with Column.Root padding. */
+  padding?: boolean;
+  /** Use thin scrollbars. */
+  /** TODO(burdon): Density fine/course. */
+  thin?: boolean;
+  /** Enable snap scrolling. */
+  snap?: boolean;
+};
+
+const root: ComponentFunction<ScrollAreaStyleProps> = ({ orientation }, ...etc) =>
+  mx(
+    // Expand
+    'dx-container',
+
+    orientation === 'vertical' && 'group/scroll-v flex flex-col',
+    orientation === 'horizontal' && 'group/scroll-h flex',
+    // `flex flex-col` is required (as in `vertical`) so the viewport's `flex-1 min-h-0` can
+    // bound its height; without it the viewport grows to content height and only scrolls
+    // horizontally (the root clips the vertical overflow instead of scrolling it).
+    orientation === 'all' && 'group/scroll-all flex flex-col',
+
+    // Apply col-span-full only when inside a Column.Root grid (detected via dx-column-root marker).
+    '[.dx-column-root_&]:col-span-full',
+
+    ...etc,
+  );
+
+/**
+ * NOTE: The browser reserves space for scrollbars.
+ */
+const viewport: ComponentFunction<ScrollAreaStyleProps> = (
+  { orientation, centered, padding, snap, autoHide },
+  ...etc
+) => {
+  return mx(
+    'flex-1 min-h-0 w-full',
+
+    // Reset --dx-col so nested components don't try to grid-position themselves.
+    // ScrollArea has already consumed --gutter for padding.
+    withColumn.consumed(),
+
+    orientation === 'vertical' && 'overflow-y-scroll',
+    orientation === 'horizontal' && 'flex overflow-x-scroll overscroll-x-contain',
+    orientation === 'all' && 'overflow-scroll',
+
+    '[&::-webkit-scrollbar-corner]:bg-transparent',
+    '[&::-webkit-scrollbar-track]:bg-transparent',
+    '[&::-webkit-scrollbar-thumb]:rounded-none',
+
+    '[&::-webkit-scrollbar]:w-[var(--scroll-width)] [&::-webkit-scrollbar]:h-[var(--scroll-width)]',
+
+    // If contained within Column.Root grid the gutter is set by that component (--gutter CSS variable).
+    // If centered, left padding compensates for scrollbar width so content is visually centered.
+    (orientation === 'vertical' || orientation === 'all') &&
+      (padding
+        ? [
+            centered ? 'pl-[var(--gutter,calc(var(--scroll-width)+var(--scroll-padding)))]' : 'pl-[var(--gutter,0)]',
+            'pr-[calc(var(--gutter,calc(var(--scroll-width)+var(--scroll-padding)))-var(--scroll-width))]',
+          ]
+        : centered && 'pl-[var(--scroll-width)]'),
+
+    (orientation === 'horizontal' || orientation === 'all') &&
+      (padding
+        ? [centered && 'pt-[calc(var(--scroll-width)+var(--scroll-padding))]', 'pb-[var(--scroll-padding)]']
+        : centered && 'pt-[var(--scroll-width)]'),
+
+    snap && [
+      orientation === 'vertical' && 'snap-y snap-mandatory',
+      orientation === 'horizontal' && 'snap-x snap-mandatory',
+      orientation === 'all' && 'snap-both snap-mandatory',
+    ],
+
+    autoHide
+      ? [
+          orientation === 'vertical' && 'group-hover/scroll-v:[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+          orientation === 'horizontal' && 'group-hover/scroll-h:[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+          orientation === 'all' && 'group-hover/scroll-all:[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+        ]
+      : [
+          orientation === 'vertical' && '[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+          orientation === 'horizontal' && '[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+          orientation === 'all' && '[&::-webkit-scrollbar-thumb]:bg-scrollbar-thumb',
+        ],
+
+    ...etc,
+  );
+};
+
+export const scrollAreaTheme: Theme<ScrollAreaStyleProps> = {
+  root,
+  viewport,
+};

package/src/components/ScrollArea/ScrollArea.tsx

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

package/src/components/ScrollArea/scrollbar.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+/**
+ * Scrollbar sizing presets keyed by density tier.
+ */
+export const scrollbar = {
+  sm: {
+    size: 2,
+    padding: 2,
+  },
+  md: {
+    size: 4,
+    padding: 4,
+  },
+  lg: {
+    size: 8,
+    padding: 8,
+  },
+};