@taskctrl/canvas-grid 0.1.0 → 0.1.1

package/dist/capture.d.ts

@@ -1,7 +1,7 @@
 import { TreeEngine } from './core/TreeEngine';
 import { ColumnEngine } from './core/ColumnEngine';
 import { SelectionEngine } from './core/SelectionEngine';
-import { ColumnGroup, CaptureOptions } from './types';
+import { ColumnGroup, CaptureOptions, HeaderOrientation } from './types';
 import { GridLayerConfig } from './layers/GridLayer';
 import { CellLayerConfig } from './layers/CellLayer';
 export interface CaptureGridOptions extends CaptureOptions {
@@ -11,7 +11,17 @@ export interface CaptureGridOptions extends CaptureOptions {
     columnGroups?: ColumnGroup[];
     rowHeight: number;
     sidebarWidth: number;
+    headerOrientation?: HeaderOrientation;
+    columnHeaderHeight?: number;
     gridLayerConfig: GridLayerConfig;
     cellLayerConfig: CellLayerConfig;
+    /**
+     * Capture only rows [start, end) (end exclusive), repeating the header. Used
+     * for paginated export of tall grids that exceed the canvas size limit.
+     */
+    rowRange?: {
+        start: number;
+        end: number;
+    };
 }
 export declare function captureGrid(options: CaptureGridOptions): HTMLCanvasElement;

package/dist/dom/ColumnHeaders.d.ts

@@ -6,9 +6,15 @@ export interface ColumnHeadersProps {
     columnGroups?: ColumnGroup[];
     scrollX: number;
     orientation?: HeaderOrientation;
+    columnHeaderHeight?: number;
     onColumnClick?: (colId: string, e: React.PointerEvent) => void;
     onColumnResize?: (colId: string, newWidth: number) => void;
     onColumnReorder?: (colId: string, newIndex: number) => void;
-    columnHeaderRenderer?: (colId: string, title: string) => React.ReactNode;
+    onColumnFilterClick?: (colId: string, rect: DOMRect) => void;
+    columnHeaderRenderer?: (colId: string, title: string, meta: {
+        width: number;
+        height: number;
+        orientation: HeaderOrientation;
+    }) => React.ReactNode;
 }
-export declare function ColumnHeaders({ columnEngine, columnGroups, scrollX, orientation, onColumnClick, onColumnResize, onColumnReorder, columnHeaderRenderer, }: ColumnHeadersProps): React.ReactElement;
+export declare function ColumnHeaders({ columnEngine, columnGroups, scrollX, orientation, columnHeaderHeight: columnHeaderHeightProp, onColumnClick, onColumnResize, onColumnReorder, onColumnFilterClick, columnHeaderRenderer, }: ColumnHeadersProps): React.ReactElement;

package/dist/layers/CellLayer.d.ts

@@ -10,5 +10,10 @@ export interface CellLayerConfig {
         rowId: string | number;
         colId: string;
     } | null;
+    /**
+     * Clear the canvas before drawing. True for the live overlay canvas; set
+     * false for single-canvas capture so the grid background isn't erased.
+     */
+    clearBackground?: boolean;
 }
 export declare function drawCellLayer(ctx: CanvasRenderingContext2D, viewState: ViewState, treeEngine: TreeEngine, columnEngine: ColumnEngine, selectionEngine: SelectionEngine, config: CellLayerConfig): void;

package/dist/types.d.ts

@@ -12,6 +12,10 @@ export interface Column {
     minWidth?: number;
     hidden?: boolean;
     pinned?: 'left';
+    /** Show a built-in filter icon in this column's header (any orientation). */
+    filterable?: boolean;
+    /** Render the filter icon in its active (highlighted) state. */
+    filterActive?: boolean;
     [key: string]: unknown;
 }
 export interface ColumnGroup {
@@ -63,9 +67,16 @@ export interface Selection {
 export type LayerName = 'grid' | 'cells' | 'overlay';
 export interface CaptureOptions {
     scale?: number;
+    /** Capture only rows [start, end) (end exclusive), for paginated export. */
+    rowRange?: {
+        start: number;
+        end: number;
+    };
 }
 export interface CanvasGridRef {
     captureToCanvas(options?: CaptureOptions): HTMLCanvasElement;
+    /** Number of currently-visible (flattened, after expand/collapse) rows. */
+    getRowCount(): number;
 }
 export interface CanvasGridProps {
     rows: Row[];
@@ -78,6 +89,13 @@ export interface CanvasGridProps {
     sidebarWidth?: number;
     rowHeight?: number;
     headerOrientation?: HeaderOrientation;
+    /**
+     * Height (px) of the column-label band, excluding the group-header row.
+     * Defaults to 120 for 'vertical' headers and 32 for 'horizontal'.
+     */
+    columnHeaderHeight?: number;
+    /** Cap the grid's height so its body scrolls internally. number = px. */
+    maxHeight?: number | string;
     rowStyle?: (row: Row, depth: number) => {
         backgroundColor?: string;
     } | null;
@@ -89,8 +107,21 @@ export interface CanvasGridProps {
     onCellHover?: (rowId: string | number | null, colId: string | null, e: PointerEvent) => void;
     onRowHeaderClick?: (rowId: string | number, e: PointerEvent) => void;
     onColumnHeaderClick?: (colId: string, e: PointerEvent) => void;
-    /** Custom React content to render inside a column header cell (e.g. filter icons) */
-    columnHeaderRenderer?: (colId: string, title: string) => React.ReactNode;
+    /**
+     * Custom React content to render inside a column header cell (e.g. a label
+     * wrapped in the consumer's own tooltip). `meta` gives the cell's width,
+     * height and resolved orientation so the consumer can lay out vertical text.
+     */
+    columnHeaderRenderer?: (colId: string, title: string, meta: {
+        width: number;
+        height: number;
+        orientation: HeaderOrientation;
+    }) => React.ReactNode;
+    /**
+     * Fired when a column's built-in filter icon is clicked. `rect` is the
+     * icon's bounding box (viewport coords) so the consumer can anchor a popup.
+     */
+    onColumnFilterClick?: (colId: string, rect: DOMRect) => void;
     defaultExpandedRows?: (string | number)[];
     onExpandChange?: (expandedRows: (string | number)[]) => void;
     onColumnResize?: (colId: string, width: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taskctrl/canvas-grid",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Tree-structured, virtualized data grid rendered on stacked HTML canvas layers for React",
   "type": "module",
   "author": "TaskCtrl AS",