@lensui/lens-table 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -36,6 +36,7 @@ interface TableLabels {
     sortDesc: string;
     sortBoth: string;
     dragColumn: string;
+    revealSelectedCell: string;
     previousYear: string;
     nextYear: string;
     previousMonth: string;
@@ -218,6 +219,22 @@ interface GridSelection extends GridCellPosition {
     rowKey: GridKey;
     columnKey: string;
 }
+/** Cell locator accepted by controlled and default selection props. */
+type GridSelectionTarget = {
+    columnKey: string;
+    rowKey: GridKey;
+    rowIndex?: number;
+    columnIndex?: number;
+} | {
+    columnKey: string;
+    rowIndex: number;
+    rowKey?: GridKey;
+    columnIndex?: number;
+};
+/** Fully resolved selected cell returned by onSelectedCellChange. */
+interface SelectedCellChange extends GridSelection {
+    value: unknown;
+}
 /** Fired after a cell editor commits a value. */
 interface CellChange<Row> extends GridSelection {
     value: unknown;
@@ -270,24 +287,6 @@ interface TableContextMenuConfig<Row> {
     range?: ContextMenuSection<Row, RangeContextMenuBuiltin, RangeContextMenuContext<Row>>;
 }
 type TableContextMenu<Row> = boolean | TableContextMenuConfig<Row>;
-/** Payload for inserting one or more rows around a target row. */
-interface InsertRowsEvent<Row> {
-    rowIndex: number;
-    row: Row;
-    position: 'before' | 'after';
-    count: number;
-    /** Rows created by the grid for the optimistic visible insert. Consumers can persist these directly. */
-    insertedRows?: Row[];
-}
-/** Payload for deleting the selected rows. */
-interface DeleteRowsEvent<Row> {
-    rows: Array<{
-        rowIndex: number;
-        row: Row;
-    }>;
-    /** Current rendered viewport, including virtual overscan. Useful for fast optimistic updates before rebuilding large datasets. */
-    viewportRange?: ViewportRange;
-}
 /**
  * Public props for Table.
  *
@@ -333,22 +332,24 @@ interface TableProps<Row extends object> {
     summary?: TableSummaryConfig;
     /** Show an automatically generated row number column on the left. */
     rowNumber?: boolean;
-    selectedCell?: GridSelection | null;
-    defaultSelectedCell?: GridSelection | null;
-    onSelectedCellChange?: (selection: GridSelection | null) => void;
+    selectedCell?: GridSelectionTarget | null;
+    defaultSelectedCell?: GridSelectionTarget | null;
+    onSelectedCellChange?: (selection: SelectedCellChange | null) => void;
     /** Enable spreadsheet-style mouse drag selection across multiple body cells. Defaults to false. */
     rangeSelection?: boolean;
     rowSelection?: boolean | AxisSelectionConfig;
     selectedRowKeys?: GridKey[];
     defaultSelectedRowKeys?: GridKey[];
-    onSelectedRowKeysChange?: (keys: GridKey[], rows: Row[], indices: number[]) => void;
+    onSelectedRowChange?: (keys: GridKey[], rows: Row[], indices: number[]) => void;
     columnSelection?: boolean | AxisSelectionConfig;
     selectedColumnKeys?: string[];
     defaultSelectedColumnKeys?: string[];
-    onSelectedColumnKeysChange?: (keys: string[]) => void;
+    onSelectedColumnChange?: (keys: string[]) => void;
     columnDraggable?: boolean;
     columnResizable?: boolean;
-    onColumnOrderChange?: (sourceIndex: number, targetIndex: number, detail?: {
+    onColumnsReorder?: (columns: GridColumn<Row>[], detail: {
+        sourceIndex: number;
+        targetIndex: number;
         type: 'column' | 'group';
         sourceKey: string;
         targetKey: string;
@@ -357,13 +358,18 @@ interface TableProps<Row extends object> {
     }) => void;
     onColumnResize?: (columnKey: string, width: number) => void;
     rowDraggable?: boolean;
-    onRowOrderChange?: (sourceIndex: number, targetIndex: number) => void;
-    onInsertRows?: (event: InsertRowsEvent<Row>) => void | Promise<void>;
-    onDeleteRows?: (event: DeleteRowsEvent<Row>) => void | Promise<void>;
-    sortState?: GridSortState | null;
-    onSortStateChange?: (state: GridSortState | null) => void;
-    filterValues?: Record<string, string>;
-    onFilterValuesChange?: (values: Record<string, string>) => void;
+    onRowsReorder?: (rows: Row[], detail: {
+        sourceIndex: number;
+        targetIndex: number;
+    }) => void;
+    /** Receives the complete rows array and the rows added by the built-in insert operation. */
+    onInsertRows?: (rows: Row[], insertedRows: Row[]) => void | Promise<void>;
+    /** Receives the complete rows array and the rows removed by the built-in delete operation. */
+    onDeleteRows?: (rows: Row[], deletedRows: Row[]) => void | Promise<void>;
+    /** Overrides the built-in value sorting. Return rows ordered for the internally managed sort state. */
+    onSortChange?: (rows: Row[], state: GridSortState) => Row[];
+    /** Overrides the built-in text filtering. Return the rows that match the internally managed filter values. */
+    onFilterChange?: (rows: Row[], values: Readonly<Record<string, string>>) => Row[];
     onCellChange?: (change: CellChange<Row>) => void | Promise<void>;
     onCellContextMenu?: (event: ContextMenuEvent<Row>) => void;
     /** true uses the built-in menu, false disables custom menus, object customizes menu content and order. */
@@ -380,7 +386,7 @@ interface ViewportRange {
     columnEnd: number;
 }
 
-declare function Table<Row extends object>({ columns: sourceColumns, rows: sourceRows, rowKey, width, height, autoHeight, layout, rowHeight: rowHeightProp, headerHeight: headerHeightProp, fixedHeader, locale, borderless, verticalBorderless, striped, highlight, cellSpans, loading, loadingContent, virtualized, tooltip, summary, rowNumber, selectedCell, defaultSelectedCell, onSelectedCellChange, rangeSelection, rowSelection, selectedRowKeys, defaultSelectedRowKeys, onSelectedRowKeysChange, columnSelection, selectedColumnKeys, defaultSelectedColumnKeys, onSelectedColumnKeysChange, columnDraggable, columnResizable, onColumnOrderChange, onColumnResize, rowDraggable, onRowOrderChange, onInsertRows, onDeleteRows, sortState, onSortStateChange, filterValues, onFilterValuesChange, onCellChange, onCellContextMenu, contextMenu: contextMenuConfig, emptyContent, className, style, ariaLabel, }: TableProps<Row>): react.JSX.Element;
+declare function Table<Row extends object>({ columns: columnProps, rows: sourceRows, rowKey, width, height, autoHeight, layout, rowHeight: rowHeightProp, headerHeight: headerHeightProp, fixedHeader, locale, borderless, verticalBorderless, striped, highlight, cellSpans, loading, loadingContent, virtualized, tooltip, summary, rowNumber, selectedCell, defaultSelectedCell, onSelectedCellChange, rangeSelection, rowSelection, selectedRowKeys, defaultSelectedRowKeys, onSelectedRowChange, columnSelection, selectedColumnKeys, defaultSelectedColumnKeys, onSelectedColumnChange, columnDraggable, columnResizable, onColumnsReorder, onColumnResize, rowDraggable, onRowsReorder, onInsertRows, onDeleteRows, onSortChange, onFilterChange, onCellChange, onCellContextMenu, contextMenu: contextMenuConfig, emptyContent, className, style, ariaLabel, }: TableProps<Row>): react.JSX.Element;
 
 type LayoutColumn<Row> = GridColumn<Row> & {
     rowSelection?: boolean;
@@ -427,4 +433,4 @@ declare function hitTestColumn(metrics: ColumnMetric[], contentX: number): numbe
 
 type TableFilterValues = Record<string, string>;
 
-export { type AxisSelectionConfig, type CellChange, type ContextMenuEvent, type DeleteRowsEvent, type GridCellPosition, type GridColumn, type GridKey, type GridSelection, type GridSortState, type InsertRowsEvent, type SelectionMode, type SortDirection, Table, type CellChange as TableCellChange, type GridCellPosition as TableCellPosition, type TableCellSpan, type TableCellSpanRule, type TableCellSpanRuleContext, type TableCellSpans, type GridColumn as TableColumn, type TableContextMenu, type TableContextMenuConfig, type ContextMenuEvent as TableContextMenuEvent, type DeleteRowsEvent as TableDeleteRowsEvent, type GridSelection as TableEditingCell, type TableFilterValues, type TableHighlightConfig, type InsertRowsEvent as TableInsertRowsEvent, type GridKey as TableKey, type TableLabels, type TableLayoutConfig, type TableLocaleCode, type TableLocaleConfig, type TableProps, type TableResolvedCellSpan, type GridSortState as TableSorter, type TableSummaryConfig, type TableTooltipConfig, type ViewportRange as TableViewportRange, type TableVirtualizedConfig, Table as VelocityGrid, type TableCellSpan as VelocityGridCellSpan, type TableCellSpanRule as VelocityGridCellSpanRule, type TableCellSpanRuleContext as VelocityGridCellSpanRuleContext, type TableCellSpans as VelocityGridCellSpans, type TableContextMenu as VelocityGridContextMenu, type TableContextMenuConfig as VelocityGridContextMenuConfig, type TableHighlightConfig as VelocityGridHighlightConfig, type TableLabels as VelocityGridLabels, type TableLayoutConfig as VelocityGridLayoutConfig, type TableLocaleCode as VelocityGridLocaleCode, type TableLocaleConfig as VelocityGridLocaleConfig, type TableProps as VelocityGridProps, type TableResolvedCellSpan as VelocityGridResolvedCellSpan, type TableSummaryConfig as VelocityGridSummaryConfig, type TableTooltipConfig as VelocityGridTooltipConfig, type TableVirtualizedConfig as VelocityGridVirtualizedConfig, type ViewportRange, buildColumnMetrics, getViewportRange, hitTestColumn };
+export { type AxisSelectionConfig, type CellChange, type ContextMenuEvent, type GridCellPosition, type GridColumn, type GridKey, type GridSelection, type GridSelectionTarget, type GridSortState, type SelectedCellChange, type SelectionMode, type SortDirection, Table, type CellChange as TableCellChange, type GridCellPosition as TableCellPosition, type TableCellSpan, type TableCellSpanRule, type TableCellSpanRuleContext, type TableCellSpans, type GridColumn as TableColumn, type TableContextMenu, type TableContextMenuConfig, type ContextMenuEvent as TableContextMenuEvent, type GridSelection as TableEditingCell, type TableFilterValues, type TableHighlightConfig, type GridKey as TableKey, type TableLabels, type TableLayoutConfig, type TableLocaleCode, type TableLocaleConfig, type TableProps, type TableResolvedCellSpan, type GridSortState as TableSorter, type TableSummaryConfig, type TableTooltipConfig, type ViewportRange as TableViewportRange, type TableVirtualizedConfig, Table as VelocityGrid, type TableCellSpan as VelocityGridCellSpan, type TableCellSpanRule as VelocityGridCellSpanRule, type TableCellSpanRuleContext as VelocityGridCellSpanRuleContext, type TableCellSpans as VelocityGridCellSpans, type TableContextMenu as VelocityGridContextMenu, type TableContextMenuConfig as VelocityGridContextMenuConfig, type TableHighlightConfig as VelocityGridHighlightConfig, type TableLabels as VelocityGridLabels, type TableLayoutConfig as VelocityGridLayoutConfig, type TableLocaleCode as VelocityGridLocaleCode, type TableLocaleConfig as VelocityGridLocaleConfig, type TableProps as VelocityGridProps, type TableResolvedCellSpan as VelocityGridResolvedCellSpan, type TableSummaryConfig as VelocityGridSummaryConfig, type TableTooltipConfig as VelocityGridTooltipConfig, type TableVirtualizedConfig as VelocityGridVirtualizedConfig, type ViewportRange, buildColumnMetrics, getViewportRange, hitTestColumn };