@dxos/react-ui-table 0.6.13 → 0.6.14-main.2b6a0f3

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@dxos/react-ui-table",
-  "version": "0.6.13",
+  "version": "0.6.14-main.2b6a0f3",
   "description": "A table component.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "DXOS.org",
+  "sideEffects": false,
   "exports": {
     ".": {
       "browser": "./dist/lib/browser/index.mjs",
@@ -21,7 +22,6 @@
     "src"
   ],
   "dependencies": {
-    "@effect/schema": "^0.67.16",
     "@fluentui/react-tabster": "^9.19.0",
     "@radix-ui/react-context": "^1.0.0",
     "@radix-ui/react-primitive": "^1.0.2",
@@ -30,16 +30,17 @@
     "@tanstack/react-table": "^8.13.2",
     "@tanstack/react-virtual": "^3.9.0",
     "date-fns": "^3.3.1",
-    "effect": "^3.2.7",
-    "@dxos/invariant": "0.6.13",
-    "@dxos/keys": "0.6.13",
-    "@dxos/async": "0.6.13",
-    "@dxos/log": "0.6.13",
-    "@dxos/react-ui": "0.6.13",
-    "@dxos/react-ui-searchlist": "0.6.13",
-    "@dxos/react-ui-types": "0.6.13",
-    "@dxos/react-ui-theme": "0.6.13",
-    "@dxos/util": "0.6.13"
+    "@dxos/async": "0.6.14-main.2b6a0f3",
+    "@dxos/echo-schema": "0.6.14-main.2b6a0f3",
+    "@dxos/effect": "0.6.14-main.2b6a0f3",
+    "@dxos/debug": "0.6.14-main.2b6a0f3",
+    "@dxos/invariant": "0.6.14-main.2b6a0f3",
+    "@dxos/keys": "0.6.14-main.2b6a0f3",
+    "@dxos/log": "0.6.14-main.2b6a0f3",
+    "@dxos/react-ui-searchlist": "0.6.14-main.2b6a0f3",
+    "@dxos/react-ui-types": "0.6.14-main.2b6a0f3",
+    "@dxos/schema": "0.6.14-main.2b6a0f3",
+    "@dxos/util": "0.6.14-main.2b6a0f3"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
@@ -48,17 +49,19 @@
     "fast-check": "^3.19.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "vite": "^5.3.4",
-    "@dxos/echo-schema": "0.6.13",
-    "@dxos/echo-signals": "0.6.13",
-    "@dxos/random": "0.6.13",
-    "@dxos/storybook-utils": "0.6.13",
-    "@dxos/react-ui-theme": "0.6.13"
+    "vite": "5.4.7",
+    "@dxos/random": "0.6.14-main.2b6a0f3",
+    "@dxos/echo-signals": "0.6.14-main.2b6a0f3",
+    "@dxos/react-ui": "0.6.14-main.2b6a0f3",
+    "@dxos/react-ui-theme": "0.6.14-main.2b6a0f3",
+    "@dxos/storybook-utils": "0.6.14-main.2b6a0f3"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.1.5",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "@dxos/react-ui": "0.6.14-main.2b6a0f3",
+    "@dxos/react-ui-theme": "0.6.14-main.2b6a0f3"
   },
   "publishConfig": {
     "access": "public"

package/src/components/ColumnMenu/ColumnMenu.stories.tsx

@@ -7,39 +7,40 @@ import '@dxos-theme';
 import { type SortDirection } from '@tanstack/react-table';
 import React, { useState } from 'react';
 
+import { FieldValueType } from '@dxos/schema';
 import { withTheme } from '@dxos/storybook-utils';
 
 import { ColumnMenu } from './ColumnMenu';
-import { type ColumnSettingsFormProps } from './ColumnSettingsForm';
-import { type ColumnProps } from '../../schema';
+import { type ColumnSettingsProps } from './ColumnSettings';
+import { type ColumnDef } from '../../schema';
 
 export default {
-  title: 'react-ui-table/ColumnMenu',
+  title: 'ui/react-ui-table/ColumnMenu',
   component: ColumnMenu,
   decorators: [withTheme],
 };
 
-const defs: Pick<ColumnSettingsFormProps, 'tableDef' | 'tablesToReference'> = {
+const defs: Pick<ColumnSettingsProps, 'tableDef' | 'tablesToReference'> = {
   tableDef: {
     id: '1',
     name: 'table 1',
-    columns: [{ id: 'col-1', prop: 'one-foo', type: 'string' }],
+    columns: [{ id: 'col-1', prop: 'one', type: FieldValueType.String }],
   },
   tablesToReference: [
     {
       id: '1',
       name: 'table 1',
-      columns: [{ id: 'col-1', prop: 'one-foo', type: 'string' }],
+      columns: [{ id: 'col-1', prop: 'one', type: FieldValueType.String }],
     },
     {
       id: '2',
       name: 'table 2',
-      columns: [{ id: 'col-1', prop: 'two-foo', type: 'string' }],
+      columns: [{ id: 'col-1', prop: 'two', type: FieldValueType.String }],
     },
   ],
 };
 
-const funcs: Pick<ColumnSettingsFormProps, 'onUpdate' | 'onDelete'> = {
+const functions: Pick<ColumnSettingsProps, 'onUpdate' | 'onDelete'> = {
   onUpdate: (...args: any) => console.log('onUpdate args', args),
   onDelete: (...args: any) => console.log('onDelete args', args),
 };
@@ -49,10 +50,10 @@ export const Default = {
     column: {
       id: 'test',
       label: 'test',
-    } as ColumnProps,
+    } as ColumnDef,
 
     ...defs,
-    ...funcs,
+    ...functions,
 
     context: {
       header: {
@@ -89,11 +90,13 @@ export const ReactiveSort = {
       column: {
         id: 'test',
         label: 'test',
-      } as ColumnProps,
+      } as ColumnDef,
       context: {
         header: {
           column: {
             getCanSort: () => true,
+            getIsSorted: () => sort,
+            clearSorting: () => setSort(false),
             toggleSorting: (desc?: boolean) => {
               if (desc === undefined) {
                 setSort(false);
@@ -103,8 +106,6 @@ export const ReactiveSort = {
                 setSort('asc');
               }
             },
-            getIsSorted: () => sort,
-            clearSorting: () => setSort(false),
             getToggleSortingHandler: () => () => {
               if (sort === 'asc') {
                 setSort('desc');

package/src/components/ColumnMenu/ColumnMenu.tsx

@@ -9,22 +9,25 @@ import React, { useRef, useState, useCallback } from 'react';
 import { Button, Popover, DropdownMenu } from '@dxos/react-ui';
 import { getSize, mx } from '@dxos/react-ui-theme';
 
-import { ColumnSettingsForm } from './ColumnSettingsForm';
+import { ColumnSettings } from './ColumnSettings';
 import { useSortColumn } from '../../hooks';
-import { type TableDef, type ColumnProps } from '../../schema';
+import { type TableDef, type ColumnDef } from '../../schema';
 
 export type ColumnMenuProps<TData extends RowData, TValue> = {
   context: HeaderContext<TData, TValue>;
   tablesToReference: TableDef[];
   tableDef: TableDef;
-  column: ColumnProps;
+  column: ColumnDef;
   columnOrderable: boolean;
   columnPosition: 'start' | 'end' | undefined;
   onColumnReorder: (columnId: string, direction: 'left' | 'right') => void;
-  onUpdate?: (id: string, column: ColumnProps) => void;
+  onUpdate?: (id: string, column: ColumnDef) => void;
   onDelete?: (id: string) => void;
 };
 
+/**
+ * @deprecated
+ */
 export const ColumnMenu = <TData extends RowData, TValue>({
   column,
   columnOrderable,
@@ -138,7 +141,7 @@ export const ColumnMenu = <TData extends RowData, TValue>({
           <Popover.Portal>
             <Popover.Content>
               <Popover.Viewport>
-                <ColumnSettingsForm {...props} column={column} onClose={() => setIsColumnSettingsOpen(false)} />
+                <ColumnSettings {...props} column={column} onClose={() => setIsColumnSettingsOpen(false)} />
               </Popover.Viewport>
               <Popover.Arrow />
             </Popover.Content>

package/src/components/ColumnMenu/{ColumnSettingsForm.stories.tsx → ColumnSettings.stories.tsx}

@@ -3,25 +3,38 @@
 //
 
 import '@dxos-theme';
+
 import React from 'react';
 
-import { withTheme } from '@dxos/storybook-utils';
+import { FieldValueType } from '@dxos/schema';
+import { withTheme, withLayout } from '@dxos/storybook-utils';
 
-import { ColumnSettingsForm, type ColumnSettingsFormProps } from './ColumnSettingsForm';
+import { ColumnSettings, type ColumnSettingsProps } from './ColumnSettings';
 import { type TableDef } from '../../schema';
+import translations from '../../translations';
+
+const DefaultStory = (props: ColumnSettingsProps) => (
+  <div className='flex w-[240px] m-2 p-2 border border-separator rounded'>
+    <ColumnSettings {...props} />
+  </div>
+);
 
 export default {
-  title: 'react-ui-table/ColumnSettingsForm',
-  component: ColumnSettingsForm,
-  decorators: [withTheme],
+  title: 'ui/react-ui-table/ColumnSettings',
+  component: ColumnSettings,
+  render: DefaultStory,
+  decorators: [withTheme, withLayout()],
+  parameters: {
+    translations,
+  },
 };
 
 const sampleTableDef: TableDef = {
   id: '1',
   name: 'Sample Table',
   columns: [
-    { id: 'col-1', prop: 'name', type: 'string', label: 'Name' },
-    { id: 'col-2', prop: 'age', type: 'number', label: 'Age', digits: 0 },
+    { id: 'col-1', prop: 'name', type: FieldValueType.String, label: 'Name' },
+    { id: 'col-2', prop: 'age', type: FieldValueType.Number, label: 'Age', digits: 0 },
   ],
 };
 
@@ -31,17 +44,17 @@ const sampleTablesToReference: TableDef[] = [
     id: '2',
     name: 'Reference Table',
     columns: [
-      { id: 'ref-col-1', prop: 'id', type: 'string', label: 'ID' },
-      { id: 'ref-col-2', prop: 'description', type: 'string', label: 'Description' },
+      { id: 'ref-col-1', prop: 'id', type: FieldValueType.String, label: 'ID' },
+      { id: 'ref-col-2', prop: 'description', type: FieldValueType.String, label: 'Description' },
     ],
   },
 ];
 
-const defaultArgs: ColumnSettingsFormProps = {
+const defaultArgs: ColumnSettingsProps = {
   column: {
     id: 'col-1',
     prop: 'name',
-    type: 'string',
+    type: FieldValueType.String,
     label: 'Name',
   },
   tableDef: sampleTableDef,
@@ -61,7 +74,7 @@ export const NumberColumn = {
     column: {
       id: 'col-2',
       prop: 'age',
-      type: 'number',
+      type: FieldValueType.Number,
       label: 'Age',
       digits: 0,
     },
@@ -74,7 +87,7 @@ export const ReferenceColumn = {
     column: {
       id: 'col-3',
       prop: 'reference',
-      type: 'ref',
+      type: FieldValueType.Ref,
       label: 'Reference',
       refTable: '2',
       refProp: 'ref-col-1',
@@ -88,17 +101,8 @@ export const NewColumn = {
     column: {
       id: 'new-col',
       prop: '',
-      type: 'string',
+      type: FieldValueType.String,
       label: '',
     },
   },
 };
-
-const Template = (args: ColumnSettingsFormProps) => (
-  <div className='p-4 max-is-64'>
-    <ColumnSettingsForm {...args} />
-  </div>
-);
-
-export const Interactive = Template.bind({});
-(Interactive as any).args = defaultArgs;

package/src/components/ColumnMenu/{ColumnSettingsForm.tsx → ColumnSettings.tsx}

@@ -1,31 +1,39 @@
 //
 // Copyright 2024 DXOS.org
 //
+
 import React, { useRef, useState } from 'react';
 
 import { Button, Input, Select, useTranslation } from '@dxos/react-ui';
+import { FieldValueTypes, type FieldValueType } from '@dxos/schema';
 import { safeParseInt } from '@dxos/util';
 
-import { type TableDef, type ColumnProps, type ColumnType } from '../../schema';
+import { type TableDef, type ColumnDef } from '../../schema';
 import { translationKey } from '../../translations';
 
-export type ColumnSettingsFormProps = {
-  column: ColumnProps;
+export type ColumnSettingsProps = {
+  column: ColumnDef;
   tableDef: TableDef;
+  // TODO(burdon): Rename.
   tablesToReference: TableDef[];
-  onUpdate?: ((id: string, column: ColumnProps) => void) | undefined;
-  onDelete?: ((id: string) => void) | undefined;
+  onUpdate?: (id: string, column: ColumnDef) => void;
+  onDelete?: (id: string) => void;
   onClose?: () => void;
 };
 
-export const ColumnSettingsForm = ({
+/**
+ * @deprecated
+ */
+export const ColumnSettings = ({
   column,
   tableDef,
   tablesToReference,
   onUpdate,
   onDelete,
   onClose,
-}: ColumnSettingsFormProps) => {
+}: ColumnSettingsProps) => {
+  const { t } = useTranslation(translationKey);
+  const propRef = useRef<HTMLInputElement>(null);
   const [formState, setFormState] = useState({
     prop: column.id,
     refTable: column.refTable,
@@ -35,9 +43,6 @@ export const ColumnSettingsForm = ({
     digits: String(column.digits ?? '0'),
   });
 
-  const propRef = useRef<HTMLInputElement>(null);
-  const { t } = useTranslation(translationKey);
-
   const handleSave = () => {
     const { prop, refTable, refProp, type, label, digits } = formState;
 
@@ -62,7 +67,7 @@ export const ColumnSettingsForm = ({
       id: prop, // TODO(burdon): Make unique.
       prop,
       label,
-      type: type as ColumnProps['type'],
+      type: type as FieldValueType,
       refTable,
       refProp,
       digits: safeParseInt(digits),
@@ -75,9 +80,10 @@ export const ColumnSettingsForm = ({
     onClose?.();
   };
 
+  // TODO(burdon): Standardize dialog/popup.
   return (
-    <div className='p-1 space-y-2'>
-      <div className='space-y-1'>
+    <div className='flex flex-col w-full gap-4'>
+      <div className='flex flex-col gap-2'>
         <Input.Root>
           <Input.Label>{t('column label label')}</Input.Label>
           <Input.TextInput
@@ -88,8 +94,7 @@ export const ColumnSettingsForm = ({
             data-testid='table.column-settings.label'
           />
         </Input.Root>
-      </div>
-      <div className='space-y-1'>
+
         <Input.Root>
           <Input.Label>{t('property key label')}</Input.Label>
           <Input.TextInput
@@ -101,8 +106,7 @@ export const ColumnSettingsForm = ({
             }
           />
         </Input.Root>
-      </div>
-      <div className='space-y-1'>
+
         <Input.Root>
           <Input.Label>{t('column type label')}</Input.Label>
           <Select.Root
@@ -113,7 +117,7 @@ export const ColumnSettingsForm = ({
             <Select.Portal>
               <Select.Content>
                 <Select.Viewport>
-                  {(['number', 'boolean', 'string', 'ref'] as ColumnType[]).map((type) => (
+                  {FieldValueTypes.map((type) => (
                     <Select.Option key={type} value={type}>
                       {t(`${type} column type label`)}
                     </Select.Option>
@@ -123,9 +127,8 @@ export const ColumnSettingsForm = ({
             </Select.Portal>
           </Select.Root>
         </Input.Root>
-      </div>
-      {formState.type === 'number' && (
-        <div className='space-y-1'>
+
+        {formState.type === 'number' && (
           <Input.Root>
             <Input.Label>{t('digits label')}</Input.Label>
             <Input.TextInput
@@ -133,12 +136,10 @@ export const ColumnSettingsForm = ({
               onChange={(event) => setFormState((prevState) => ({ ...prevState, digits: event.target.value }))}
             />
           </Input.Root>
-        </div>
-      )}
+        )}
 
-      {formState.type === 'ref' && (
-        <>
-          <div className='space-y-1'>
+        {formState.type === 'ref' && (
+          <>
             <Input.Root>
               <Input.Label>Table</Input.Label>
               <Select.Root
@@ -161,9 +162,8 @@ export const ColumnSettingsForm = ({
                 </Select.Portal>
               </Select.Root>
             </Input.Root>
-          </div>
-          {formState.refTable && (
-            <div className='space-y-1'>
+
+            {formState.refTable && (
               <Input.Root>
                 <Input.Label>Table property</Input.Label>
                 <Select.Root
@@ -186,20 +186,21 @@ export const ColumnSettingsForm = ({
                   </Select.Portal>
                 </Select.Root>
               </Input.Root>
-            </div>
-          )}
-        </>
-      )}
-
-      <div role='none' className='h-1' />
-
-      <div className='flex flex-row justify-end gap-1'>
-        <Button onClick={handleDelete} data-testid='table.column-settings.delete'>
-          {t('delete label')}
-        </Button>
-        <Button variant='primary' onClick={handleSave} data-testid='table.column-settings.save'>
-          {t('save label')}
-        </Button>
+            )}
+          </>
+        )}
+      </div>
+
+      <div>
+        {/* TODO(burdon): Change delete to cancel. Delete should be menu item. */}
+        <div className='flex flex-row justify-end gap-1'>
+          <Button onClick={handleDelete} data-testid='table.column-settings.delete'>
+            {t('delete label')}
+          </Button>
+          <Button variant='primary' onClick={handleSave} data-testid='table.column-settings.save'>
+            {t('save label')}
+          </Button>
+        </div>
       </div>
     </div>
   );

package/src/components/ColumnMenu/index.ts

@@ -3,4 +3,4 @@
 //
 
 export * from './ColumnMenu';
-export * from './ColumnSettingsForm';
+export * from './ColumnSettings';