@pantheon-systems/pds-toolkit-react 2.0.0-alpha.22 → 2.0.0-alpha.24

package/dist/components/Table/Table.d.ts

@@ -4,10 +4,15 @@ export type SortOrder = 'asc' | 'desc';
 export interface TableColumn {
     /** Content to display in the header cell. */
     header: ReactNode;
-    /** Stable identifier used for sort keys and cell lookup in rowData. */
+    /** Stable identifier used for rendering cell content from rowData. */
     id: string;
     /** When true, renders a sort button next to the header label. */
     sortable?: boolean;
+    /**
+     * Key to use for sorting instead of `id`. Use when the cell renders a
+     * ReactNode but a separate plain-text field in rowData should drive the sort.
+     */
+    sortKey?: string;
 }
 export interface TableProps extends ComponentPropsWithoutRef<'table'> {
     /** Additional class names */
@@ -21,6 +26,8 @@ export interface TableProps extends ComponentPropsWithoutRef<'table'> {
     currentPage?: number;
     /**
      * Column id to sort by on initial render. Only applies in uncontrolled sort mode.
+     * Like `defaultValue` in HTML inputs, this is mount-only — changing it after mount
+     * has no effect. Use `sortKey` + `onSort` for controlled sort.
      */
     defaultSortKey?: string;
     /**
@@ -96,6 +103,9 @@ export interface TableProps extends ComponentPropsWithoutRef<'table'> {
     /**
      * Callback fired when row selection changes. Providing this prop enables
      * the checkbox column. Receives the full array of currently selected row IDs.
+     * Note: in uncontrolled selection mode, IDs of rows removed from `rowData`
+     * (e.g. after filtering) remain in the internal selection set. Clear selection
+     * explicitly when filtering if stale IDs are a concern.
      */
     onRowSelectionChange?: (ids: string[]) => void;
     /**