@dxos/react-ui-stack 0.8.2-main.fbd8ed0 → 0.8.2-staging.42af850

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-stack",
-  "version": "0.8.2-main.fbd8ed0",
+  "version": "0.8.2-staging.42af850",
   "description": "A stack component.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -40,6 +40,7 @@
     "@atlaskit/pragmatic-drag-and-drop-auto-scroll": "^2.1.0",
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.3",
     "@fluentui/react-tabster": "^9.24.2",
+    "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/primitive": "1.1.1",
     "@radix-ui/react-compose-refs": "1.1.1",
     "@radix-ui/react-context": "1.1.1",
@@ -47,12 +48,12 @@
     "@radix-ui/react-slot": "1.1.2",
     "@radix-ui/react-use-controllable-state": "1.1.0",
     "react-resize-detector": "^11.0.1",
-    "@dxos/keyboard": "0.8.2-main.fbd8ed0",
-    "@dxos/live-object": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui-attention": "0.8.2-main.fbd8ed0",
-    "@dxos/echo-schema": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui-dnd": "0.8.2-main.fbd8ed0",
-    "@dxos/util": "0.8.2-main.fbd8ed0"
+    "@dxos/echo-schema": "0.8.2-staging.42af850",
+    "@dxos/live-object": "0.8.2-staging.42af850",
+    "@dxos/keyboard": "0.8.2-staging.42af850",
+    "@dxos/react-ui-attention": "0.8.2-staging.42af850",
+    "@dxos/react-ui-dnd": "0.8.2-staging.42af850",
+    "@dxos/util": "0.8.2-staging.42af850"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
@@ -61,24 +62,24 @@
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
     "vite": "5.4.7",
-    "@dxos/app-graph": "0.8.2-main.fbd8ed0",
-    "@dxos/echo-schema": "0.8.2-main.fbd8ed0",
-    "@dxos/client": "0.8.2-main.fbd8ed0",
-    "@dxos/random": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui-editor": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui-theme": "0.8.2-main.fbd8ed0",
-    "@dxos/storybook-utils": "0.8.2-main.fbd8ed0",
-    "@dxos/test-utils": "0.8.2-main.fbd8ed0"
+    "@dxos/app-graph": "0.8.2-staging.42af850",
+    "@dxos/client": "0.8.2-staging.42af850",
+    "@dxos/random": "0.8.2-staging.42af850",
+    "@dxos/react-ui": "0.8.2-staging.42af850",
+    "@dxos/react-ui-theme": "0.8.2-staging.42af850",
+    "@dxos/storybook-utils": "0.8.2-staging.42af850",
+    "@dxos/react-ui-editor": "0.8.2-staging.42af850",
+    "@dxos/echo-schema": "0.8.2-staging.42af850",
+    "@dxos/test-utils": "0.8.2-staging.42af850"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.1.5",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/random": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui": "0.8.2-main.fbd8ed0",
-    "@dxos/client": "0.8.2-main.fbd8ed0",
-    "@dxos/react-ui-theme": "0.8.2-main.fbd8ed0"
+    "@dxos/client": "0.8.2-staging.42af850",
+    "@dxos/random": "0.8.2-staging.42af850",
+    "@dxos/react-ui": "0.8.2-staging.42af850",
+    "@dxos/react-ui-theme": "0.8.2-staging.42af850"
   },
   "publishConfig": {
     "access": "public"

package/src/components/Stack/Stack.stories.tsx

@@ -97,14 +97,24 @@ const DefaultStory = () => {
   return (
     <main className='fixed inset-0'>
       <Stack orientation='horizontal' size='contain' onRearrange={reorderItem}>
-        {columns.map((column) => (
-          <StackItem.Root key={column.id} item={column}>
+        {columns.map((column, columnIndex, columnsArray) => (
+          <StackItem.Root
+            key={column.id}
+            item={column}
+            prevSiblingId={columnIndex > 0 ? columnsArray[columnIndex - 1].id : undefined}
+            nextSiblingId={columnIndex < columnsArray.length - 1 ? columnsArray[columnIndex + 1].id : undefined}
+          >
             <StackItem.Heading>
               <StackItem.ResizeHandle />
             </StackItem.Heading>
             <Stack orientation='vertical' size='contain'>
-              {column.items?.map((card) => (
-                <StackItem.Root key={card.id} item={card}>
+              {column.items?.map((card, cardIndex, cardsArray) => (
+                <StackItem.Root
+                  key={card.id}
+                  item={card}
+                  prevSiblingId={cardIndex > 0 ? cardsArray[cardIndex - 1].id : undefined}
+                  nextSiblingId={cardIndex < cardsArray.length - 1 ? cardsArray[cardIndex + 1].id : undefined}
+                >
                   <StackItem.Heading>
                     <StackItem.ResizeHandle />
                   </StackItem.Heading>

package/src/components/Stack/Stack.tsx

@@ -4,7 +4,15 @@
 
 import { useArrowNavigationGroup } from '@fluentui/react-tabster';
 import { composeRefs } from '@radix-ui/react-compose-refs';
-import React, { Children, type CSSProperties, type ComponentPropsWithRef, forwardRef, useState, useMemo } from 'react';
+import React, {
+  Children,
+  type CSSProperties,
+  type ComponentPropsWithRef,
+  forwardRef,
+  useState,
+  useMemo,
+  useCallback,
+} from 'react';
 
 import { type ThemedClassName, ListItem } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
@@ -17,7 +25,11 @@ export type Orientation = 'horizontal' | 'vertical';
 export type Size = 'intrinsic' | 'contain' | 'contain-fit-content';
 
 export type StackProps = Omit<ThemedClassName<ComponentPropsWithRef<'div'>>, 'aria-orientation'> &
-  Partial<StackContextValue> & { itemsCount?: number };
+  Partial<StackContextValue> & {
+    itemsCount?: number;
+    getDropElement?: (stackElement: HTMLDivElement) => HTMLDivElement;
+    separatorOnScroll?: number;
+  };
 
 export const railGridHorizontal = 'grid-rows-[[rail-start]_var(--rail-size)_[content-start]_1fr_[content-end]]';
 export const railGridVertical = 'grid-cols-[[rail-start]_var(--rail-size)_[content-start]_1fr_[content-end]]';
@@ -41,6 +53,8 @@ export const Stack = forwardRef<HTMLDivElement, StackProps>(
       size = 'intrinsic',
       onRearrange,
       itemsCount = Children.count(children),
+      getDropElement,
+      separatorOnScroll,
       ...props
     },
     forwardedRef,
@@ -59,12 +73,28 @@ export const Stack = forwardRef<HTMLDivElement, StackProps>(
 
     const { dropping } = useStackDropForElements({
       id: props.id,
-      element: stackElement,
+      element: getDropElement && stackElement ? getDropElement(stackElement) : stackElement,
       selfDroppable,
       orientation,
       onRearrange,
     });
 
+    const handleScroll = useCallback(() => {
+      if (stackElement && Number.isFinite(separatorOnScroll)) {
+        const scrollPosition = orientation === 'horizontal' ? stackElement.scrollLeft : stackElement.scrollTop;
+        const scrollSize = orientation === 'horizontal' ? stackElement.scrollWidth : stackElement.scrollHeight;
+        const clientSize = orientation === 'horizontal' ? stackElement.clientWidth : stackElement.clientHeight;
+        const separatorHost = stackElement.closest('[data-scroll-separator]');
+        if (separatorHost) {
+          separatorHost.setAttribute('data-scroll-separator', String(scrollPosition > separatorOnScroll!));
+          separatorHost.setAttribute(
+            'data-scroll-separator-end',
+            String(scrollSize - (scrollPosition + clientSize) > separatorOnScroll!),
+          );
+        }
+      }
+    }, [stackElement, separatorOnScroll, orientation]);
+
     const gridClasses = useMemo(() => {
       if (!rail) {
         return orientation === 'horizontal' ? 'grid-rows-1 pli-1' : 'grid-cols-1 plb-1';
@@ -94,6 +124,7 @@ export const Stack = forwardRef<HTMLDivElement, StackProps>(
           aria-orientation={orientation}
           style={styles}
           ref={composedItemRef}
+          {...(Number.isFinite(separatorOnScroll) && { onScroll: handleScroll })}
         >
           {children}
           {selfDroppable && dropping && (

package/src/components/StackContext.tsx

@@ -22,16 +22,36 @@ export const StackContext = createContext<StackContextValue>({
 
 export const useStack = () => useContext(StackContext);
 
+export type ItemDragState =
+  | {
+      type: 'idle';
+    }
+  | {
+      type: 'preview';
+      container: HTMLElement;
+      item: any;
+    }
+  | {
+      type: 'is-dragging';
+      item: any;
+    };
+
+export const idle: ItemDragState = { type: 'idle' };
+
 export type StackItemContextValue = {
   selfDragHandleRef: (element: HTMLDivElement | null) => void;
   size: StackItemSize;
   setSize: (nextSize: StackItemSize, commit?: boolean) => void;
+  state: ItemDragState;
+  setState: (state: ItemDragState) => void;
 };
 
 export const StackItemContext = createContext<StackItemContextValue>({
   selfDragHandleRef: () => {},
   size: 'min-content',
   setSize: () => {},
+  state: idle,
+  setState: () => {},
 });
 
 export const useStackItem = () => useContext(StackItemContext);

package/src/components/StackItem/StackItem.tsx

@@ -5,7 +5,7 @@
 import { combine } from '@atlaskit/pragmatic-drag-and-drop/combine';
 import { draggable, dropTargetForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
 import { preserveOffsetOnSource } from '@atlaskit/pragmatic-drag-and-drop/element/preserve-offset-on-source';
-import { scrollJustEnoughIntoView } from '@atlaskit/pragmatic-drag-and-drop/element/scroll-just-enough-into-view';
+import { setCustomNativeDragPreview } from '@atlaskit/pragmatic-drag-and-drop/element/set-custom-native-drag-preview';
 import {
   attachClosestEdge,
   extractClosestEdge,
@@ -13,7 +13,15 @@ import {
 } from '@atlaskit/pragmatic-drag-and-drop-hitbox/closest-edge';
 import { useFocusableGroup } from '@fluentui/react-tabster';
 import { composeRefs } from '@radix-ui/react-compose-refs';
-import React, { forwardRef, useLayoutEffect, useState, type ComponentPropsWithRef, useCallback } from 'react';
+import React, {
+  forwardRef,
+  useLayoutEffect,
+  useState,
+  type ComponentPropsWithRef,
+  useCallback,
+  type ReactNode,
+} from 'react';
+import { createPortal } from 'react-dom';
 
 import { type ThemedClassName, ListItem } from '@dxos/react-ui';
 import { resizeAttributes, sizeStyle } from '@dxos/react-ui-dnd';
@@ -35,7 +43,7 @@ import {
   type StackItemSigilButtonProps,
   StackItemSigilButton,
 } from './StackItemSigil';
-import { useStack, StackItemContext } from '../StackContext';
+import { useStack, StackItemContext, idle, type ItemDragState, useStackItem } from '../StackContext';
 import { type StackItemSize, type StackItemData } from '../defs';
 
 // NOTE: 48rem fills the screen on a MacbookPro with the sidebars closed.
@@ -46,6 +54,8 @@ export const DEFAULT_EXTRINSIC_SIZE = DEFAULT_HORIZONTAL_SIZE satisfies StackIte
 type StackItemRootProps = ThemedClassName<ComponentPropsWithRef<'div'>> & {
   item: Omit<StackItemData, 'type'>;
   order?: number;
+  prevSiblingId?: string;
+  nextSiblingId?: string;
   size?: StackItemSize;
   onSizeChange?: (nextSize: StackItemSize) => void;
   role?: 'article' | 'section';
@@ -63,6 +73,8 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
       onSizeChange,
       role,
       order,
+      prevSiblingId,
+      nextSiblingId,
       style,
       disableRearrange,
       focusIndicatorVariant = 'over-all',
@@ -73,6 +85,8 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
     const [itemElement, itemRef] = useState<HTMLDivElement | null>(null);
     const [selfDragHandleElement, selfDragHandleRef] = useState<HTMLDivElement | null>(null);
     const [closestEdge, setEdge] = useState<Edge | null>(null);
+    const [sourceId, setSourceId] = useState<string | null>(null);
+    const [dragState, setDragState] = useState<ItemDragState>(idle);
     const { orientation, rail, onRearrange } = useStack();
     const [size = orientation === 'horizontal' ? DEFAULT_HORIZONTAL_SIZE : DEFAULT_VERTICAL_SIZE, setInternalSize] =
       useState(propsSize);
@@ -105,18 +119,28 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
           getInitialData: () => ({ id: item.id, type }),
           onGenerateDragPreview: ({ nativeSetDragImage, source, location }) => {
             document.body.setAttribute('data-drag-preview', 'true');
-            scrollJustEnoughIntoView({ element: source.element });
-            const { x, y } = preserveOffsetOnSource({ element: source.element, input: location.current.input })({
-              container: (source.element.offsetParent ?? document.body) as HTMLElement,
+            const offsetFn = preserveOffsetOnSource({ element: source.element, input: location.current.input });
+            const rect = source.element.getBoundingClientRect();
+            setCustomNativeDragPreview({
+              nativeSetDragImage,
+              getOffset: ({ container }) => {
+                return offsetFn({ container });
+              },
+              render: ({ container }) => {
+                container.style.width = rect.width + 'px';
+                setDragState({ type: 'preview', container, item });
+                return () => {};
+              },
             });
-            nativeSetDragImage?.(source.element, x, y);
           },
           onDragStart: () => {
             document.body.removeAttribute('data-drag-preview');
             itemElement?.closest('[data-drag-autoscroll]')?.setAttribute('data-drag-autoscroll', 'active');
+            setDragState({ type: 'is-dragging', item });
           },
           onDrop: () => {
             itemElement?.closest('[data-drag-autoscroll]')?.setAttribute('data-drag-autoscroll', 'idle');
+            setDragState(idle);
           },
         }),
         dropTargetForElements({
@@ -130,16 +154,22 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
           onDragEnter: ({ self, source }) => {
             if (source.data.type === self.data.type) {
               setEdge(extractClosestEdge(self.data));
+              setSourceId(source.data.id as string);
             }
           },
           onDrag: ({ self, source }) => {
             if (source.data.type === self.data.type) {
               setEdge(extractClosestEdge(self.data));
+              setSourceId(source.data.id as string);
             }
           },
-          onDragLeave: () => setEdge(null),
+          onDragLeave: () => {
+            setEdge(null);
+            setSourceId(null);
+          },
           onDrop: ({ self, source }) => {
             setEdge(null);
+            setSourceId(null);
             if (source.data.type === self.data.type) {
               onRearrange(source.data as StackItemData, self.data as StackItemData, extractClosestEdge(self.data));
             }
@@ -150,8 +180,42 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
 
     const focusableGroupAttrs = useFocusableGroup({ tabBehavior: 'limited' });
 
+    // Determine if the drop would result in any changes
+    const shouldShowDropIndicator = () => {
+      if (!closestEdge || !sourceId) {
+        return false;
+      }
+
+      // Don't show indicator when dragged item is over itself
+      if (sourceId === item.id) {
+        return false;
+      }
+
+      // Don't show indicator when dragged item is over the trailing edge of its previous sibling
+      const isTrailingEdgeOfPrevSibling =
+        prevSiblingId !== undefined &&
+        sourceId === prevSiblingId &&
+        ((orientation === 'horizontal' && closestEdge === 'left') ||
+          (orientation === 'vertical' && closestEdge === 'top'));
+      if (isTrailingEdgeOfPrevSibling) {
+        return false;
+      }
+
+      // Don't show indicator when dragged item is over the leading edge of its next sibling
+      const isLeadingEdgeOfNextSibling =
+        nextSiblingId !== undefined &&
+        sourceId === nextSiblingId &&
+        ((orientation === 'horizontal' && closestEdge === 'right') ||
+          (orientation === 'vertical' && closestEdge === 'bottom'));
+      if (isLeadingEdgeOfNextSibling) {
+        return false;
+      }
+
+      return true;
+    };
+
     return (
-      <StackItemContext.Provider value={{ selfDragHandleRef, size, setSize }}>
+      <StackItemContext.Provider value={{ selfDragHandleRef, size, setSize, state: dragState, setState: setDragState }}>
         <Root
           {...props}
           tabIndex={0}
@@ -179,13 +243,24 @@ const StackItemRoot = forwardRef<HTMLDivElement, StackItemRootProps>(
           ref={composedItemRef}
         >
           {children}
-          {closestEdge && <ListItem.DropIndicator lineInset={8} terminalInset={-8} edge={closestEdge} />}
+          {shouldShowDropIndicator() && closestEdge && (
+            <ListItem.DropIndicator lineInset={8} terminalInset={-8} edge={closestEdge} />
+          )}
         </Root>
       </StackItemContext.Provider>
     );
   },
 );
 
+type StackItemDragPreviewProps = {
+  children: ({ item }: { item: any }) => ReactNode;
+};
+
+export const StackItemDragPreview = ({ children }: StackItemDragPreviewProps) => {
+  const { state } = useStackItem();
+  return state?.type === 'preview' ? createPortal(children({ item: state.item }), state.container) : null;
+};
+
 export const StackItem = {
   Root: StackItemRoot,
   Content: StackItemContent,
@@ -195,6 +270,7 @@ export const StackItem = {
   DragHandle: StackItemDragHandle,
   Sigil: StackItemSigil,
   SigilButton: StackItemSigilButton,
+  DragPreview: StackItemDragPreview,
 };
 
 export type {
@@ -207,4 +283,5 @@ export type {
   StackItemSigilProps,
   StackItemSigilButtonProps,
   StackItemSigilAction,
+  StackItemDragPreviewProps,
 };

package/src/components/StackItem/StackItemHeading.tsx

@@ -24,8 +24,9 @@ export const StackItemHeading = ({ children, classNames, ...props }: StackItemHe
       tabIndex={0}
       {...focusableGroupAttrs}
       className={mx(
-        'flex items-center dx-focus-ring-inset-over-all relative !border-is-0 bg-headerSurface',
+        'flex items-center dx-focus-ring-inset-over-all relative !border-is-0 bg-headerSurface border-transparent [[data-scroll-separator="true"]_&]:border-subduedSeparator',
         orientation === 'horizontal' ? 'bs-[--rail-size]' : 'is-[--rail-size] flex-col',
+        orientation === 'horizontal' ? 'border-be' : 'border-ie',
         classNames,
       )}
     >

package/src/components/StackItem/StackItemSigil.tsx

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { Fragment, type PropsWithChildren, forwardRef, useRef, useState } from 'react';
+import React, { Fragment, type PropsWithChildren, forwardRef, useState } from 'react';
 
 import { type ActionLike } from '@dxos/app-graph';
 import { keySymbols } from '@dxos/keyboard';
@@ -62,7 +62,6 @@ export type StackItemSigilProps = PropsWithChildren<
 export const StackItemSigil = forwardRef<HTMLButtonElement, StackItemSigilProps>(
   ({ actions: actionGroups, onAction, triggerLabel, attendableId, icon, related, children }, forwardedRef) => {
     const { t } = useTranslation(translationKey);
-    const suppressNextTooltip = useRef(false);
 
     const [optionsMenuOpen, setOptionsMenuOpen] = useState(false);
 
@@ -87,17 +86,7 @@ export const StackItemSigil = forwardRef<HTMLButtonElement, StackItemSigilProps>
     }
 
     return (
-      <DropdownMenu.Root
-        {...{
-          open: optionsMenuOpen,
-          onOpenChange: (nextOpen: boolean) => {
-            if (!nextOpen) {
-              suppressNextTooltip.current = true;
-            }
-            return setOptionsMenuOpen(nextOpen);
-          },
-        }}
-      >
+      <DropdownMenu.Root open={optionsMenuOpen} onOpenChange={setOptionsMenuOpen}>
         <DropdownMenu.Trigger asChild ref={forwardedRef}>
           {button}
         </DropdownMenu.Trigger>
@@ -127,7 +116,6 @@ export const StackItemSigil = forwardRef<HTMLButtonElement, StackItemSigilProps>
                             }
                             event.stopPropagation();
                             // TODO(thure): Why does Dialog’s modal-ness cause issues if we don’t explicitly close the menu here?
-                            suppressNextTooltip.current = true;
                             setOptionsMenuOpen(false);
                             onAction?.(action);
                           }}

package/src/testing/stack-manager.ts

@@ -11,7 +11,7 @@ export class StackManager {
     this._page = locator.page();
   }
 
-  sections() {
+  sections(): Locator {
     return this.locator.locator('section');
   }
 
@@ -19,7 +19,7 @@ export class StackManager {
     return this.locator.locator('section').evaluateAll((els) => els.map((el) => el.getAttribute('id')));
   }
 
-  section(index: number) {
+  section(index: number): SectionManager {
     return new SectionManager(this.locator.locator('section').nth(index));
   }
 }
@@ -31,21 +31,21 @@ export class SectionManager {
     this._page = locator.page();
   }
 
-  async id() {
+  async id(): Promise<string | null> {
     return this.locator.getAttribute('id');
   }
 
-  async remove() {
+  async remove(): Promise<void> {
     await this.locator.getByTestId('section.drag-handle-menu-trigger').click();
     await this._page.getByTestId('section.remove').click();
   }
 
-  async navigateTo() {
+  async navigateTo(): Promise<void> {
     await this.locator.getByTestId('section.drag-handle-menu-trigger').click();
     await this._page.getByTestId('section.navigate-to').click();
   }
 
-  async dragTo(target: Locator, offset: { x: number; y: number } = { x: 0, y: 0 }) {
+  async dragTo(target: Locator, offset: { x: number; y: number } = { x: 0, y: 0 }): Promise<void> {
     const active = this.locator.getByTestId('section.drag-handle-menu-trigger');
     const box = await target.boundingBox();
     if (box) {