@trackunit/react-table 0.0.209 → 0.0.210-alpha-2c211422d9.0

package/index.cjs.js

@@ -405,9 +405,9 @@ const cvaColumnFilterGrabbable = cssClassVarianceUtilities.cvaMerge(["flex", "it
 /**
  * ColumnFilter component for managing visibility and order of table columns.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {IColumnFilterProps<T, V>} props - The props object containing necessary properties.
+ * @template TColumnFilter - The type representing the data model associated with the columns.
+ * @template TColumnFilterValue - The type representing the value of columns.
+ * @param {ColumnFilterProps<TColumnFilter, TColumnFilterValue>} props - The props object containing necessary properties.
  * @returns {JSX.Element | null} A React JSX element representing the ColumnFilter component or null if columns are not provided.
  */
 const ColumnFilter = ({ columns, setColumnOrder, defaultColumnOrder, columnOrder, onUserEvent, }) => {
@@ -558,12 +558,12 @@ const CompactIcon = () => {
 /**
  * Sorting component for managing table column sorting.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {SortingProps<T, V>} props - The props object containing sorting properties.
+ * @template TSorting - The type representing the data model associated with the columns.
+ * @template TSortingValue - The type representing the value of columns.
+ * @param {SortingProps<TSorting, TSortingValue>} props - The props object containing sorting properties.
  * @returns {JSX.Element | null} A React JSX element representing the Sorting component or null if there are no sortable columns.
  */
-const Sorting = ({ columns }) => {
+const Sorting = ({ columns, }) => {
     var _a, _b;
     const [t] = useTranslation();
     const sortableColumns = columns.filter(column => column.getCanSort());
@@ -601,7 +601,7 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
     const nextPage = React.useCallback(() => {
         if (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.hasNextPage) {
             setVariables({
-                after: (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.endCursor) === null ? undefined : pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.endCursor,
+                after: pageInfo.endCursor === null ? undefined : pageInfo.endCursor,
                 first: props.pageSize,
             });
         }
@@ -609,7 +609,7 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
     const previousPage = React.useCallback(() => {
         if (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.hasPreviousPage) {
             setVariables({
-                before: (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.startCursor) === null ? undefined : pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.startCursor,
+                before: pageInfo.startCursor === null ? undefined : pageInfo.startCursor,
                 last: props.pageSize,
             });
         }
@@ -624,8 +624,9 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
         if (props.onReset) {
             props.onReset();
         }
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [props.onReset, props.pageSize]);
-    const pagination = React.useMemo(() => {
+    return React.useMemo(() => {
         return {
             variables,
             table: {
@@ -639,7 +640,6 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
             },
         };
     }, [variables, nextPage, previousPage, isLoading, reset, pageInfo]);
-    return pagination;
 };
 
 /**
@@ -745,7 +745,7 @@ const useTable = (_a) => {
  *     columns,
  * });
  */
-const useTableSelection = ({ data, defaultSelectedIds, }) => {
+const useTableSelection = ({ data, defaultSelectedIds, enableRowSelection = true, }) => {
     const [rowSelection, setRowSelection] = React.useState({});
     React.useEffect(() => {
         const initialSelection = {};
@@ -786,8 +786,8 @@ const useTableSelection = ({ data, defaultSelectedIds, }) => {
     const selectionTableProps = React.useMemo(() => ({
         onRowSelectionChange: setRowSelection,
         getRowId: row => row.id,
-        enableRowSelection: true,
-    }), []);
+        enableRowSelection,
+    }), [enableRowSelection]);
     return React.useMemo(() => ({
         toggleRowSelectionState,
         selectionColumn,

package/index.esm.js

@@ -380,9 +380,9 @@ const cvaColumnFilterGrabbable = cvaMerge(["flex", "items-center", "justify-cent
 /**
  * ColumnFilter component for managing visibility and order of table columns.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {IColumnFilterProps<T, V>} props - The props object containing necessary properties.
+ * @template TColumnFilter - The type representing the data model associated with the columns.
+ * @template TColumnFilterValue - The type representing the value of columns.
+ * @param {ColumnFilterProps<TColumnFilter, TColumnFilterValue>} props - The props object containing necessary properties.
  * @returns {JSX.Element | null} A React JSX element representing the ColumnFilter component or null if columns are not provided.
  */
 const ColumnFilter = ({ columns, setColumnOrder, defaultColumnOrder, columnOrder, onUserEvent, }) => {
@@ -533,12 +533,12 @@ const CompactIcon = () => {
 /**
  * Sorting component for managing table column sorting.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {SortingProps<T, V>} props - The props object containing sorting properties.
+ * @template TSorting - The type representing the data model associated with the columns.
+ * @template TSortingValue - The type representing the value of columns.
+ * @param {SortingProps<TSorting, TSortingValue>} props - The props object containing sorting properties.
  * @returns {JSX.Element | null} A React JSX element representing the Sorting component or null if there are no sortable columns.
  */
-const Sorting = ({ columns }) => {
+const Sorting = ({ columns, }) => {
     var _a, _b;
     const [t] = useTranslation();
     const sortableColumns = columns.filter(column => column.getCanSort());
@@ -576,7 +576,7 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
     const nextPage = useCallback(() => {
         if (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.hasNextPage) {
             setVariables({
-                after: (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.endCursor) === null ? undefined : pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.endCursor,
+                after: pageInfo.endCursor === null ? undefined : pageInfo.endCursor,
                 first: props.pageSize,
             });
         }
@@ -584,7 +584,7 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
     const previousPage = useCallback(() => {
         if (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.hasPreviousPage) {
             setVariables({
-                before: (pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.startCursor) === null ? undefined : pageInfo === null || pageInfo === void 0 ? void 0 : pageInfo.startCursor,
+                before: pageInfo.startCursor === null ? undefined : pageInfo.startCursor,
                 last: props.pageSize,
             });
         }
@@ -599,8 +599,9 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
         if (props.onReset) {
             props.onReset();
         }
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [props.onReset, props.pageSize]);
-    const pagination = useMemo(() => {
+    return useMemo(() => {
         return {
             variables,
             table: {
@@ -614,7 +615,6 @@ const useRelayPagination = (props = { pageSize: 50 }) => {
             },
         };
     }, [variables, nextPage, previousPage, isLoading, reset, pageInfo]);
-    return pagination;
 };
 
 /**
@@ -720,7 +720,7 @@ const useTable = (_a) => {
  *     columns,
  * });
  */
-const useTableSelection = ({ data, defaultSelectedIds, }) => {
+const useTableSelection = ({ data, defaultSelectedIds, enableRowSelection = true, }) => {
     const [rowSelection, setRowSelection] = useState({});
     useEffect(() => {
         const initialSelection = {};
@@ -761,8 +761,8 @@ const useTableSelection = ({ data, defaultSelectedIds, }) => {
     const selectionTableProps = useMemo(() => ({
         onRowSelectionChange: setRowSelection,
         getRowId: row => row.id,
-        enableRowSelection: true,
-    }), []);
+        enableRowSelection,
+    }), [enableRowSelection]);
     return useMemo(() => ({
         toggleRowSelectionState,
         selectionColumn,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-table",
-  "version": "0.0.209",
+  "version": "0.0.210-alpha-2c211422d9.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/menus/ColumnFilter.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { Column, ColumnOrderState, Updater } from "@tanstack/react-table";
-export interface IColumnFilterProps<T extends object, V> {
-    columns: Column<T, V>[];
+export interface ColumnFilterProps<TColumnFilter extends object, TColumnFilterValue> {
+    columns: Column<TColumnFilter, TColumnFilterValue>[];
     defaultColumnOrder: ColumnOrderState;
     columnOrder?: ColumnOrderState;
     className?: string;
@@ -11,14 +11,14 @@ export interface IColumnFilterProps<T extends object, V> {
 /**
  * ColumnFilter component for managing visibility and order of table columns.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {IColumnFilterProps<T, V>} props - The props object containing necessary properties.
+ * @template TColumnFilter - The type representing the data model associated with the columns.
+ * @template TColumnFilterValue - The type representing the value of columns.
+ * @param {ColumnFilterProps<TColumnFilter, TColumnFilterValue>} props - The props object containing necessary properties.
  * @returns {JSX.Element | null} A React JSX element representing the ColumnFilter component or null if columns are not provided.
  */
-export declare const ColumnFilter: <T extends Object, V>({ columns, setColumnOrder, defaultColumnOrder, columnOrder, onUserEvent, }: IColumnFilterProps<T, V>) => JSX.Element | null;
-export interface ColumnFiltersDragAndDropProps<T extends object, V> {
-    columns: Column<T, V>[];
+export declare const ColumnFilter: <TColumnFilter extends Object, TColumnFilterValue>({ columns, setColumnOrder, defaultColumnOrder, columnOrder, onUserEvent, }: ColumnFilterProps<TColumnFilter, TColumnFilterValue>) => JSX.Element | null;
+export interface ColumnFiltersDragAndDropProps<TColumnFiltersDragAndDrop extends object, TColumnFiltersDragAndDropValue> {
+    columns: Column<TColumnFiltersDragAndDrop, TColumnFiltersDragAndDropValue>[];
     setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
     onUserEvent?: (event: "Column Reordering" | "Column Filter", payload: Record<string, unknown>) => void;
 }

package/src/menus/Sorting.d.ts

@@ -1,15 +1,15 @@
 /// <reference types="react" />
 import { Column } from "@tanstack/react-table";
-interface SortingProps<T extends object, V> {
-    columns: Column<T, V>[];
+interface SortingProps<TSorting extends object, TSortingValue> {
+    columns: Column<TSorting, TSortingValue>[];
 }
 /**
  * Sorting component for managing table column sorting.
  *
- * @template T - The type representing the data model associated with the columns.
- * @template V - The type representing the value of columns.
- * @param {SortingProps<T, V>} props - The props object containing sorting properties.
+ * @template TSorting - The type representing the data model associated with the columns.
+ * @template TSortingValue - The type representing the value of columns.
+ * @param {SortingProps<TSorting, TSortingValue>} props - The props object containing sorting properties.
  * @returns {JSX.Element | null} A React JSX element representing the Sorting component or null if there are no sortable columns.
  */
-export declare const Sorting: <T extends Object, V>({ columns }: SortingProps<T, V>) => JSX.Element | null;
+export declare const Sorting: <TSorting extends Object, TSortingValue>({ columns, }: SortingProps<TSorting, TSortingValue>) => JSX.Element | null;
 export {};

package/src/useTableSelection.d.ts

@@ -1,6 +1,6 @@
 import { ColumnDef, RowSelectionState } from "@tanstack/react-table";
 import { Dispatch, SetStateAction } from "react";
-type selectableTableData = {
+export type selectableTableData = {
     id: string;
 } & object;
 export interface TableSelectionReturn<TData extends selectableTableData> {
@@ -21,7 +21,7 @@ export interface TableSelectionReturn<TData extends selectableTableData> {
     selectionTableProps: {
         onRowSelectionChange: Dispatch<SetStateAction<RowSelectionState>>;
         getRowId: (row: TData) => TData["id"];
-        enableRowSelection: true;
+        enableRowSelection: boolean;
     };
     /**
      * A function to update the row selection state.
@@ -39,8 +39,22 @@ export interface TableSelectionReturn<TData extends selectableTableData> {
     toggleRowSelectionState: (id: TData["id"]) => void;
 }
 export interface TableSelectionProps<TData extends selectableTableData> {
+    /**
+     * The data that is displayed in the table.
+     * This must have an `id` field, to enable selection.
+     * The same data should be passed to the `data` prop of the `useTable` Hook.
+     */
     data: TData[];
+    /**
+     * An array of ids of the rows that should be selected by default.
+     * This is useful when you want to preselect rows, for example when editing an existing entity.
+     */
     defaultSelectedIds?: TData["id"][];
+    /**
+     * Whether or not to enable row selection.
+     * If set to `false`, the selection column will still be displayed, but the checkboxes will be disabled.
+     */
+    enableRowSelection?: boolean;
 }
 /**
  * `useTableSelection` is a custom hook that provides functionality for row selection in a table.
@@ -69,5 +83,4 @@ export interface TableSelectionProps<TData extends selectableTableData> {
  *     columns,
  * });
  */
-export declare const useTableSelection: <TData extends selectableTableData>({ data, defaultSelectedIds, }: TableSelectionProps<TData>) => TableSelectionReturn<TData>;
-export {};
+export declare const useTableSelection: <TData extends selectableTableData>({ data, defaultSelectedIds, enableRowSelection, }: TableSelectionProps<TData>) => TableSelectionReturn<TData>;

package/src/useTableSelection.demo.d.ts

@@ -0,0 +1,11 @@
+import { TableSelectionProps, selectableTableData } from "./useTableSelection";
+export interface UseTableSelectionDemoComponentProps<TData extends selectableTableData> extends TableSelectionProps<TData> {
+}
+/**
+ * The `useTableSelection` Hook provides functionality for row selection in a table.
+ *
+ * It returns an object containing methods and values related to row selection.
+ *
+ * It Also returns a `selectionColumn` object that can be used as a column definition in a table.
+ */
+export declare const UseTableSelectionDemoComponent: <TData extends selectableTableData>(props: UseTableSelectionDemoComponentProps<TData>) => JSX.Element;