@pk-design/react-tailwind 1.5.0 → 1.5.2

package/dist/types/components/DataTable/DataTable.d.ts

@@ -1,5 +1,5 @@
 import type { DataTableProps } from './DataTable.types';
-export declare function DataTable<T extends Record<string, any> = Record<string, any>>({ items, columns, sorting, onSort, loading, pagination, setPagination, emptyMessage, containerClass, wrapperClass, tableClass, headClass, footerRow, rowKey, onRowClick, rowClass, density, striped, layout, }: DataTableProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function DataTable<T extends Record<string, any> = Record<string, any>>({ items, columns, sorting, onSort, loading, pagination, setPagination, emptyMessage, containerClass, wrapperClass, tableClass, headClass, footerRow, rowKey, onRowClick, rowClass, density, striped, layout, selectable, selectedRowKeys, defaultSelectedRowKeys, onSelectionChange, isRowSelectable, }: DataTableProps<T>): import("react/jsx-runtime").JSX.Element;
 export declare namespace DataTable {
     var displayName: string;
 }

package/dist/types/components/DataTable/DataTable.types.d.ts

@@ -112,4 +112,20 @@ export interface DataTableProps<T = any> {
     tableClass?: string;
     /** Optional classes applied to the `<thead>` element */
     headClass?: string;
+    /**
+     * Renders a leading checkbox column so rows can be selected.
+     * @default false
+     */
+    selectable?: boolean;
+    /** Controlled selected row keys — pair with `onSelectionChange`. */
+    selectedRowKeys?: Array<string | number>;
+    /** Initially selected row keys (uncontrolled). */
+    defaultSelectedRowKeys?: Array<string | number>;
+    /** Called with the new selected row keys and their matching items whenever selection changes. */
+    onSelectionChange?: (selectedRowKeys: Array<string | number>, selectedItems: T[]) => void;
+    /**
+     * Marks specific rows as ineligible for selection — their checkbox is
+     * disabled and they're excluded from "select all".
+     */
+    isRowSelectable?: (item: T) => boolean;
 }

package/dist/types/components/DataTable/DataTable.utils.d.ts

@@ -10,3 +10,24 @@ export declare const nextSortDirection: (prev: Sorting | undefined, type?: "stri
  * Toggles sort direction, removing key when reset.
  */
 export declare const updateSortQuery: (sortQuery: SortQuery, name: string, type?: DataValueType) => SortQuery;
+/** Options for {@link useRowSelection}. */
+export interface UseRowSelectionOptions<T> {
+    items: T[];
+    getKey: (item: T, idx: number) => string | number;
+    selectedRowKeys?: Array<string | number>;
+    defaultSelectedRowKeys?: Array<string | number>;
+    onSelectionChange?: (selectedRowKeys: Array<string | number>, selectedItems: T[]) => void;
+    isRowSelectable?: (item: T) => boolean;
+}
+/**
+ * Shared row-selection state/behaviour used by DataTable and VirtualizedDataTable.
+ * Supports controlled (`selectedRowKeys`) and uncontrolled (`defaultSelectedRowKeys`) usage.
+ */
+export declare const useRowSelection: <T>({ items, getKey, selectedRowKeys, defaultSelectedRowKeys, onSelectionChange, isRowSelectable, }: UseRowSelectionOptions<T>) => {
+    selectedKeys: (string | number)[];
+    isSelected: (key: string | number) => boolean;
+    toggleRow: (key: string | number) => void;
+    toggleAll: () => void;
+    allSelected: boolean;
+    someSelected: boolean;
+};

package/dist/types/components/VirtualizedDataTable/VirtualizedDataTable.d.ts

@@ -1,2 +1,2 @@
 import type { VirtualizedDataTableProps } from './VirtualizedDataTable.types';
-export declare function VirtualizedDataTable<T extends Record<string, any> = Record<string, any>>({ items, columns, sorting, onSort, loading, emptyMessage, containerClass, wrapperClass, onRowClick, rowClass, density, striped, rowHeight, maxHeight, overscanCount, }: VirtualizedDataTableProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function VirtualizedDataTable<T extends Record<string, any> = Record<string, any>>({ items, columns, sorting, onSort, loading, emptyMessage, containerClass, wrapperClass, onRowClick, rowClass, density, striped, rowHeight, maxHeight, overscanCount, rowKey, selectable, selectedRowKeys, defaultSelectedRowKeys, onSelectionChange, isRowSelectable, }: VirtualizedDataTableProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/VirtualizedDataTable/VirtualizedDataTable.types.d.ts

@@ -1,9 +1,9 @@
 import type { DataTableColumn, DataTableDensity, DataTableProps } from '../DataTable';
 /**
  * Props shared with DataTable but not applicable to virtualized tables are omitted:
- * pagination, setPagination, layout, footerRow, rowKey, tableClass, headClass.
+ * pagination, setPagination, layout, footerRow, tableClass, headClass.
  */
-type VirtualizedBase<T = any> = Omit<DataTableProps<T>, 'pagination' | 'setPagination' | 'layout' | 'footerRow' | 'rowKey' | 'tableClass' | 'headClass'>;
+type VirtualizedBase<T = any> = Omit<DataTableProps<T>, 'pagination' | 'setPagination' | 'layout' | 'footerRow' | 'tableClass' | 'headClass'>;
 /**
  * Props for VirtualizedDataTable.
  * @template T Shape of each data row
@@ -38,5 +38,10 @@ export type VirtualizedRowProps = {
     rowClass?: string | ((item: any, index: number) => string);
     density?: DataTableDensity;
     striped?: boolean;
+    selectable?: boolean;
+    getKey?: (item: any, index: number) => string | number;
+    isSelected?: (key: string | number) => boolean;
+    toggleRow?: (key: string | number) => void;
+    isRowSelectable?: (item: any) => boolean;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pk-design/react-tailwind",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "main": "dist/react-tailwind.cjs.js",
   "module": "dist/react-tailwind.es.js",
   "types": "dist/types/index.d.ts",