@dxos/react-ui 0.8.4-main.937b3ca → 0.8.4-main.9be5663bfe

package/src/components/ScrollArea/ScrollArea.tsx

@@ -1,138 +1,121 @@
 //
-// 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, { type PropsWithChildren, forwardRef } from 'react';
-
-import { mx } from '@dxos/ui-theme';
+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 { useThemeContext } from '../../hooks';
-import { type ThemedClassName } from '../../util';
+import { composableProps, scrollbar, slottable } from '@dxos/ui-theme';
+import { type AllowedAxis, type SlottableProps } from '@dxos/ui-types';
 
-type ScrollAreaVariant = 'coarse' | 'fine';
+import { useThemeContext } from '../../hooks';
 
 //
-// Root
+// Context
 //
 
-type ScrollAreaRootProps = ThemedClassName<ScrollAreaPrimitiveRootProps>;
+const SCROLLAREA_NAME = 'ScrollArea';
 
-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;
+};
+
+const [ScrollAreaProvider, useScrollAreaContext] = createContext<ScrollAreaContextType>(SCROLLAREA_NAME);
 
 //
-// Viewport
+// Root
 //
 
-type ScrollAreaViewportProps = ThemedClassName<ScrollAreaPrimitiveViewportProps>;
+const SCROLLAREA_ROOT_NAME = 'ScrollArea.Root';
 
-const ScrollAreaViewport = forwardRef<HTMLDivElement, ScrollAreaViewportProps>(
-  ({ classNames, ...props }, forwardedRef) => {
+type ScrollAreaRootProps = Partial<ScrollAreaContextType>;
+
+/**
+ * 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();
-    return (
-      <ScrollAreaPrimitiveViewport
-        {...props}
-        className={tx('scrollArea.viewport', 'scroll-area', {}, classNames)}
-        ref={forwardedRef}
-      />
+    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],
     );
-  },
-);
 
-//
-// Scrollbar
-//
-
-type ScrollAreaScrollbarProps = ThemedClassName<ScrollAreaPrimitiveScrollbarProps> & { variant?: ScrollAreaVariant };
-
-const ScrollAreaScrollbar = forwardRef<HTMLDivElement, ScrollAreaScrollbarProps>(
-  ({ classNames, variant = 'fine', ...props }, forwardedRef) => {
-    const { tx } = useThemeContext();
     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>
     );
   },
 );
 
-//
-// Thumb
-//
-
-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}
-    />
-  );
-});
+ScrollAreaRoot.displayName = SCROLLAREA_ROOT_NAME;
 
 //
-// Corner
+// Viewport
 //
 
-type ScrollAreaCornerProps = ThemedClassName<ScrollAreaPrimitiveCornerProps>;
+const SCROLLAREA_VIEWPORT_NAME = 'ScrollArea.Viewport';
+
+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.thin : scrollbar.coarse;
+  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>
   );
 });
 
-//
-// Expander
-//
-
-type ScrollAreaExpanderProps = ThemedClassName<PropsWithChildren>;
-
-/**
- * Size-locking wrapper required for inner ScrollArea to function correctly.
- * NOTE: Radix ScrollArea.Viewport applies `display: table` to its immediate child,
- * causing the content to participate in table layout and escape the intended fixed-size viewport.
- */
-const ScrollAreaExpander = ({ classNames, children }: ScrollAreaExpanderProps) => {
-  return (
-    <div role='none' className={mx('relative bs-full is-full overflow-hidden', classNames)}>
-      <div role='none' className='absolute inset-0 overflow-hidden'>
-        {children}
-      </div>
-    </div>
-  );
-};
+ScrollAreaViewport.displayName = SCROLLAREA_VIEWPORT_NAME;
 
 //
 // ScrollArea
@@ -141,17 +124,6 @@ const ScrollAreaExpander = ({ classNames, children }: ScrollAreaExpanderProps) =
 export const ScrollArea = {
   Root: ScrollAreaRoot,
   Viewport: ScrollAreaViewport,
-  Scrollbar: ScrollAreaScrollbar,
-  Thumb: ScrollAreaThumb,
-  Corner: ScrollAreaCorner,
-  Expander: ScrollAreaExpander,
 };
 
-export type {
-  ScrollAreaRootProps,
-  ScrollAreaViewportProps,
-  ScrollAreaScrollbarProps,
-  ScrollAreaThumbProps,
-  ScrollAreaCornerProps,
-  ScrollAreaExpanderProps,
-};
+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

@@ -5,57 +5,69 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useEffect, useRef, useState } from 'react';
 
-import { faker } from '@dxos/random';
+import { random } 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';
 
-const DefaultStory = (props: ScrollContainerRootProps) => {
+type DefaultStoryProps = ScrollContainerRootProps & { running?: boolean; initialLines?: number };
+
+const DefaultStory = ({ initialLines = 0, running: runningProp, ...props }: DefaultStoryProps) => {
   const [lines, setLines] = useState<string[]>([]);
-  const [running, setRunning] = useState(true);
+  const [running, setRunning] = useState(runningProp);
   const scroller = useRef<ScrollController>(null);
+  useEffect(() => {
+    setLines(Array.from({ length: initialLines }, () => random.lorem.paragraph()));
+  }, [initialLines]);
   useEffect(() => {
     if (!running) {
       return;
     }
 
     const i = setInterval(() => {
-      setLines((lines) => [...lines, faker.lorem.paragraph()]);
+      setLines((lines) => [...lines, random.lorem.paragraph()]);
     }, 500);
 
     return () => clearInterval(i);
   }, [running]);
 
   return (
-    <div className='flex flex-col bs-full overflow-hidden'>
-      <Toolbar.Root>
-        <Button onClick={() => setRunning((running) => !running)}>{running ? 'Stop' : 'Start'}</Button>
-        <Button onClick={() => scroller.current?.scrollToBottom()}>Scroll to bottom</Button>
-        <div className='flex-1' />
-        <div>{lines.length}</div>
-      </Toolbar.Root>
-      <ScrollContainer.Root {...props} ref={scroller}>
-        <ScrollContainer.Viewport>
-          {lines.map((line, index) => (
-            <div key={index} className='p-2'>
-              {line}
-            </div>
-          ))}
-        </ScrollContainer.Viewport>
-        <ScrollContainer.ScrollDownButton />
-      </ScrollContainer.Root>
-    </div>
+    <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>
+        <ScrollContainer.Root {...props} ref={scroller}>
+          <ScrollContainer.Content>
+            <ScrollContainer.Viewport>
+              {lines.map((line, index) => (
+                <div key={index} className='p-2 text-description'>
+                  {line}
+                </div>
+              ))}
+            </ScrollContainer.Viewport>
+            <ScrollContainer.ScrollDownButton />
+            <ScrollContainer.Fade />
+          </ScrollContainer.Content>
+        </ScrollContainer.Root>
+      </Panel.Content>
+    </Panel.Root>
   );
 };
 
 const meta = {
-  title: 'ui/react-ui-core/ScrollContainer',
+  title: 'ui/react-ui-core/components/ScrollContainer',
   component: ScrollContainer.Root,
   render: DefaultStory,
-  decorators: [withTheme, withLayout({ layout: 'column', classNames: 'is-[30rem]' })],
+  decorators: [withTheme(), withLayout({ layout: 'column', classNames: 'w-[30rem]' })],
 } satisfies Meta<typeof DefaultStory>;
 
 export default meta;
@@ -65,6 +77,15 @@ type Story = StoryObj<typeof meta>;
 export const Default: Story = {
   args: {
     pin: true,
-    fade: true,
+
+    running: true,
+  },
+};
+
+export const Large: Story = {
+  args: {
+    pin: true,
+
+    initialLines: 100,
   },
 };