@react-fabric/data 1.0.0-beta.5 → 1.0.0-beta.7

package/src/table/Table.tsx

@@ -22,11 +22,17 @@
  */
 
 import { EmptyContent, Loading, useDebounce } from "@react-fabric/core";
-import classNames from "classnames";
-import { useImperativeHandle, useMemo, useRef } from "react";
+import { debounce } from "@react-fabric/utilities";
+import {
+  useEffect,
+  useImperativeHandle,
+  useLayoutEffect,
+  useMemo,
+  useRef,
+} from "react";
 import { useTranslation } from "react-i18next";
 import { AddColumn } from "./AddColumn";
-import { BodyCell } from "./BodyCell";
+import { BodyRow } from "./BodyRow";
 import { CheckboxCell } from "./CheckboxCell";
 import { TableProvider } from "./Context";
 import { EmptyCell } from "./EmptyCell";
@@ -41,10 +47,15 @@ export const Table = <T extends KeyValue = KeyValue>({
   columns,
   keyProperty,
   checkableRows,
+  initialScroll,
   hideableColumns,
   sort,
   loading,
+  emptyDisplay,
+  canExpand,
+  children,
   onSort,
+  onScroll,
   onRowClick,
   onCheckedChanged,
 }: TableProps<T>) => {
@@ -58,7 +69,10 @@ export const Table = <T extends KeyValue = KeyValue>({
   const {
     scrollerRef,
     items,
+    top,
     checkState,
+    virtualizer,
+    toggleExpand,
     toggleChecked,
     toggleAllChecked,
     getData,
@@ -76,32 +90,51 @@ export const Table = <T extends KeyValue = KeyValue>({
     [],
   );
 
+  useLayoutEffect(() => {
+    setTimeout(() => {
+      initialScroll &&
+        virtualizer.scrollToIndex(initialScroll, { align: "start" });
+    }, 100);
+  }, []);
+
   useImperativeHandle(
     ref,
     () => ({
-      hilight: (row: number) => {
-        refBody.current
-          ?.querySelectorAll<HTMLElement>(`.datatable-row[data-hilight="true"]`)
-          .forEach((el) => el && (el.dataset.hilight = undefined));
-        const el = refBody.current?.querySelector<HTMLElement>(
-          `[data-row="${row}"]`,
-        );
-        el?.scrollIntoView({ behavior: "smooth", block: "center" });
-        el && (el.dataset.hilight = "true");
+      scrollTo: (row: number) => {
+        virtualizer.scrollToIndex(row, { align: "start" });
       },
-      unhilight: () => {
-        refBody.current
-          ?.querySelectorAll<HTMLElement>(`.datatable-row[data-hilight="true"]`)
-          .forEach((el) => el && (el.dataset.hilight = undefined));
+      hilight(row) {
+        scrollerRef.current
+          ?.querySelector(".hilight")
+          ?.classList.remove("hilight", "ring-1");
+        virtualizer.scrollToIndex(Math.floor(row), {
+          align: "start",
+        });
+        setTimeout(() => {
+          scrollerRef.current
+            ?.querySelector(`[data-index="${row}"]`)
+            ?.classList.add("hilight", "ring-1");
+        }, 100);
       },
-      scrollTo: (row: number) => {
-        const el = refBody.current?.querySelector(`[data-row="${row}"]`);
-        el?.scrollIntoView({ behavior: "smooth" });
+      unhilight() {
+        scrollerRef.current
+          ?.querySelector(".hilight")
+          ?.classList.remove("hilight", "ring-1");
       },
     }),
     [],
   );
 
+  useEffect(() => {
+    const handle = debounce((top: number) => {
+      onScroll?.(top ?? 0);
+    });
+    handle(top);
+    return () => {
+      handle.cancel();
+    };
+  }, [top]);
+
   return (
     <TableProvider>
       <div
@@ -113,6 +146,7 @@ export const Table = <T extends KeyValue = KeyValue>({
       >
         <div className="bg-base font-medium sticky top-0 area-head border-b select-none flex flex-nowrap z-2">
           <div className={wrapperStart}>
+            {canExpand && <div className="w-6" />}
             {checkableRows && (
               <CheckboxCell
                 state={checkState.allChecked}
@@ -150,58 +184,39 @@ export const Table = <T extends KeyValue = KeyValue>({
             {items.map(({ index, key }) => {
               const data = getData(index);
               return (
-                <div
-                  key={key}
-                  role="none"
-                  data-row={index}
-                  className={classNames(
-                    "flex flex-nowrap datatable-row data-[hilight]:outline-1 -outline-offset-1 outline-primary-500",
-                    index % 2 ? "bg-even" : "bg-odd",
-                    onRowClick && "hover:bg-primary-50 active:bg-primary-100",
-                  )}
-                  onClick={() =>
-                    checkableRows && keyProperty && !onRowClick
-                      ? toggleChecked(data[keyProperty])
-                      : onRowClick?.(data)
+                <BodyRow
+                  rowKey={key}
+                  index={index}
+                  checkableRows={checkableRows}
+                  checked={
+                    keyProperty &&
+                    checkState.checked.includes(data[keyProperty])
+                      ? 1
+                      : 0
                   }
-                  data-index={index}
-                  ref={measureElement}
-                >
-                  <div className={wrapperStart}>
-                    {checkableRows && keyProperty && (
-                      <CheckboxCell
-                        onClick={() => toggleChecked(data[keyProperty])}
-                        state={
-                          checkState.checked.includes(data[keyProperty]) ? 1 : 0
-                        }
-                      />
-                    )}
-                    {state.start?.map((col, ids) => (
-                      <BodyCell
-                        key={`${key}:${ids}`}
-                        column={col}
-                        item={data}
-                      />
-                    ))}
-                  </div>
-                  {state.cols?.map((col, idc) => (
-                    <BodyCell key={`${key}:${idc}`} column={col} item={data} />
-                  ))}
-                  <div className={wrapperEnd}>
-                    {state.end?.map((col, ide) => (
-                      <BodyCell
-                        key={`${key}:${ide}`}
-                        column={col}
-                        item={data}
-                      />
-                    ))}
-                    {hideableColumns && <div className="w-6" />}
-                  </div>
-                </div>
+                  expanded={
+                    !!keyProperty &&
+                    checkState.expanded.includes(data[keyProperty])
+                  }
+                  data={data}
+                  hideableColumns={hideableColumns}
+                  keyProperty={keyProperty}
+                  measureElement={measureElement}
+                  onRowClick={onRowClick}
+                  state={state}
+                  canExpand={canExpand}
+                  toggleExpand={toggleExpand}
+                  expandRow={children}
+                  toggleChecked={toggleChecked}
+                  wrapperEnd={wrapperEnd}
+                  wrapperStart={wrapperStart}
+                  key={key}
+                />
               );
             })}
             <div className="flex-1 flex flex-nowrap">
               <div className={wrapperStart}>
+                {canExpand && <div className="w-6" />}
                 {checkableRows && <div className="w-6" />}
                 {state.start?.map((col) => (
                   <EmptyCell key={String(col.id)} {...col} />
@@ -220,13 +235,15 @@ export const Table = <T extends KeyValue = KeyValue>({
             </div>
           </div>
         )}
-        {!loading && data.length === 0 && (
-          <EmptyContent
-            size="sm"
-            className="bg-dimmed"
-            message={t("datagrid.empty")}
-          />
-        )}
+        {!loading &&
+          data.length === 0 &&
+          (emptyDisplay ?? (
+            <EmptyContent
+              size="sm"
+              className="bg-dimmed"
+              message={t("datagrid.empty")}
+            />
+          ))}
       </div>
     </TableProvider>
   );

package/src/table/types.ts

@@ -23,6 +23,7 @@
 
 import {
   type CssProp,
+  type Elements,
   type IconProps,
   type RefProp,
   type TestProps,
@@ -33,12 +34,13 @@ export const COL_MIN_WIDTH = "3rem";
 export const COL_MAX_WIDTH = "64rem";
 export const COL_DEFAULT_WIDTH = "12rem";
 
-export interface ColumnType<T = KeyValue>
+export interface TableColumn<T = KeyValue>
   extends CssProp,
     IconProps,
     TestProps {
   id: keyof T | string;
   label?: string;
+  tooltip?: string;
   actions?: ReactElement;
   align?: "start" | "center" | "end";
   locked?: "start" | "end";
@@ -60,7 +62,8 @@ export interface ColumnType<T = KeyValue>
     | "time"
     | "unknown";
   format?: string;
-  renderer?: (value: AnyObject, data: T) => void;
+  valueMap?: KeyValue;
+  renderer?: (value: AnyObject, data: T, index: number) => Elements<AnyObject>;
 }
 
 export interface TableRef {
@@ -70,9 +73,10 @@ export interface TableRef {
 }
 
 export interface TableProps<T = KeyValue> extends RefProp<TableRef> {
-  columns: Array<ColumnType<T>>;
+  columns: Array<TableColumn<T>>;
   data: T[];
   keyProperty?: keyof T;
+  emptyDisplay?: ReactElement;
   /**
    * checkable rows
    */
@@ -88,4 +92,10 @@ export interface TableProps<T = KeyValue> extends RefProp<TableRef> {
   hideableColumns?: boolean;
 
   onRowClick?: (data: T) => void;
+
+  initialScroll?: number;
+  onScroll?: (firstItem: number) => void;
+
+  canExpand?: (record: T) => boolean;
+  children?: (record: T) => Elements<AnyObject>;
 }

package/src/table/useTableColumns.ts

@@ -23,20 +23,20 @@
 
 import { groupBy } from "@react-fabric/utilities";
 import { useEffect, useReducer } from "react";
-import { type ColumnType } from "./types";
+import { type TableColumn } from "./types";
 
 interface ColumnState {
-  columns: ColumnType[];
-  start: ColumnType[];
-  end: ColumnType[];
-  cols: ColumnType[];
+  columns: TableColumn[];
+  start: TableColumn[];
+  end: TableColumn[];
+  cols: TableColumn[];
 }
 
 type ColumnActions =
-  | { type: "columns"; columns: ColumnType[] }
+  | { type: "columns"; columns: TableColumn[] }
   | { type: "hide"; id: string };
 
-export const useTableColumns = (columns: ColumnType[]) => {
+export const useTableColumns = (columns: TableColumn[]) => {
   const [state, dispatch] = useReducer(
     (state: ColumnState, action: ColumnActions) => {
       if (action.type === "columns") {

package/src/table/useVirtualTable.ts

@@ -25,11 +25,15 @@ import { useVirtualizer } from "@tanstack/react-virtual";
 import { useCallback, useReducer, useRef } from "react";
 
 interface DataState {
+  expanded: Key[];
   checked: Key[];
   allChecked: 0 | 1 | 2;
 }
 
-type DataAction = { type: "check"; key: Key } | { type: "checkall" };
+type DataAction =
+  | { type: "expand"; key: Key }
+  | { type: "check"; key: Key }
+  | { type: "checkall" };
 
 export const useVirtualTable = (
   data: KeyValue[],
@@ -48,10 +52,16 @@ export const useVirtualTable = (
 
   const [state, dispatch] = useReducer(
     (state: DataState, action: DataAction) => {
+      if (action.type === "expand") {
+        if (state.expanded.includes(action.key))
+          state.expanded.splice(state.expanded.indexOf(action.key), 1);
+        else state.expanded.push(action.key);
+      }
       if (action.type === "check") {
         if (state.checked.includes(action.key))
           state.checked.splice(state.checked.indexOf(action.key), 1);
         else state.checked.push(action.key);
+        onCheckChanged?.(state.checked);
       }
       if (action.type === "checkall") {
         if (state.allChecked !== 0) {
@@ -59,8 +69,8 @@ export const useVirtualTable = (
         } else if (keyProperty) {
           state.checked = data.map((item) => item[keyProperty]);
         }
+        onCheckChanged?.(state.checked);
       }
-      onCheckChanged?.(state.checked);
       return {
         ...state,
         allChecked:
@@ -73,6 +83,7 @@ export const useVirtualTable = (
     },
     {
       checked: [],
+      expanded: [],
       allChecked: 0,
     },
   );
@@ -91,8 +102,11 @@ export const useVirtualTable = (
     items: virtualItems,
     checkState: state,
     getData,
+    virtualizer,
+    top: virtualizer.range?.startIndex,
     totalSize: virtualizer.getTotalSize,
     measureElement: virtualizer.measureElement,
+    toggleExpand: (key: Key) => dispatch({ type: "expand", key }),
     toggleChecked: (key: Key) => dispatch({ type: "check", key }),
     toggleAllChecked: () => dispatch({ type: "checkall" }),
   };

package/src/virtual/Gallery.tsx

@@ -22,6 +22,7 @@
  */
 
 import { Skeleton, useDebounce, useEffectDebugger } from "@react-fabric/core";
+import { type TestProps } from "@react-fabric/core/dist/types/types";
 import { debounce } from "@react-fabric/utilities";
 import { useVirtualizer } from "@tanstack/react-virtual";
 import classNames from "classnames";
@@ -47,7 +48,7 @@ export interface VirtualGalleryRef {
   unhilight: () => void;
 }
 
-export interface VirtualGalleryProps<T> {
+export interface VirtualGalleryProps<T> extends TestProps {
   children: (props: {
     data: T;
     index: number;
@@ -108,6 +109,7 @@ const _VirtualGallery = <T extends KeyValue>({
   onLoadMore,
   onScroll,
   galleryRef,
+  ...aria
 }: VirtualGalleryProps<T>) => {
   const count = useDeferredValue(items.length);
   const extraSize = useMemo(() => (onLoadMore ? 64 : 0), [onLoadMore]);
@@ -275,6 +277,7 @@ const _VirtualGallery = <T extends KeyValue>({
       className={classNames(
         "area-content bg-base overflow-auto contain-strict",
       )}
+      {...aria}
     >
       <div
         className={classNames(

package/src/virtual/List.tsx

@@ -29,6 +29,7 @@
  */
 
 import { Skeleton, useDebounce } from "@react-fabric/core";
+import { type TestProps } from "@react-fabric/core/dist/types/types";
 import { debounce } from "@react-fabric/utilities";
 import { useVirtualizer } from "@tanstack/react-virtual";
 import classNames from "classnames";
@@ -54,7 +55,7 @@ export interface VirtualListRef {
   unhilight: () => void;
 }
 
-export interface VirtualListProps<T> {
+export interface VirtualListProps<T> extends TestProps {
   children: (props: {
     data: T;
     index: number;
@@ -120,6 +121,7 @@ const _VirtualList = <T extends KeyValue>({
   onLoadMore,
   onScroll,
   listRef,
+  ...aria
 }: VirtualListProps<T>) => {
   const count = useDeferredValue(items.length);
   const extraSize = useMemo(() => (onLoadMore ? 64 : 0), [onLoadMore]);
@@ -258,6 +260,7 @@ const _VirtualList = <T extends KeyValue>({
       className={classNames(
         "area-content bg-base overflow-auto contain-strict",
       )}
+      {...aria}
     >
       <div
         className={classNames(