@linzjs/step-ag-grid 26.0.1 → 27.0.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@linzjs/step-ag-grid",
   "repository": "github:linz/step-ag-grid.git",
   "license": "MIT",
-  "version": "26.0.1",
+  "version": "27.0.0",
   "keywords": [
     "aggrid",
     "ag-grid",

package/src/components/Grid.tsx

@@ -50,6 +50,7 @@ export interface GridProps<TData extends GridBaseRow = GridBaseRow> {
   readOnly?: boolean; // set all editables to false when read only, make all styles black, otherwise style is gray for not editable
   defaultPostSort?: boolean; // Retain sort order after edit, Defaults to true.
   selectable?: boolean;
+  hideSelectColumn?: boolean;
   theme?: string; // should have prefix ag-theme-
   ['data-testid']?: string;
   domLayout?: GridOptions['domLayout'];
@@ -643,6 +644,7 @@ export const Grid = <TData extends GridBaseRow = GridBaseRow>({
   // This is setting a ref in the GridContext so won't be triggering an update loop
   setOnCellEditingComplete(params.onCellEditingComplete);
 
+  const selectWidth = params.hideSelectColumn ? 0 : selectable && params.onRowDragEnd ? 76 : 48;
   const headerRowCount = columnDefs.some((c) => (c as any).children) ? 2 : 1;
   return (
     <div
@@ -719,9 +721,10 @@ export const Grid = <TData extends GridBaseRow = GridBaseRow>({
           pinnedTopRowData={params.pinnedTopRowData}
           pinnedBottomRowData={params.pinnedBottomRowData}
           selectionColumnDef={{
+            suppressNavigable: params.hideSelectColumn,
             rowDrag: !!params.onRowDragEnd,
-            minWidth: selectable && params.onRowDragEnd ? 76 : 48,
-            maxWidth: selectable && params.onRowDragEnd ? 76 : 48,
+            minWidth: selectWidth,
+            maxWidth: selectWidth,
             pinned: selectColumnPinned,
             headerComponentParams: {
               exportable: false,

package/src/components/GridCell.test.tsx

@@ -1,7 +1,8 @@
+import { ValueGetterParams } from 'ag-grid-community';
 import { describe, expect, test } from 'vitest';
 
 import { GridBaseRow } from './Grid';
-import { generateFilterGetter, SAValueGetterParams } from './GridCell';
+import { generateFilterGetter } from './GridCell';
 
 describe('GridCell', () => {
   test('generateFilterGetter returns passed filterValueGetter', () => {
@@ -26,7 +27,7 @@ describe('GridCell', () => {
       const filterGetter = generateFilterGetter(field, undefined, valueFormatter);
       expect(typeof filterGetter).toBe('function');
       if (typeof filterGetter !== 'function') return;
-      expect(filterGetter({ getValue: () => test.value } as any as SAValueGetterParams<GridBaseRow>)).toBe(
+      expect(filterGetter({ getValue: () => test.value } as unknown as ValueGetterParams<GridBaseRow>)).toBe(
         test.expected,
       );
     });

package/src/components/GridCell.tsx

@@ -1,6 +1,5 @@
 import { ColDef, EditableCallback, ICellEditorParams, ICellRendererParams } from 'ag-grid-community';
 import {
-  EditableCallbackParams,
   SuppressKeyboardEventParams,
   ValueFormatterFunc,
   ValueFormatterParams,
@@ -24,11 +23,6 @@ export interface GenericCellEditorProps<E> {
   editorParams?: E;
 }
 
-export interface SAICellRendererParams<TData = any, TValue = any, TContext = any>
-  extends Omit<ICellRendererParams<TData, TValue, TContext>, 'data'> {
-  data: TData;
-}
-
 export const GridCellRenderer = (props: ICellRendererParams) => {
   const { checkUpdating } = useContext(GridUpdatingContext);
   const colDef = props.colDef as ColDef;
@@ -63,41 +57,13 @@ export const GridCellRenderer = (props: ICellRendererParams) => {
   );
 };
 
-export interface SAValueGetterParams<TData = any, TValue = any> extends Omit<ValueGetterParams<TData, TValue>, 'data'> {
-  data: TData;
-  getValue: (field: string) => any;
-}
-
-export interface SAValueGetterFunc<TData = any, TValue = any> {
-  (params: SAValueGetterParams<TData, TValue>): TValue | null | undefined;
-}
-
-export interface SAEditableCallbackParams<TData = any, TValue = any>
-  extends Omit<EditableCallbackParams<TData, TValue>, 'data'> {
-  data: TData;
-}
-
-export interface SAEditableCallback<TData = any, TValue = any> {
-  (params: SAEditableCallbackParams<TData, TValue>): boolean;
-}
-
-export interface SAValueFormatterParams<TData = any, TValue = any>
-  extends Omit<ValueFormatterParams<TData, TValue>, 'data' | 'value'> {
-  data: TData;
-  value: TValue;
-}
-
-export interface SAValueFormatterFunc<TData = any, TValue = any> {
-  (params: SAValueFormatterParams<TData, TValue>): string;
-}
-
 // This is so that typescript retains the row type to pass to the GridCells
 export interface ColDefT<TData extends GridBaseRow, ValueType = any> extends ColDef<TData, ValueType> {
   editable?: boolean | EditableCallback<TData, ValueType>;
   valueGetter?: string | ValueGetterFunc<TData, ValueType>;
   valueFormatter?: string | ValueFormatterFunc<TData, ValueType>;
   cellRenderer?:
-    | ((props: SAICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined)
+    | ((props: ICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined)
     | string;
   cellRendererParams?: {
     singleClickEdit?: boolean;
@@ -105,8 +71,8 @@ export interface ColDefT<TData extends GridBaseRow, ValueType = any> extends Col
     originalCellRenderer?: any;
     editAction?: (selectedRows: TData[]) => void;
     shortcutKeys?: Record<string, () => void>;
-    warning?: (props: SAICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined;
-    info?: (props: SAICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined;
+    warning?: (props: ICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined;
+    info?: (props: ICellRendererParams<TData, ValueType>) => ReactElement | string | false | null | undefined;
   };
   editor?: (editorProps: any) => ReactElement;
 }
@@ -129,7 +95,7 @@ export const generateFilterGetter = <TData extends GridBaseRow, ValueType>(
   field: string | undefined,
   filterValueGetter: string | ValueGetterFunc<TData, ValueType> | undefined,
   valueFormatter: string | ValueFormatterFunc<TData, ValueType> | undefined,
-): string | SAValueGetterFunc<TData, ValueType> | undefined => {
+): string | ValueGetterFunc<TData, ValueType> | undefined => {
   if (filterValueGetter) return filterValueGetter;
   // aggrid will default to valueGetter
   if (typeof valueFormatter !== 'function' || !field) return undefined;

package/src/components/gridPopoverEdit/GridButton.tsx

@@ -1,12 +1,12 @@
 import { LuiButton, LuiIcon } from '@linzjs/lui';
-import { CellFocusedEvent, ICellEditorParams } from 'ag-grid-community';
+import { CellFocusedEvent, ICellEditorParams, ICellRendererParams } from 'ag-grid-community';
 import { useEffect, useRef } from 'react';
 
 import { GridBaseRow } from '../Grid';
-import { ColDefT, GridCell, SAICellRendererParams } from '../GridCell';
+import { ColDefT, GridCell } from '../GridCell';
 import { GenericCellColDef } from '../gridRender';
 
-const ButtonCellRenderer = <TData extends GridBaseRow>(props: SAICellRendererParams<TData>) => {
+const ButtonCellRenderer = <TData extends GridBaseRow>(props: ICellRendererParams<TData>) => {
   const { data, node, column, colDef, api } = props;
   const inputRef = useRef<HTMLButtonElement>(null);
 
@@ -30,7 +30,7 @@ const ButtonCellRenderer = <TData extends GridBaseRow>(props: SAICellRendererPar
       level="text"
       onClick={() => {
         const selectedRows = [data];
-        const selectedRowIds = selectedRows.map((r) => r.id);
+        const selectedRowIds = selectedRows.map((r) => r!.id);
         colDef?.cellEditorParams.onClick?.({ selectedRows, selectedRowIds });
       }}
       style={{ display: colDef?.cellEditorParams?.visible?.(props) !== false ? '' : 'none' }}

package/src/react-menu3/components/ControlledMenu.tsx

@@ -198,7 +198,7 @@ export const ControlledMenuFr = (
           break;
       }
     },
-    [anchorRef, saveButtonRef],
+    [anchorRef, onClose, saveButtonRef],
   );
 
   const handleKeydownTabAndEnter = useMemo(() => handleKeyboardTabAndEnter(true), [handleKeyboardTabAndEnter]);