@trackunit/react-table 0.0.209 → 0.0.211

package/index.cjs.js

@@ -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

@@ -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.211",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

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;