@dxos/react-ui-gameboard 0.8.3 → 0.8.4-main.28f8d3d

package/src/components/Gameboard/Gameboard.tsx

@@ -0,0 +1,139 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { monitorForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
+import { createContext } from '@radix-ui/react-context';
+import React, { type PropsWithChildren, forwardRef, useCallback, useEffect, useState } from 'react';
+
+import { log } from '@dxos/log';
+import { type ThemedClassName } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+import { Piece, type PieceProps } from './Piece';
+import { Square, type SquareProps } from './Square';
+import { type GameboardModel, type Move, type PieceRecord, isLocation, isPiece } from './types';
+
+export type GameboardContextValue<M extends GameboardModel> = {
+  model: M;
+  dragging?: boolean; // TODO(burdon): Change to PieceRecord.
+  promoting?: PieceRecord;
+  onPromotion: (move: Move) => void;
+};
+
+const [GameboardContextProvider, useRadixGameboardContext] = createContext<GameboardContextValue<any>>('Gameboard');
+
+const useGameboardContext = <M extends GameboardModel>(consumerName: string): GameboardContextValue<M> => {
+  return useRadixGameboardContext(consumerName);
+};
+
+//
+// Root
+//
+
+type GameboardRootProps<M extends GameboardModel> = PropsWithChildren<{
+  model?: M;
+  onDrop?: (move: Move) => boolean;
+}>;
+
+/**
+ * Generic board container.
+ */
+const GameboardRoot = <M extends GameboardModel>({ children, model, onDrop }: GameboardRootProps<M>) => {
+  const [dragging, setDragging] = useState(false);
+  const [promoting, setPromoting] = useState<PieceRecord | undefined>();
+
+  const handlePromotion = useCallback<GameboardContextValue<M>['onPromotion']>((move) => {
+    log('onPromotion', { move });
+    setPromoting(undefined);
+    onDrop?.(move);
+  }, []);
+
+  useEffect(() => {
+    if (!model) {
+      return;
+    }
+
+    // TODO(burdon): Should target specific container.
+    return monitorForElements({
+      onDragStart: ({ source }) => {
+        log('onDragStart', { source });
+        setDragging(true);
+      },
+      onDrop: ({ source, location }) => {
+        log('onDrop', { source, location });
+        const target = location.current.dropTargets[0];
+        if (!target) {
+          return;
+        }
+
+        const targetLocation = target.data.location;
+        const piece = source.data.piece;
+        if (!isLocation(targetLocation) || !isPiece(piece)) {
+          return;
+        }
+
+        const move: Move = { from: piece.location, to: targetLocation, piece: piece.type };
+        if (model.isValidMove(move)) {
+          if (model.canPromote?.(move)) {
+            setPromoting({ ...piece, location: targetLocation });
+          } else {
+            onDrop?.(move);
+          }
+        }
+
+        setDragging(false);
+      },
+    });
+  }, [model]);
+
+  return (
+    <GameboardContextProvider model={model} dragging={dragging} promoting={promoting} onPromotion={handlePromotion}>
+      {children}
+    </GameboardContextProvider>
+  );
+};
+
+GameboardRoot.displayName = 'Gameboard.Root';
+
+//
+// Content
+//
+
+type GameboardContentProps = ThemedClassName<PropsWithChildren<{ grow?: boolean; contain?: boolean }>>;
+
+const GameboardContent = forwardRef<HTMLDivElement, GameboardContentProps>(
+  ({ children, classNames, grow, contain }, forwardedRef) => {
+    return (
+      <div
+        role='none'
+        className={mx(grow && 'grid is-full bs-full size-container place-content-center', classNames)}
+        ref={forwardedRef}
+      >
+        {contain ? <div className='is-[min(100cqw,100cqh)] bs-[min(100cqw,100cqh)]'>{children}</div> : children}
+      </div>
+    );
+  },
+);
+
+GameboardContent.displayName = 'Gameboard.Content';
+
+//
+// Gameboard
+//
+
+export const Gameboard = {
+  Root: GameboardRoot,
+  Content: GameboardContent,
+  Piece,
+  Square,
+};
+
+export { useGameboardContext };
+
+export type {
+  GameboardRootProps,
+  GameboardContentProps,
+  PieceProps as GameboardPieceProps,
+  SquareProps as GameboardSquareProps,
+};

package/src/{Board → components/Gameboard}/Piece.tsx

@@ -3,34 +3,32 @@
 //
 
 import { draggable } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
-// import { preserveOffsetOnSource } from '@atlaskit/pragmatic-drag-and-drop/element/preserve-offset-on-source';
 import { centerUnderPointer } from '@atlaskit/pragmatic-drag-and-drop/element/center-under-pointer';
 import { setCustomNativeDragPreview } from '@atlaskit/pragmatic-drag-and-drop/element/set-custom-native-drag-preview';
-import React, { useState, useRef, useEffect, type FC, type SVGProps, memo } from 'react';
+import React, { type FC, type SVGProps, memo, useEffect, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
 
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { useDynamicRef, useTrackProps, type ThemedClassName } from '@dxos/react-ui';
+import { type ThemedClassName, useDynamicRef, useTrackProps } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
 
-import { useBoardContext } from './context';
-import { isEqualLocation, isLocation, type Location, type PieceRecord, type Player } from './types';
+import { useGameboardContext } from './Gameboard';
+import { type Location, type PieceRecord, type Player, isEqualLocation, isLocation } from './types';
 import { type DOMRectBounds } from './util';
 
 export type PieceProps = ThemedClassName<{
+  Component: FC<SVGProps<SVGSVGElement>>;
   piece: PieceRecord;
   bounds: DOMRectBounds;
   label?: string;
   orientation?: Player;
-  Component: FC<SVGProps<SVGSVGElement>>;
+  onClick?: () => void;
 }>;
 
-export const Piece = memo(({ classNames, piece, orientation, bounds, label, Component }: PieceProps) => {
-  useTrackProps({ classNames, piece, orientation, bounds, label, Component }, Piece.displayName, false);
-  const { model } = useBoardContext();
-
-  const { dragging: isDragging, promoting } = useBoardContext();
+export const Piece = memo(({ classNames, Component, piece, orientation, bounds, label, onClick }: PieceProps) => {
+  useTrackProps({ classNames, Component, piece, orientation, bounds, label }, Piece.displayName, false);
+  const { model, dragging: isDragging, promoting } = useGameboardContext(Piece.displayName!);
   const promotingRef = useDynamicRef(promoting);
   const [dragging, setDragging] = useState(false);
   const [preview, setPreview] = useState<HTMLElement>();
@@ -46,14 +44,10 @@ export const Piece = memo(({ classNames, piece, orientation, bounds, label, Comp
     return draggable({
       element: el,
       getInitialData: () => ({ piece }),
-      onGenerateDragPreview: ({ nativeSetDragImage, location, source }) => {
+      onGenerateDragPreview: ({ nativeSetDragImage, source }) => {
         log('onGenerateDragPreview', { source: source.data });
         setCustomNativeDragPreview({
           getOffset: centerUnderPointer,
-          // getOffset: preserveOffsetOnSource({
-          //   element: source.element,
-          //   input: location.current.input,
-          // }),
           render: ({ container }) => {
             setPreview(container);
             const { width, height } = el.getBoundingClientRect();
@@ -69,9 +63,14 @@ export const Piece = memo(({ classNames, piece, orientation, bounds, label, Comp
       canDrag: () => !promotingRef.current && model?.turn === piece.side,
       onDragStart: () => setDragging(true),
       onDrop: ({ location: { current } }) => {
-        const location = current.dropTargets[0].data.location;
-        if (isLocation(location)) {
-          setCurrent((current) => ({ ...current, location }));
+        // TODO(burdon): Create wrapper function to catch errors.
+        try {
+          const location = current.dropTargets[0]?.data.location;
+          if (isLocation(location)) {
+            setCurrent((current) => ({ ...current, location }));
+          }
+        } catch {
+          // Ignore.
         }
 
         setDragging(false);
@@ -112,10 +111,10 @@ export const Piece = memo(({ classNames, piece, orientation, bounds, label, Comp
         className={mx(
           'absolute',
           classNames,
-          // orientation === 'black' && '_rotate-180',
           dragging && 'opacity-20', // Must not unmount component while dragging.
           isDragging && 'pointer-events-none', // Don't block the square's drop target.
         )}
+        onClick={onClick}
       >
         <Component className='grow' />
         {label && <div className='absolute inset-1 text-xs text-black'>{label}</div>}

package/src/{Board → components/Gameboard}/Square.tsx

@@ -3,15 +3,15 @@
 //
 
 import { dropTargetForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
-import React, { useRef, useState, useEffect, memo } from 'react';
+import React, { memo, useEffect, useRef, useState } from 'react';
 
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { type ThemedClassName } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
 
-import { useBoardContext } from './context';
-import { isPiece, type Location } from './types';
+import { useGameboardContext } from './Gameboard';
+import { type Location, isPiece } from './types';
 import { type DOMRectBounds } from './util';
 
 type HoveredState = 'idle' | 'validMove' | 'invalidMove';
@@ -25,7 +25,7 @@ export type SquareProps = ThemedClassName<{
 export const Square = memo(({ location, bounds, label, classNames }: SquareProps) => {
   const ref = useRef<HTMLDivElement>(null);
   const [state, setState] = useState<HoveredState>('idle');
-  const { model } = useBoardContext();
+  const { model } = useGameboardContext(Square.displayName!);
 
   useEffect(() => {
     const el = ref.current;

package/src/components/Gameboard/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './types';
+export * from './util';
+
+export * from './Gameboard';

package/src/{Board → components/Gameboard}/types.ts

@@ -4,6 +4,7 @@
 
 import { type ReadonlySignal } from '@preact/signals-core';
 
+// TODO(burdon): Don't make this assumption.
 export type Player = 'black' | 'white';
 
 export type Location = [number, number];
@@ -50,8 +51,9 @@ export const isEqualLocation = (l1: Location, l2: Location): boolean => l1[0] ==
 /**
  * Generic board model.
  */
-export interface BoardModel<T extends PieceType = PieceType> {
+export interface GameboardModel<T extends PieceType = PieceType> {
   turn: Player;
+  /** @reactive */
   pieces: ReadonlySignal<PieceMap<T>>;
   isValidMove: (move: Move) => boolean;
   canPromote?: (move: Move) => boolean;

package/src/components/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './Gameboard';
+export * from './Chessboard';

package/src/index.ts

@@ -2,5 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './Board';
-export * from './Chessboard';
+export * from './components';