@dxos/react-ui-table 0.6.12-main.89e9959 → 0.6.12-main.ac23639

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 Story = (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: 'react-ui-table/ColumnSettings',
+  component: ColumnSettings,
+  decorators: [withTheme, withLayout()],
+  parameters: {
+    translations,
+  },
+  render: Story,
 };
 
 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}

@@ -5,28 +5,33 @@
 import React, { useRef, useState } from 'react';
 
 import { Button, Input, Select, useTranslation } from '@dxos/react-ui';
+import { FieldValueTypes } 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 [formState, setFormState] = useState({
     prop: column.id,
     refTable: column.refTable,
@@ -63,7 +68,7 @@ export const ColumnSettingsForm = ({
       id: prop, // TODO(burdon): Make unique.
       prop,
       label,
-      type: type as ColumnProps['type'],
+      type: type as ColumnDef['type'],
       refTable,
       refProp,
       digits: safeParseInt(digits),
@@ -76,9 +81,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
@@ -89,8 +95,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
@@ -102,8 +107,7 @@ export const ColumnSettingsForm = ({
             }
           />
         </Input.Root>
-      </div>
-      <div className='space-y-1'>
+
         <Input.Root>
           <Input.Label>{t('column type label')}</Input.Label>
           <Select.Root
@@ -114,7 +118,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>
@@ -124,9 +128,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
@@ -134,12 +137,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
@@ -162,9 +163,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
@@ -187,20 +187,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';

package/src/components/Table/Table.tsx

@@ -16,13 +16,13 @@ import {
 } from '@tanstack/react-table';
 import React, {
   type ComponentPropsWithoutRef,
+  type ReactNode,
   Fragment,
+  memo,
   useCallback,
   useEffect,
   useState,
   useContext,
-  type ReactNode,
-  memo,
 } from 'react';
 
 import { DensityProvider, type ThemedClassName, useDefaultValue } from '@dxos/react-ui';
@@ -55,7 +55,6 @@ const TableViewport = ({ children, classNames, asChild, ...props }: TableViewpor
   const { scrollContextRef } = useContext(TableRootContext);
 
   const classes = mx(classNames, 'overflow-auto');
-
   return asChild ? (
     <Slot ref={scrollContextRef} className={classes} {...props}>
       {children}
@@ -70,13 +69,13 @@ const TableViewport = ({ children, classNames, asChild, ...props }: TableViewpor
 export const TablePrimitive = <TData extends RowData>(props: TableProps<TData>) => {
   const {
     role,
-    onColumnResize,
-    columnVisibility,
     header = true,
     rowsSelectable,
     debug,
-    onDataSelectionChange,
     pinLastRow,
+    columnVisibility,
+    onColumnResize,
+    onDataSelectionChange,
   } = props;
 
   const columns = useDefaultValue(props.columns, () => []);

package/src/components/Table/TableContext.tsx

@@ -3,26 +3,32 @@
 //
 
 import { type RowData } from '@tanstack/react-table';
-import React, { useContext, createContext, type JSX, type ReactNode, type FC, type Context } from 'react';
+import React, {
+  useContext,
+  createContext,
+  type Context,
+  type JSX,
+  type PropsWithChildren,
+  type ReactNode,
+} from 'react';
+
+import { raise } from '@dxos/debug';
 
 import { type TableContextValue } from './props';
 
 export const TABLE_NAME = 'Table';
 
-// Create the context without a default value.
-// The expectation is that the provider will always supply a value, so no need to define a default here.
-const TableContext = createContext<TableContextValue<RowData>>({} as TableContextValue<RowData>);
+const TableContext = createContext<TableContextValue<RowData> | undefined>(undefined);
 
 export type TypedTableProvider<TData extends RowData> = {
   (props: TableContextValue<TData> & { children: ReactNode }): JSX.Element;
   displayName: string;
 };
 
-export const TableProvider: FC<TableContextValue<RowData> & { children: ReactNode }> = ({ children, ...value }) => {
+export const TableProvider = ({ children, ...value }: PropsWithChildren<TableContextValue<RowData>>) => {
   return <TableContext.Provider value={value}>{children}</TableContext.Provider>;
 };
 
-// Create a custom hook to consume the context.
 export const useTableContext = <TData extends RowData>(): TableContextValue<TData> => {
-  return useContext(TableContext as Context<TableContextValue<TData>>);
+  return useContext(TableContext as Context<TableContextValue<TData>>) ?? raise(new Error('Missing TableContext'));
 };

package/src/components/Table/index.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './Table';
 export * from './props';
+export * from './Table';
+export * from './TableContext';
 export * from './TableRootContext';

package/src/components/Table/props.ts

@@ -25,7 +25,7 @@ export type TableFlags = Partial<{
  * This is ‘current’ in the `aria-current` sense.
  */
 export type TableCurrent<TData extends RowData> = Partial<{
-  // App state
+  // App state.
   currentDatum: TData;
   onDatumClick: (datum: TData) => void;
 }>;
@@ -39,13 +39,13 @@ export type TableProps<TData extends RowData> = TableFlags &
     onColumnResize: (state: Record<string, number>) => void;
     onColumnReorder: (columnId: string, direction: 'left' | 'right') => void;
     columnVisibility: VisibilityState;
-    // Controllable row selection
+    // Controllable row selection.
     rowSelection: RowSelectionState;
     defaultRowSelection: RowSelectionState;
     onRowSelectionChange: (rowSelection: RowSelectionState) => void;
-    // Derived from row selection
+    // Derived from row selection.
     onDataSelectionChange: (dataSelection: TData[]) => void;
-    // `table` element props
+    // `table` element props.
     classNames: ClassNameValue;
     pinLastRow: boolean;
   }>;

package/src/helpers.tsx

@@ -21,8 +21,7 @@ import { log } from '@dxos/log';
 import { type ClassNameValue, Input, Tooltip } from '@dxos/react-ui';
 import { getSize, mx } from '@dxos/react-ui-theme';
 
-import { CellCombobox } from './components';
-import { useTableContext } from './components/Table/TableContext';
+import { CellCombobox, useTableContext } from './components';
 import { textPadding } from './theme';
 
 export type ValueUpdater<TData extends RowData, TValue> = (row: TData, id: string, value: TValue) => void;
@@ -470,7 +469,7 @@ export class ColumnBuilder<TData extends RowData> {
       size: 50,
       minSize: 50,
       header: (column) => label ?? column.header.id,
-      // TODO(zan): Implement sort algorithm
+      // TODO(zan): Implement sort algorithm.
       enableSorting: true,
       cell: SwitchBuilderCell,
       ...props,
@@ -486,7 +485,7 @@ export class ColumnBuilder<TData extends RowData> {
     const IconOff = off?.Icon ?? X;
     return {
       size: size ?? 32,
-      // TODO(zan): Implement sort algorithm
+      // TODO(zan): Implement sort algorithm.
       enableSorting: false,
       header: (column) => <div className={'justify-center'}>{label ?? column.header.id}</div>,
       cell: (cell) => {
@@ -506,14 +505,13 @@ export class ColumnBuilder<TData extends RowData> {
   /**
    * This display column type is for nested/unhandled data to appear as JSON.
    */
-  display({ label, classNames, ...props }: KeyColumnOptions<TData> = {}): Partial<ColumnDef<TData, PublicKey>> {
+  json({ label, classNames, ...props }: KeyColumnOptions<TData> = {}): Partial<ColumnDef<TData, PublicKey>> {
     return {
       size: 120,
       minSize: 120,
       header: (cell) => label ?? cell.header.id,
       cell: (cell) => {
         const value = cell.getValue();
-
         return (
           <div className='overflow-scroll'>
             <code className='text-xs'>{JSON.stringify(value)}</code>

package/src/schema/{SchemaToTable.stories.tsx → Schema.stories.tsx}

@@ -9,23 +9,14 @@ import * as fc from 'fast-check';
 import React from 'react';
 
 import { S } from '@dxos/echo-schema';
-import { DensityProvider } from '@dxos/react-ui';
-import { withTheme } from '@dxos/storybook-utils';
+import { withTheme, withLayout } from '@dxos/storybook-utils';
 
-import { schemaToColumnDefs } from './schemaToColumns';
+import { schemaToColumnDefs } from './column-utils';
 import { Table } from '../components';
 
 export default {
-  title: 'react-ui-table/SchemaTable',
-  args: {},
-  decorators: [
-    withTheme,
-    (Story: any) => (
-      <DensityProvider density='fine'>
-        <Story />
-      </DensityProvider>
-    ),
-  ],
+  title: 'react-ui-table/Schema',
+  decorators: [withTheme, withLayout()],
 };
 
 const exampleSchema = S.Struct({
@@ -49,7 +40,7 @@ const exampleSchemaArbitrary = Arbitrary.make(exampleSchema);
 
 const items = fc.sample(exampleSchemaArbitrary, 10);
 
-export const SchemaTable = {
+export const Default = {
   render: () => {
     return (
       <Table.Root>

package/src/schema/{schemaToColumns.ts → column-utils.ts}

@@ -5,37 +5,37 @@
 import { type ColumnDef } from '@tanstack/react-table';
 
 import { type S } from '@dxos/echo-schema';
+import { FieldValueType, mapSchemaToFields } from '@dxos/schema';
 
-import { classifySchemaProperties } from './schema';
 import { createColumnBuilder } from '../helpers';
 
 export const schemaToColumnDefs = <T>(schema: S.Schema<T, any>): ColumnDef<T, any>[] => {
   const { helper, builder } = createColumnBuilder<T>();
 
-  const classified = classifySchemaProperties(schema);
+  const classified = mapSchemaToFields(schema);
   return classified.map(([name, type]) => {
     const propertyKey = name.toString();
 
     let column: Partial<ColumnDef<any, any>> | undefined;
     switch (type) {
-      case 'string': {
+      case FieldValueType.String: {
         column = builder.string({ label: propertyKey });
         break;
       }
-      case 'number': {
+      case FieldValueType.Number: {
         column = builder.number({ label: propertyKey });
         break;
       }
-      case 'boolean': {
+      case FieldValueType.Boolean: {
         column = builder.switch({ label: propertyKey });
         break;
       }
-      case 'date': {
+      case FieldValueType.Date: {
         column = builder.date({ label: propertyKey });
         break;
       }
-      case 'display': {
-        column = builder.display({ label: propertyKey, id: propertyKey });
+      case FieldValueType.JSON: {
+        column = builder.json({ label: propertyKey, id: propertyKey });
         break;
       }
       default: {

package/src/schema/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './schemaToColumns';
+export * from './column-utils';
 export * from './types';

package/src/schema/types.ts

@@ -2,18 +2,20 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type FieldValueType } from '@dxos/schema';
+
+// TODO(burdon): Reconcile with @dxos/schema/View.
 export type TableDef = {
   id: string;
-  name?: string; // TODO(burdon): Required?
-  columns: ColumnProps[];
+  name?: string;
+  columns: ColumnDef[];
 };
 
-export type ColumnType = 'number' | 'boolean' | 'date' | 'string' | 'ref';
-
-export type ColumnProps = {
+// TODO(burdon): Reconcile with @dxos/schema/Field.
+export type ColumnDef = {
   id: string;
   prop: string;
-  type: ColumnType;
+  type: FieldValueType;
   size?: number;
   label?: string;
 

package/src/translations.ts

@@ -10,7 +10,7 @@ export default [
       [translationKey]: {
         'no selection label': ' ',
         'number column type label': 'Number',
-        'boolean column type label': 'Toggle',
+        'boolean column type label': 'Boolean',
         'date column type label': 'Date',
         'string column type label': 'Text',
         'ref column type label': 'Reference',

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import { type TableDef, type ColumnProps } from '../../schema';
-export type ColumnSettingsFormProps = {
-    column: ColumnProps;
-    tableDef: TableDef;
-    tablesToReference: TableDef[];
-    onUpdate?: ((id: string, column: ColumnProps) => void) | undefined;
-    onDelete?: ((id: string) => void) | undefined;
-    onClose?: () => void;
-};
-export declare const ColumnSettingsForm: ({ column, tableDef, tablesToReference, onUpdate, onDelete, onClose, }: ColumnSettingsFormProps) => React.JSX.Element;
-//# sourceMappingURL=ColumnSettingsForm.d.ts.map

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ColumnSettingsForm.d.ts","sourceRoot":"","sources":["../../../../../src/components/ColumnMenu/ColumnSettingsForm.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA2B,MAAM,OAAO,CAAC;AAKhD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAmB,MAAM,cAAc,CAAC;AAGhF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,EAAE,QAAQ,EAAE,CAAC;IAC9B,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACnE,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9C,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,kBAAkB,0EAO5B,uBAAuB,sBAkLzB,CAAC"}