@dxos/react-ui-grid 0.8.3 → 0.8.4-main.1da679c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-grid",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1da679c",
   "description": "React component which manages a `dx-grid` Lit web component.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,6 +10,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
     }
@@ -23,35 +24,35 @@
     "src"
   ],
   "dependencies": {
-    "@codemirror/autocomplete": "^6.18.1",
-    "@codemirror/state": "^6.4.1",
-    "@codemirror/view": "^6.34.1",
+    "@codemirror/autocomplete": "^6.18.7",
+    "@codemirror/state": "^6.5.2",
+    "@codemirror/view": "^6.38.2",
     "@lit/react": "^1.0.5",
     "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/react-context": "1.1.1",
     "@radix-ui/react-popper": "1.2.2",
     "@radix-ui/react-use-controllable-state": "1.1.0",
-    "@dxos/lit-grid": "0.8.3",
-    "@dxos/util": "0.8.3",
-    "@dxos/react-ui-editor": "0.8.3"
+    "@dxos/lit-grid": "0.8.4-main.1da679c",
+    "@dxos/util": "0.8.4-main.1da679c",
+    "@dxos/react-ui-editor": "0.8.4-main.1da679c"
   },
   "devDependencies": {
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/random": "0.8.3",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-searchlist": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3",
-    "@dxos/storybook-utils": "0.8.3"
+    "vite": "7.1.1",
+    "@dxos/random": "0.8.4-main.1da679c",
+    "@dxos/react-ui-searchlist": "0.8.4-main.1da679c",
+    "@dxos/react-ui-theme": "0.8.4-main.1da679c",
+    "@dxos/react-ui": "0.8.4-main.1da679c",
+    "@dxos/storybook-utils": "0.8.4-main.1da679c"
   },
   "peerDependencies": {
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3"
+    "@dxos/react-ui": "0.8.4-main.1da679c",
+    "@dxos/react-ui-theme": "0.8.4-main.1da679c"
   },
   "publishConfig": {
     "access": "public"

package/src/CellEditor/CellEditor.stories.tsx

@@ -0,0 +1,90 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import '@dxos-theme';
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useState } from 'react';
+
+import { withTheme } from '@dxos/storybook-utils';
+
+import { CellEditor, type CellEditorProps, type EditorKeyEvent, editorKeys } from './CellEditor';
+
+const DefaultStory = (props: CellEditorProps) => {
+  const [value, setValue] = useState(props.value || 'Edit me');
+  const [lastAction, setLastAction] = useState<string>('');
+
+  const handleBlur = (newValue?: string) => {
+    if (newValue !== undefined) {
+      setValue(newValue);
+      setLastAction(`Blur: ${newValue}`);
+    }
+  };
+
+  const handleKeyEvent = (newValue: string | undefined, event: EditorKeyEvent) => {
+    if (newValue !== undefined) {
+      setValue(newValue);
+      setLastAction(`Key: ${event.key}${event.shift ? ' + Shift' : ''}, Value: ${newValue}`);
+    } else {
+      setLastAction(`Key: ${event.key}${event.shift ? ' + Shift' : ''}, Cancelled`);
+    }
+  };
+
+  // Create an extension with editor keys
+  const extensions = props.extensions || [
+    editorKeys({
+      onClose: handleKeyEvent,
+      onNav: (value, event) => {
+        setLastAction(`Navigation: ${event.key}, Value: ${value}`);
+      },
+    }),
+  ];
+
+  return (
+    <div className='flex flex-col gap-4 p-4'>
+      <div className='text-sm'>
+        Current value: <span className='font-mono'>{value}</span>
+      </div>
+      <div className='text-sm'>
+        Last action: <span className='font-mono'>{lastAction}</span>
+      </div>
+      <div className='relative border border-separator h-[100px] w-[300px]'>
+        <CellEditor
+          value={value}
+          extensions={extensions}
+          autoFocus={props.autoFocus}
+          onBlur={handleBlur}
+          box={{
+            insetInlineStart: 10,
+            insetBlockStart: 10,
+            inlineSize: 280,
+            blockSize: 30,
+          }}
+          gridId='demo-grid'
+        />
+      </div>
+    </div>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-grid/CellEditor',
+  component: CellEditor,
+  render: DefaultStory,
+  decorators: [withTheme],
+  parameters: {
+    layout: 'centered',
+  },
+} satisfies Meta<typeof CellEditor>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    value: 'Edit me',
+    autoFocus: true,
+  },
+};

package/src/CellEditor/CellEditor.tsx

@@ -9,12 +9,14 @@ import React, { type KeyboardEvent } from 'react';
 
 import { useThemeContext } from '@dxos/react-ui';
 import {
+  type ThemeExtensionsOptions,
   type UseTextEditorProps,
   createBasicExtensions,
   createThemeExtensions,
   preventNewline,
   useTextEditor,
 } from '@dxos/react-ui-editor';
+import { mx } from '@dxos/react-ui-theme';
 
 import { type GridEditBox } from '../Grid';
 
@@ -114,12 +116,14 @@ export const editorKeys = ({ onNav, onClose }: EditorKeysProps): Extension => {
 
 export type CellEditorProps = {
   value?: string;
-  extension?: Extension;
+  extensions?: Extension;
   box?: GridEditBox;
   gridId?: string;
-} & Pick<UseTextEditorProps, 'autoFocus'> & { onBlur?: EditorBlurHandler };
+  onBlur?: EditorBlurHandler;
+} & Pick<UseTextEditorProps, 'autoFocus'> &
+  Pick<ThemeExtensionsOptions, 'slots'>;
 
-export const CellEditor = ({ value, extension, autoFocus, onBlur, box, gridId }: CellEditorProps) => {
+export const CellEditor = ({ value, extensions, box, gridId, onBlur, autoFocus, slots }: CellEditorProps) => {
   const { themeMode } = useThemeContext();
   const { parentRef } = useTextEditor(() => {
     return {
@@ -127,7 +131,7 @@ export const CellEditor = ({ value, extension, autoFocus, onBlur, box, gridId }:
       initialValue: value,
       selection: { anchor: value?.length ?? 0 },
       extensions: [
-        extension ?? [],
+        extensions ?? [],
         preventNewline,
         EditorView.focusChangeEffect.of((state, focusing) => {
           if (!focusing) {
@@ -135,30 +139,41 @@ export const CellEditor = ({ value, extension, autoFocus, onBlur, box, gridId }:
           }
           return null;
         }),
-        createBasicExtensions({ lineWrapping: false }),
+        createBasicExtensions({ lineWrapping: true }),
         createThemeExtensions({
           themeMode,
           slots: {
             editor: {
-              className: '[&>.cm-scroller]:scrollbar-none tabular-nums',
+              className: mx(
+                '!min-is-full !is-min !max-is-[--dx-grid-cell-editor-max-inline-size] !min-bs-full !max-bs-[--dx-grid-cell-editor-max-block-size]',
+                slots?.editor?.className,
+              ),
+            },
+            scroll: {
+              className: mx(
+                '!overflow-x-hidden !plb-[max(0,calc(var(--dx-grid-cell-editor-padding-block)-1px))] !pie-0 !pis-[--dx-grid-cell-editor-padding-inline]',
+                slots?.scroll?.className,
+              ),
             },
             content: {
-              className:
-                '!border !border-transparent !pli-[var(--dx-grid-cell-padding-inline)] !plb-[var(--dx-grid-cell-padding-block)]',
+              className: mx('!break-normal', slots?.content?.className),
             },
           },
         }),
       ],
     };
-  }, [extension, autoFocus, value, onBlur]);
+  }, [extensions, autoFocus, value, onBlur, themeMode, slots]);
 
   return (
     <div
       data-testid='grid.cell-editor'
       ref={parentRef}
-      className='absolute z-[1]'
+      className='absolute z-[1] dx-grid__cell-editor'
       style={{
-        ...box,
+        insetInlineStart: box?.insetInlineStart ?? '0px',
+        insetBlockStart: box?.insetBlockStart ?? '0px',
+        minInlineSize: box?.inlineSize ?? '180px',
+        minBlockSize: box?.blockSize ?? '30px',
         ...{ '--dx-gridCellWidth': `${box?.inlineSize ?? 200}px` },
       }}
       {...(gridId && { 'data-grid': gridId })}

package/src/CellEditor/GridCellEditor.tsx

@@ -4,15 +4,18 @@
 
 import React, { useCallback } from 'react';
 
+import { type DxGridCellIndex, type GridScopedProps, useGridContext } from '../Grid';
+
 import { CellEditor, type CellEditorProps } from './CellEditor';
-import { type GridScopedProps, useGridContext, type DxGridCellIndex } from '../Grid';
 
 export type GridCellEditorProps = GridScopedProps<
-  Pick<CellEditorProps, 'extension' | 'onBlur'> & { getCellContent: (index: DxGridCellIndex) => string | undefined }
+  Pick<CellEditorProps, 'extensions' | 'onBlur' | 'slots'> & {
+    getCellContent: (index: DxGridCellIndex) => string | undefined;
+  }
 >;
 
-export const GridCellEditor = ({ extension, getCellContent, onBlur, __gridScope }: GridCellEditorProps) => {
-  const { id, editing, setEditing, editBox } = useGridContext('GridSheetCellEditor', __gridScope);
+export const GridCellEditor = ({ extensions, getCellContent, onBlur, slots, __gridScope }: GridCellEditorProps) => {
+  const { id, editing, setEditing, editBox } = useGridContext('GridCellEditor', __gridScope);
 
   const handleBlur = useCallback(
     (value?: string) => {
@@ -28,8 +31,9 @@ export const GridCellEditor = ({ extension, getCellContent, onBlur, __gridScope
       autoFocus
       box={editBox}
       onBlur={handleBlur}
-      extension={extension}
+      extensions={extensions}
       gridId={id}
+      slots={slots}
     />
   ) : null;
 };

package/src/Grid/Grid.stories.tsx

@@ -4,7 +4,7 @@
 
 import '@dxos-theme';
 
-import { type Meta, type StoryObj } from '@storybook/react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { type MouseEvent, type MutableRefObject, useCallback, useRef, useState } from 'react';
 
 import { defaultRowSize } from '@dxos/lit-grid';
@@ -13,7 +13,7 @@ import { DropdownMenu } from '@dxos/react-ui';
 import { PopoverCombobox, type PopoverComboboxRootProps } from '@dxos/react-ui-searchlist';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { Grid, type GridEditing, type GridContentProps, type GridRootProps } from './Grid';
+import { Grid, type GridContentProps, type GridEditing, type GridRootProps } from './Grid';
 
 const storybookItems = faker.helpers.uniqueArray(faker.commerce.productName, 16);
 
@@ -101,12 +101,12 @@ const GridStory = ({ initialCells, ...props }: GridStoryProps) => {
   );
 };
 
-const meta: Meta<GridStoryProps> = {
+const meta = {
   title: 'ui/react-ui-grid/Grid',
   component: GridStory,
   decorators: [withTheme],
   parameters: { layout: 'fullscreen' },
-};
+} satisfies Meta<typeof GridStory>;
 
 export default meta;
 

package/src/Grid/Grid.tsx

@@ -4,13 +4,13 @@
 
 import '@dxos/lit-grid/dx-grid.pcss';
 
-import { createComponent, type EventName } from '@lit/react';
-import { createContextScope, type Scope } from '@radix-ui/react-context';
+import { type EventName, createComponent } from '@lit/react';
+import { type Scope, createContextScope } from '@radix-ui/react-context';
 import { useControllableState } from '@radix-ui/react-use-controllable-state';
 import React, {
   type ComponentProps,
-  forwardRef,
   type PropsWithChildren,
+  forwardRef,
   useCallback,
   useEffect,
   useState,
@@ -178,6 +178,7 @@ export {
   toPlaneCellIndex,
   parseCellIndex,
   cellQuery,
+  DxEditRequest,
 } from '@dxos/lit-grid';
 
 export type {