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

package/src/pagination/Pagination.tsx

@@ -48,6 +48,16 @@ export interface PaginationProps {
   onPageChange: (page: number) => void;
 }
 
+/**
+ * Pagination component to navigate through pages of data.
+ * It displays buttons for navigating to the first, previous, next, and last pages,
+ * as well as buttons for specific page numbers based on the provided ranges.
+ * The component supports a minimal view that shows the current page and total pages.
+ * It uses memoization to optimize rendering performance.
+ *
+ * @param {PaginationProps} props - The properties for the Pagination component.
+ * @returns {JSX.Element} The rendered Pagination component.
+ */
 export const Pagination = memo(
   ({ page, ranges, totalPages, minimal, onPageChange }: PaginationProps) => {
     const [start, mid, last] = ranges;

package/src/table/AddColumn.tsx

@@ -22,17 +22,17 @@
  */
 
 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 (
-    <div className="group font-medium w-6 flex flex-nowrap text-start items-end">
+    <div className="group font-medium w-6 flex flex-nowrap text-start items-center">
       <Dropdown placement="bottom-end">
         <Icon
           icon={CoreIcons.insert}

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,9 +49,32 @@ export const BodyCell = ({
     [widths, column],
   );
 
+  const content = useMemo(() => {
+    const value = getByPath(item, column.id.toString());
+    if (column.renderer != null) {
+      return column.renderer(value, 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 (["date", "time", "datetime"].includes(column.dataType ?? "")) {
+      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"
+      className="overflow-hidden bg-inherit start-0 border-e group/table-col"
       style={{
         width: width ?? COL_DEFAULT_WIDTH,
         minWidth: column.minWidth ?? COL_MIN_WIDTH,
@@ -56,12 +83,14 @@ export const BodyCell = ({
     >
       <div
         className={classNames(
-          "px-2 py-1 border-e truncate",
+          "px-2 py-1",
+          column.className,
+          column.truncate && "truncate",
           column.align === "center" && "text-center",
           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,143 @@
+/*
+ * 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 group/table-row",
+          onRowClick && "hover:bg-primary-50 active:bg-primary-100",
+          index % 2 ? "bg-even" : "bg-odd",
+        )}
+        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 py-1",
+                !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/CheckboxCell.tsx

@@ -31,7 +31,7 @@ export const CheckboxCell = ({
   onClick?: () => void;
 }) => {
   return (
-    <div className="group font-medium border-e w-6 flex flex-nowrap text-start items-center">
+    <div className="group font-medium border-e w-6 flex flex-nowrap text-start py-1">
       <Icon
         icon={
           state === 2

package/src/table/ColumnFilters.tsx

@@ -0,0 +1,105 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2025 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 { Button, DropdownDismiss } from "@react-fabric/core";
+import { Checkbox, Input, Search } from "@react-fabric/form";
+import { EMPTY_ARRAY, matchString } from "@react-fabric/utilities";
+import { useState } from "react";
+import { useFilteredList } from "../hooks/useFilteredList";
+import { type TableColumn } from "./types";
+
+interface FilterProps {
+  type: TableColumn["dataType"];
+  onFilter: (value: AnyObject) => void;
+  list?: AnyObject[];
+  filter: AnyObject;
+}
+
+const ListFilter = ({
+  list = EMPTY_ARRAY,
+  filter,
+  onFilter,
+}: Partial<FilterProps>) => {
+  const [selected, setSelected] = useState<Set<string>>(new Set(filter));
+
+  const { filteredList, query, onSearch } = useFilteredList(
+    list,
+    (item, query) => {
+      return matchString(item.id ?? item, query);
+    },
+  );
+
+  return (
+    <div className="flex flex-col">
+      <div>
+        <Search autoFocus value={query} onSearch={onSearch} searchOnChange />
+      </div>
+      <div className="flex-1 overflow-auto scroll-thin">
+        {filteredList.map((v, idx) => (
+          <div key={idx} className="flex gap-x-1 text-xs items-center">
+            <Checkbox
+              checked={selected.has(v.id ?? v)}
+              onChange={(b) => {
+                const set = new Set(Array.from(selected.values()));
+                b ? set.add(v.id ?? v) : set.delete(v.id ?? v);
+                setSelected(set);
+              }}
+              label={<span className="truncate">{v.label ?? v}</span>}
+            />
+          </div>
+        ))}
+        {filteredList.length === 0 && (
+          <span className="text-muted text-xs">No items found</span>
+        )}
+      </div>
+      <div className="flex justify-end">
+        <DropdownDismiss>
+          <Button size="xs" onClick={() => onFilter?.(Array.from(selected))}>
+            Apply
+          </Button>
+        </DropdownDismiss>
+      </div>
+    </div>
+  );
+};
+
+export const ColumnFilters = ({
+  type,
+  list,
+  filter,
+  onFilter,
+}: FilterProps) => {
+  return (
+    <div className="flex flex-col min-w-[16rem]">
+      {list && <ListFilter list={list} filter={filter} onFilter={onFilter} />}
+      {!list && type === "string" && (
+        <Input
+          autoFocus
+          allowClear
+          value={filter}
+          onEnterPressed={(e: AnyObject) => onFilter(e.target.value ?? "")}
+        />
+      )}
+    </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

@@ -22,25 +22,30 @@
  */
 
 import {
+  Button,
   CoreIcons,
+  Divider,
   DropdownTool,
   Icon,
   Menu,
   MenuItem,
   Tooltip,
 } from "@react-fabric/core";
+import { isEmpty } from "@react-fabric/utilities";
 import { useCallback, useMemo } from "react";
+import { ColumnFilters } from "./ColumnFilters";
 import { useTableContext } from "./Context";
 import {
   COL_DEFAULT_WIDTH,
   COL_MAX_WIDTH,
   COL_MIN_WIDTH,
-  type ColumnType,
+  type TableColumn,
   type TableProps,
 } from "./types";
 
 export const HeaderCell = ({
   id,
+  dataType,
   label,
   icon,
   iconBg,
@@ -48,6 +53,10 @@ export const HeaderCell = ({
   rtlFlip,
   actions,
   locked,
+  filter,
+  filterable,
+  filterOptions,
+  tooltip,
   sortable,
   resizable,
   width: _width,
@@ -55,7 +64,8 @@ export const HeaderCell = ({
   minWidth,
   sort,
   onSort,
-}: ColumnType & Pick<TableProps, "sort" | "onSort">) => {
+  onFilter,
+}: TableColumn & Pick<TableProps, "sort" | "onSort" | "onFilter">) => {
   const { startResize, widths } = useTableContext();
 
   const width = useMemo(
@@ -63,46 +73,84 @@ export const HeaderCell = ({
     [widths, _width, id],
   );
 
-  const handleSort = useCallback(() => {
-    sortable &&
-      onSort?.({
-        id: id.toString(),
-        order: sort?.id === id && sort.order === "asc" ? "desc" : "asc",
-      });
-  }, [onSort, name, sort, sortable]);
+  const handleSort = useCallback(
+    (order?: "asc" | "desc") => {
+      sortable &&
+        onSort?.({
+          id: id.toString(),
+          order:
+            order ?? (sort?.id === id && sort.order === "asc" ? "desc" : "asc"),
+        });
+    },
+    [onSort, sort, sortable],
+  );
 
   const menus = useMemo(() => {
-    const ret = [];
+    let ret = [];
+    if (filterable && (dataType ?? filterOptions)) {
+      ret.push(
+        <Menu
+          key="filters"
+          label="Filter"
+          icon={filter ? CoreIcons.tick : ""}
+          trigger="click"
+        >
+          <ColumnFilters
+            type={dataType}
+            list={filterOptions}
+            filter={filter}
+            onFilter={(value) => onFilter?.(id, value)}
+          />
+        </Menu>,
+      );
+    }
     if (sortable) {
       ret.push(
         <MenuItem
           key="sort-asc"
           label="Sort ascending"
           icon={CoreIcons.sortAsc}
+          onClick={() => handleSort("asc")}
         />,
         <MenuItem
           key="sort-desc"
           label="Sort descending"
           icon={CoreIcons.sortDesc}
+          onClick={() => handleSort("desc")}
         />,
       );
     }
+    if (actions) {
+      ret.push(<Divider key="div" />);
+      ret.push(...actions);
+    }
+    if (ret.length === 1) {
+      ret = [
+        <ColumnFilters
+          key="filters"
+          type={dataType}
+          list={filterOptions}
+          filter={filter}
+          onFilter={(value) => onFilter?.(id, value)}
+        />,
+      ];
+    }
     return ret;
-  }, [sortable]);
+  }, [sortable, actions, onFilter, handleSort]);
 
   return (
     <div
       role="none"
       data-id={id}
-      onClick={handleSort}
-      className="group font-medium border-e flex flex-nowrap text-start items-center table-header-cell"
+      onClick={() => handleSort()}
+      className="group/tool font-medium border-e flex flex-nowrap text-start items-center table-header-cell"
       style={{
         width: width ?? COL_DEFAULT_WIDTH,
         minWidth: minWidth ?? COL_MIN_WIDTH,
         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} />
@@ -122,6 +170,16 @@ export const HeaderCell = ({
           <Menu className="text-sm">{menus}</Menu>
         </DropdownTool>
       )}
+      {filterable && !isEmpty(filter) && (
+        <Button
+          size="sm"
+          variant="link"
+          aria-label="clear filter"
+          stopPropagation
+          icon={CoreIcons.funnelRemove}
+          onClick={() => onFilter?.(id)}
+        />
+      )}
       {resizable && (
         <div
           role="none"