@react-fabric/data 1.0.0-beta.1 → 1.0.0-beta.12

package/src/histogram/Histogram.tsx

@@ -31,6 +31,7 @@ import {
 import {
   type ColorType,
   type PaletteType,
+  type TestProps,
 } from "@react-fabric/core/dist/types/types";
 import { compareValues, Format } from "@react-fabric/utilities";
 import classNames from "classnames";
@@ -49,7 +50,7 @@ interface HistogramItem {
   disabled?: boolean;
 }
 
-export interface HistogramProps {
+export interface HistogramProps extends TestProps {
   /**
    * histogram items list
    */
@@ -88,6 +89,7 @@ export const Histogram = ({
   emptyTitle,
   emptyMessage,
   onClick,
+  ...aria
 }: HistogramProps) => {
   const { t } = useTranslation("data");
   const maxTotal = useMemo(() => {
@@ -104,6 +106,7 @@ export const Histogram = ({
   return (
     <div
       className={classes.histogram}
+      {...aria}
       style={
         {
           "--color": `var(--${color})`,
@@ -125,8 +128,10 @@ export const Histogram = ({
           className={classNames(
             "relative cursor-pointer flex flex-nowrap items-center select-none overflow-hidden min-h-6 my-px",
             classes.histoLabel,
-            (item.count === 0 || item.disabled) && "pointer-events-none",
+            ((item.total ?? item.count) === 0 || item.disabled) &&
+              "pointer-events-none",
           )}
+          data-testid={item.id}
           onClick={(e) => [onClick?.(item.id), e.stopPropagation()]}
         >
           <div

package/src/hooks/useSelectableList.ts

@@ -0,0 +1,94 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import { useCallback, useEffect, useRef, useState, useTransition } from "react";
+
+export interface SelectableProps {
+  /**
+   * list items
+   */
+  items: Array<{ label: string } & KeyValue>;
+  /**
+   * selected item ids
+   */
+  selected?: string[];
+  /**
+   * selected negative item ids
+   */
+  nonselected?: string[];
+  /**
+   * change callback
+   */
+  onChange?: (ids: string[], nonIds?: string[]) => void;
+  /**
+   * item click callback
+   */
+  onClick?: (id: string, isNegative: boolean) => void;
+}
+
+export const useSelectableList = ({
+  items,
+  selected,
+  nonselected,
+  onChange,
+  onClick,
+}: SelectableProps) => {
+  const selectionRef = useRef<KeyValue<number>>({});
+  const [selection, setSelection] = useState<KeyValue<number>>({});
+  const [, startTransition] = useTransition();
+  useEffect(() => {
+    selectionRef.current = items.reduce(
+      (ret, { id }) => ({
+        ...ret,
+        [id]: selected?.includes?.(id)
+          ? 1
+          : nonselected?.includes?.(id)
+            ? -1
+            : 0,
+      }),
+      {},
+    );
+    setSelection({ ...selectionRef.current });
+  }, [items, selected, nonselected]);
+
+  const toggleSelection = useCallback((id: string, isNegative = false) => {
+    const check = isNegative ? -1 : 1;
+    if (selectionRef.current[id] !== check) selectionRef.current[id] = check;
+    else if (selectionRef.current[id] === check) selectionRef.current[id] = 0;
+    const change: string[][] = [[], []];
+    Object.entries(selectionRef.current).forEach(([id, select]) =>
+      select === 1
+        ? change[0].push(id)
+        : select === -1
+          ? change[1].push(id)
+          : undefined,
+    );
+    setSelection({ ...selectionRef.current });
+    startTransition(() => {
+      onClick?.(id, isNegative);
+      onChange?.(change[0], change[1]);
+    });
+  }, []);
+
+  return { selection, toggleSelection };
+};

package/src/index.ts

@@ -23,11 +23,14 @@
 
 import "./i18n";
 
+export { CheckList } from "./checklist/CheckList";
 export { Histogram } from "./histogram/Histogram";
 export { JsonViewer } from "./json/JsonViewer";
 export { Pagination } from "./pagination/Pagination";
 export { Table } from "./table/Table";
+export { type TableColumn, type TableRef } from "./table/types";
 export { TreePanel } from "./tree/TreePanel";
+export { type TreeNodeType as TreeNode } from "./tree/types";
 export { VirtualGallery, type VirtualGalleryRef } from "./virtual/Gallery";
 export { VirtualList, type VirtualListRef } from "./virtual/List";
 

package/src/table/AddColumn.tsx

@@ -22,13 +22,13 @@
  */
 
 import { CoreIcons, Dropdown, Icon, Menu, MenuItem } from "@react-fabric/core";
-import { type ColumnType } from "./types";
+import { type TableColumn } from "./types";
 
 export const AddColumn = ({
   columns,
   onClick,
 }: {
-  columns: ColumnType[];
+  columns: TableColumn[];
   onClick: (id: string) => void;
 }) => {
   return (

package/src/table/BodyCell.tsx

@@ -21,6 +21,8 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import { DateDisplay } from "@react-fabric/date";
+import { Format, getByPath, isTrue } from "@react-fabric/utilities";
 import classNames from "classnames";
 import { useMemo } from "react";
 import { useTableContext } from "./Context";
@@ -28,15 +30,17 @@ import {
   COL_DEFAULT_WIDTH,
   COL_MAX_WIDTH,
   COL_MIN_WIDTH,
-  type ColumnType,
+  type TableColumn,
 } from "./types";
 
 export const BodyCell = ({
   column,
   item,
+  index,
 }: {
-  column: ColumnType;
+  column: TableColumn;
   item: KeyValue;
+  index: number;
 }) => {
   const { widths } = useTableContext();
 
@@ -45,6 +49,29 @@ export const BodyCell = ({
     [widths, column],
   );
 
+  const content = useMemo(() => {
+    const value = getByPath(item, column.id.toString());
+    if (column.renderer != null) {
+      return column.renderer(item[column.id], item, index);
+    }
+    if (column.dataType === "boolean") {
+      const map = column.valueMap ?? { true: "Yes", false: "no" };
+      return map[`${isTrue(value) ? "true" : "false"}`];
+    }
+    if (column.valueMap != null) {
+      if (column.dataType === "string" && value in column.valueMap) {
+        return column.valueMap[value];
+      }
+    }
+    if (column.dataType === "date") {
+      return <DateDisplay date={value} format={column.format} />;
+    }
+    if (column.dataType === "number") {
+      return Format.number(value, column.format);
+    }
+    return value ?? "";
+  }, [item, column]);
+
   return (
     <div
       className="overflow-hidden bg-inherit start-0"
@@ -61,7 +88,7 @@ export const BodyCell = ({
           column.align === "end" && "text-end",
         )}
       >
-        {column.renderer?.(item[column.id], item) ?? item[column.id]}
+        {content}
       </div>
     </div>
   );

package/src/table/BodyRow.tsx

@@ -0,0 +1,142 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import classNames from "classnames";
+import { BodyCell } from "./BodyCell";
+import { CheckboxCell } from "./CheckboxCell";
+import { type TableColumn } from "./types";
+import { CoreIcons, Icon } from "@react-fabric/core";
+
+export const BodyRow = ({
+  rowKey,
+  index,
+  data,
+  keyProperty,
+  measureElement,
+  state,
+  hideableColumns,
+  wrapperStart,
+  wrapperEnd,
+  onRowClick,
+  checkableRows,
+  checked,
+  toggleChecked,
+  canExpand,
+  expanded,
+  toggleExpand,
+  expandRow,
+}: {
+  rowKey: Key;
+  index: number;
+  data: KeyValue;
+  keyProperty?: Key;
+  measureElement: AnyObject;
+  state: KeyValue<TableColumn[]>;
+  hideableColumns?: boolean;
+  wrapperStart: string;
+  wrapperEnd: string;
+  checkableRows?: boolean;
+  checked: 0 | 1;
+  onRowClick?: AnyObject;
+  canExpand?: AnyObject;
+  expandRow?: AnyObject;
+  expanded: boolean;
+  toggleExpand: (key: Key) => void;
+  toggleChecked: (key: Key) => void;
+}) => {
+  return (
+    <div
+      ref={measureElement}
+      data-index={index}
+      className={index % 2 ? "bg-even" : "bg-odd"}
+    >
+      <div
+        role="none"
+        data-row={index}
+        className={classNames(
+          "flex flex-nowrap datatable-row data-[hilight]:outline-1 -outline-offset-1 outline-primary-500",
+          onRowClick && "hover:bg-primary-50 active:bg-primary-100",
+        )}
+        onClick={() =>
+          checkableRows && keyProperty && !onRowClick
+            ? toggleChecked(data[keyProperty])
+            : onRowClick?.(data)
+        }
+      >
+        <div className={wrapperStart}>
+          {!!canExpand && (
+            <div
+              className={classNames(
+                "group font-medium w-6 flex flex-nowrap text-start items-center",
+                !canExpand(data) && "pointer-events-none opacity-35",
+              )}
+            >
+              <Icon
+                className="p-1 text-tint-700 hover:text-primary-600"
+                icon={expanded ? CoreIcons.collapse : CoreIcons.expand}
+                onClick={(e) => [
+                  keyProperty && toggleExpand(data[keyProperty]),
+                  e.stopPropagation(),
+                ]}
+              />
+            </div>
+          )}
+          {checkableRows && keyProperty && (
+            <CheckboxCell
+              onClick={() => toggleChecked(data[keyProperty])}
+              state={checked}
+            />
+          )}
+          {state.start?.map((col, ids) => (
+            <BodyCell
+              key={`${String(rowKey)}:${ids}`}
+              column={col}
+              item={data}
+              index={ids}
+            />
+          ))}
+        </div>
+        {state.cols?.map((col, idc) => (
+          <BodyCell
+            key={`${String(rowKey)}:${idc}`}
+            column={col}
+            item={data}
+            index={idc}
+          />
+        ))}
+        <div className={wrapperEnd}>
+          {state.end?.map((col, ide) => (
+            <BodyCell
+              key={`${String(rowKey)}:${ide}`}
+              column={col}
+              item={data}
+              index={ide}
+            />
+          ))}
+          {hideableColumns && <div className="w-6" />}
+        </div>
+      </div>
+      {expanded && expandRow(data)}
+    </div>
+  );
+};

package/src/table/EmptyCell.tsx

@@ -27,7 +27,7 @@ import {
   COL_DEFAULT_WIDTH,
   COL_MAX_WIDTH,
   COL_MIN_WIDTH,
-  type ColumnType,
+  type TableColumn,
 } from "./types";
 
 export const EmptyCell = ({
@@ -35,7 +35,7 @@ export const EmptyCell = ({
   width: _width,
   maxWidth,
   minWidth,
-}: ColumnType) => {
+}: TableColumn) => {
   const { widths } = useTableContext();
 
   const width = useMemo(

package/src/table/HeaderCell.tsx

@@ -35,7 +35,7 @@ import {
   COL_DEFAULT_WIDTH,
   COL_MAX_WIDTH,
   COL_MIN_WIDTH,
-  type ColumnType,
+  type TableColumn,
   type TableProps,
 } from "./types";
 
@@ -48,6 +48,7 @@ export const HeaderCell = ({
   rtlFlip,
   actions,
   locked,
+  tooltip,
   sortable,
   resizable,
   width: _width,
@@ -55,7 +56,7 @@ export const HeaderCell = ({
   minWidth,
   sort,
   onSort,
-}: ColumnType & Pick<TableProps, "sort" | "onSort">) => {
+}: TableColumn & Pick<TableProps, "sort" | "onSort">) => {
   const { startResize, widths } = useTableContext();
 
   const width = useMemo(
@@ -102,7 +103,7 @@ export const HeaderCell = ({
         maxWidth: maxWidth ?? COL_MAX_WIDTH,
       }}
     >
-      <Tooltip content={label} disabled={!label}>
+      <Tooltip content={tooltip ?? label} disabled={!(tooltip ?? label)}>
         <div className="flex-initial px-2 py-1 text-sm truncate sticky start-0">
           {icon && (
             <Icon icon={icon} bg={iconBg} color={iconColor} rtlFlip={rtlFlip} />

package/src/table/Table.tsx

@@ -22,11 +22,17 @@
  */
 
 import { EmptyContent, Loading, useDebounce } from "@react-fabric/core";
-import classNames from "classnames";
-import { useMemo } 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";
@@ -36,14 +42,20 @@ import { useTableColumns } from "./useTableColumns";
 import { useVirtualTable } from "./useVirtualTable";
 
 export const Table = <T extends KeyValue = KeyValue>({
+  ref,
   data,
   columns,
   keyProperty,
   checkableRows,
+  initialScroll,
   hideableColumns,
   sort,
   loading,
+  emptyDisplay,
+  canExpand,
+  children,
   onSort,
+  onScroll,
   onRowClick,
   onCheckedChanged,
 }: TableProps<T>) => {
@@ -57,13 +69,17 @@ export const Table = <T extends KeyValue = KeyValue>({
   const {
     scrollerRef,
     items,
+    top,
     checkState,
+    virtualizer,
+    toggleExpand,
     toggleChecked,
     toggleAllChecked,
     getData,
     totalSize,
     measureElement,
   } = useVirtualTable(data, keyProperty, fireCheckChanged);
+  const refBody = useRef<HTMLDivElement>(null);
 
   const wrapperStart = useMemo(
     () => "bg-inherit sticky start-0 flex flex-nowrap z-1",
@@ -74,6 +90,51 @@ export const Table = <T extends KeyValue = KeyValue>({
     [],
   );
 
+  useLayoutEffect(() => {
+    setTimeout(() => {
+      initialScroll &&
+        virtualizer.scrollToIndex(initialScroll, { align: "start" });
+    }, 100);
+  }, []);
+
+  useImperativeHandle(
+    ref,
+    () => ({
+      scrollTo: (row: number) => {
+        virtualizer.scrollToIndex(row, { align: "start" });
+      },
+      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);
+      },
+      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
@@ -85,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}
@@ -116,62 +178,45 @@ export const Table = <T extends KeyValue = KeyValue>({
           <div
             className="area-content flex flex-col flex-nowrap"
             style={{ height: totalSize() }}
+            ref={refBody}
           >
             <div style={{ height: items[0]?.start }} />
             {items.map(({ index, key }) => {
               const data = getData(index);
               return (
-                <div
-                  key={key}
-                  role="none"
-                  className={classNames(
-                    "flex flex-nowrap",
-                    index % 2 ? "bg-even" : "bg-odd",
-                    onRowClick && "hover:bg-primary-50 active:bg-primary-100",
-                  )}
-                  onClick={() =>
-                    checkableRows && !onRowClick
-                      ? toggleChecked(data[keyProperty])
-                      : onRowClick?.(data)
+                <BodyRow
+                  rowKey={key}
+                  index={index}
+                  checkableRows={checkableRows}
+                  checked={
+                    keyProperty &&
+                    checkState.checked.includes(data[keyProperty])
+                      ? 1
+                      : 0
+                  }
+                  expanded={
+                    !!keyProperty &&
+                    checkState.expanded.includes(data[keyProperty])
                   }
-                  data-index={index}
-                  ref={measureElement}
-                >
-                  <div className={wrapperStart}>
-                    {checkableRows && (
-                      <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>
+                  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} />
@@ -190,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>
   );