@canonical/maas-react-components 1.35.0 → 2.0.0

package/dist/src/lib/components/GenericTable/GenericTable.d.ts

@@ -1,12 +1,19 @@
-import { Dispatch, ReactElement, ReactNode, RefObject, SetStateAction, DetailedHTMLProps, HTMLAttributes } from 'react';
+import { DetailedHTMLProps, Dispatch, HTMLAttributes, ReactElement, ReactNode, RefObject, SetStateAction } from 'react';
 import { Column, ColumnDef, ColumnSort, Header, Row, RowSelectionState, SortingState } from '@tanstack/react-table';
 import { PaginationBarProps } from './PaginationBar';
+type SelectionProps<T extends {
+    id: number | string;
+}> = {
+    filterSelectable?: (row: Row<T>) => boolean;
+    disabledSelectionTooltip?: string | ((row: Row<T>) => string);
+    rowSelectionLabelKey?: keyof T;
+    rowSelection?: RowSelectionState;
+    setRowSelection?: Dispatch<SetStateAction<RowSelectionState>>;
+};
 type GenericTableProps<T extends {
     id: number | string;
 }> = {
     className?: string;
-    canSelect?: boolean | ((row: Row<T>) => boolean);
-    disabledSelectionTooltip?: string | ((row: Row<T>) => string);
     columns: ColumnDef<T, Partial<T>>[];
     containerRef?: RefObject<HTMLElement | null>;
     data: T[];
@@ -22,9 +29,8 @@ type GenericTableProps<T extends {
         isTop: boolean;
     }[];
     sorting?: ColumnSort[];
+    selection?: SelectionProps<T>;
     setSorting?: Dispatch<SetStateAction<SortingState>>;
-    rowSelection?: RowSelectionState;
-    setRowSelection?: Dispatch<SetStateAction<RowSelectionState>>;
     showChevron?: boolean;
     variant?: "full-height" | "regular";
 } & DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
@@ -39,8 +45,6 @@ type GenericTableProps<T extends {
  *
  * @param {Object} props - Component props
  * @param {string} [props.className] - Additional CSS class for the table wrapper
- * @param {boolean | ((row: Row<T>) => boolean)} [props.canSelect=false] - Enable row selection with checkboxes
- * @param {string | ((row: Row<T>) => string)} [props.disabledSelectionTooltip] - Tooltip message or constructor on disabled checkboxes
  * @param {ColumnDef<T, Partial<T>>[]} props.columns - Column definitions
  * @param {RefObject<HTMLElement | null>} [props.containerRef] - Reference to container for size calculations
  * @param {T[]} props.data - Table data array
@@ -54,8 +58,12 @@ type GenericTableProps<T extends {
  * @param {{ value: string; isTop: boolean }[]} [props.pinGroup] - Group pinning configuration
  * @param {ColumnSort[]} [props.sorting] - Initial sort configuration
  * @param {Dispatch<SetStateAction<SortingState>>} [props.setSorting] - Sorting state setter
- * @param {RowSelectionState} [props.rowSelection] - Selected rows state
- * @param {Dispatch<SetStateAction<RowSelectionState>>} [props.setRowSelection] - Selection state setter
+ * @param {SelectionProps} [props.selection] - Selection configuration
+ * @param {((row: Row<T>) => boolean)} [props.selection.filterSelectable] - Function to filter which rows should be selectable
+ * @param {string | ((row: Row<T>) => string)} [props.selection.disabledSelectionTooltip] - Tooltip message or constructor on disabled checkboxes
+ * @param {RowSelectionState} [props.selection.rowSelection] - Selected rows state
+ * @param {keyof T} [props.selection.rowSelectionLabelKey] - Key of T to use as aria-labels for row checkboxes (e.g. "select {keyof T}")
+ * @param {Dispatch<SetStateAction<RowSelectionState>>} [props.selection.setRowSelection] - Selection state setter
  * @param {boolean} [props.showChevron=false] - Show group row expansion state chevrons
  * @param {"full-height" | "regular"} [props.variant="full-height"] - Table layout variant
  *
@@ -81,5 +89,5 @@ type GenericTableProps<T extends {
  */
 export declare const GenericTable: <T extends {
     id: number | string;
-}>({ className, canSelect, disabledSelectionTooltip, columns: initialColumns, containerRef, data: initialData, filterCells, filterHeaders, getSubRows, groupBy, isLoading, noData, pagination, pinGroup, sorting, setSorting, rowSelection, setRowSelection, showChevron, variant, ...props }: GenericTableProps<T>) => ReactElement;
+} & Record<string, unknown>>({ className, columns: initialColumns, containerRef, data: initialData, filterCells, filterHeaders, getSubRows, groupBy, isLoading, noData, pagination, pinGroup, sorting, selection, setSorting, showChevron, variant, ...props }: GenericTableProps<T>) => ReactElement;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/maas-react-components",
   "description": "React components for use in MAAS UI projects.",
-  "version": "1.35.0",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/canonical/maas-react-components.git"