@affino/datagrid-vue 0.1.0

package/dist/composables/useTableSelection.d.ts

@@ -0,0 +1,204 @@
+import type { ComputedRef, Ref } from "vue";
+import { type GridSelectionPoint as CoreSelectionPoint, type GridSelectionRange as CoreSelectionRange, type SelectionArea as CoreSelectionArea } from "../../core/selection/selectionState";
+import type { ColumnMetric } from "./useAxisVirtualizer";
+import type { RowKey } from "@/composables/useSelectableRows";
+import type { ImperativeSelectionSnapshot } from "../../core/imperative/types";
+import { type SelectionOverlayColumnSurface } from "@affino/datagrid-core/selection/selectionOverlay";
+import type { UiTableOverlayHandle } from "../types/overlay";
+import type { PointerCoordinates } from "@affino/datagrid-core/selection/autoScroll";
+import type { CellEditEvent, UiTableColumn, UiTableSelectedCell, UiTableSelectionRangeInput, UiTableSelectionSnapshot, VisibleRow } from "../../core/types";
+import type { HistoryEntry } from "./useTableHistory";
+export type SelectionPoint = CoreSelectionPoint<RowKey>;
+type SelectionPointLike = CoreSelectionPoint<RowKey> | {
+    rowId?: RowKey | null;
+    rowIndex: number;
+    colIndex: number;
+};
+export type SelectionRange = CoreSelectionRange<RowKey>;
+export type SelectionArea = CoreSelectionArea;
+export interface SelectedRowPayload {
+    displayIndex: number;
+    originalIndex: number;
+    rowId?: RowKey | null;
+    row: any;
+}
+interface UseTableSelectionOptions {
+    containerRef: Ref<HTMLDivElement | null>;
+    overlayContainerRef?: Ref<HTMLElement | null>;
+    localColumns: Ref<UiTableColumn[]>;
+    processedRows: ComputedRef<VisibleRow[]>;
+    totalRowCount: Ref<number>;
+    viewport: {
+        effectiveRowHeight: Ref<number>;
+        viewportHeight: Ref<number>;
+        viewportWidth: Ref<number>;
+        scrollTop: Ref<number>;
+        scrollLeft: Ref<number>;
+        startIndex: Ref<number>;
+        endIndex: Ref<number>;
+        visibleStartCol: Ref<number>;
+        visibleEndCol: Ref<number>;
+        columnWidthMap: Ref<Map<string, number>>;
+        pinnedLeftEntries: Ref<ColumnMetric[]>;
+        pinnedRightEntries: Ref<ColumnMetric[]>;
+        virtualizationEnabled: Ref<boolean>;
+        clampScrollTopValue: (value: number) => number;
+        scrollToColumn?: (key: string) => void;
+    };
+    isEditingCell: Ref<boolean>;
+    columnSurfaces?: ComputedRef<Map<string, SelectionOverlayColumnSurface>>;
+    focusContainer: () => void;
+    emitSelectionChange: (snapshot: UiTableSelectionSnapshot) => void;
+    setCellValueDirect: (rowRef: RowKey | number, colIndex: number, value: unknown, options?: {
+        collector?: CellEditEvent[];
+        historyCollector?: HistoryEntry[];
+        suppressHistory?: boolean;
+        force?: boolean;
+    }) => boolean;
+    setCellValueFromPaste: (rowRef: RowKey | number, colIndex: number, rawValue: string, options?: {
+        collector?: CellEditEvent[];
+        historyCollector?: HistoryEntry[];
+        suppressHistory?: boolean;
+    }) => boolean;
+    getCellRawValue: (rowRef: RowKey | number, colIndex: number) => unknown;
+    dispatchEvents: (events: CellEditEvent[]) => void;
+    recordHistory: (entries: HistoryEntry[]) => void;
+    refreshViewport?: (force?: boolean) => void;
+    stopAutoScroll: () => void;
+    updateAutoScroll: (pointer: PointerCoordinates) => void;
+    lastPointer: Ref<PointerCoordinates | null>;
+    deleteRows?: (rows: SelectedRowPayload[]) => void;
+    rowIndexColumnKey?: string;
+    rowSelectionMode?: Ref<"cell" | "row"> | "cell" | "row";
+    getRowIdByIndex: (rowIndex: number) => RowKey | null;
+    findRowIndexById: (rowId: RowKey) => number | null;
+    resolveCellElement: (rowIndex: number, columnKey: string) => HTMLElement | null;
+    resolveHeaderCellElement: (columnKey: string) => HTMLElement | null;
+    overlayComponentRef?: Ref<UiTableOverlayHandle | null>;
+    pinnedRightWidth?: Ref<number>;
+    pinnedLeftOffset?: Ref<number>;
+    pinnedRightOffset?: Ref<number>;
+    overlayScrollControlledExternally?: boolean;
+}
+export declare const useTableSelection: (options: UseTableSelectionOptions) => {
+    selectedCell: Ref<any, any>;
+    anchorCell: Ref<any, any>;
+    selectionRanges: Ref<any, any>;
+    activeRangeIndex: Ref<any, any>;
+    fullRowSelection: Ref<any, any>;
+    fullColumnSelection: ComputedRef<number | null>;
+    isDraggingSelection: Ref<any, any>;
+    isFillDragging: Ref<any, any>;
+    fillPreviewRange: ComputedRef<any>;
+    cutPreviewRanges: ComputedRef<any>;
+    cutPreviewActiveIndex: ComputedRef<any>;
+    fillHandleStyle: any;
+    selectionOverlayRects: Ref<any, any>;
+    activeSelectionOverlayRects: Ref<any, any>;
+    selectionCursorOverlay: any;
+    fillPreviewOverlayRects: Ref<any, any>;
+    cutPreviewOverlayRects: Ref<any, any>;
+    overlayScrollState: import("./useTableOverlayScrollState").TableOverlayScrollEmitter;
+    selectionOverlayAdapter: import("./useSelectionOverlayAdapter").SelectionOverlayAdapterHandle;
+    scheduleOverlayUpdate: (options?: {
+        priority?: "user-blocking" | "background";
+        timeout?: number;
+    }) => void;
+    setSelection: (rangesInput: UiTableSelectionRangeInput | UiTableSelectionRangeInput[], options?: {
+        activeRangeIndex?: number;
+        focus?: boolean;
+    }) => void;
+    clearSelection: () => void;
+    focusCell: (rowIndex: number, column: number | string, options?: {
+        extend?: boolean;
+    }) => boolean;
+    getActiveCell: () => any;
+    getSelectionSnapshot: () => UiTableSelectionSnapshot;
+    getActiveRange: () => SelectionRange | null;
+    getActiveSelectionArea: () => SelectionArea | null;
+    selectCell: (rowIndex: number, columnKey: string, focus?: boolean, options?: {
+        fullRow?: boolean;
+        fullColumn?: boolean;
+        colIndex?: number;
+    }) => void;
+    iterSelectionCells: (callback: (rowIndex: number, colIndex: number, column: UiTableColumn | undefined) => void) => void;
+    getSelectedCells: () => UiTableSelectedCell[];
+    isCellSelected: (rowIndex: number, colIndex: number) => any;
+    isSelectionCursorCell: (rowIndex: number, colIndex: number) => boolean;
+    isSelectionAnchorCell: (rowIndex: number, colIndex: number) => boolean;
+    isCellInSelectionRange: (rowIndex: number, colIndex: number) => boolean;
+    isCellInCutPreview: (rowIndex: number, colIndex: number) => any;
+    isRowFullySelected: (rowIndex: number) => boolean;
+    isColumnFullySelected: (colIndex: number) => boolean;
+    isRowInSelectionRect: (rowIndex: number) => boolean;
+    isColumnInSelectionRect: (colIndex: number) => boolean;
+    isCellInFillPreview: (rowIndex: number, colIndex: number) => boolean;
+    getSelectionEdges: (rowIndex: number, colIndex: number) => any;
+    getFillPreviewEdges: (rowIndex: number, colIndex: number) => any;
+    getCutPreviewEdges: (rowIndex: number, colIndex: number) => any;
+    rowHeaderClass: (rowIndex: number) => any;
+    onCellSelect: (payload: {
+        rowIndex: number;
+        key: string;
+        colIndex?: number;
+        focus?: boolean;
+        event?: MouseEvent;
+    }) => void;
+    onRowIndexClick: (rowIndex: number, event?: MouseEvent) => void;
+    onColumnHeaderClick: (colIndex: number) => void;
+    onCellDragStart: (payload: {
+        rowIndex: number;
+        colIndex: number;
+        event: MouseEvent;
+    }) => void;
+    onCellDragEnter: (payload: {
+        rowIndex: number;
+        colIndex: number;
+        event: MouseEvent;
+    }) => void;
+    handleSelectionMouseUp: () => void;
+    moveSelection: (rowDelta: number, colDelta: number, options?: {
+        extend?: boolean;
+    }) => void;
+    canMoveActiveSelection: () => boolean;
+    moveActiveSelectionTo: (rowStart: number, colStart: number) => boolean;
+    moveByTab: (forward: boolean) => boolean;
+    moveByPage: (direction: number, options?: {
+        extend?: boolean;
+    }) => boolean;
+    goToRowEdge: (edge: "start" | "end", options?: {
+        extend?: boolean;
+    }) => boolean;
+    goToColumnEdge: (edge: "start" | "end", options?: {
+        extend?: boolean;
+    }) => boolean;
+    goToGridEdge: (edge: "start" | "end", options?: {
+        extend?: boolean;
+    }) => boolean;
+    triggerEditForSelection: () => {
+        rowIndex: any;
+        columnKey: any;
+    } | null;
+    clearSelectionValues: () => boolean;
+    beginCutPreview: (snapshot: UiTableSelectionSnapshot | null) => void;
+    clearCutPreview: () => void;
+    commitPendingCut: () => boolean;
+    hasCutPreview: () => boolean;
+    applyMatrixToSelection: (matrix: string[][], baseOverride?: SelectionPointLike | null) => void;
+    buildSelectionMatrix: (range: SelectionRange | null, options?: {
+        includeHeaders?: boolean;
+        fallbackToAll?: boolean;
+    }) => string[][];
+    buildSelectionSnapshot: (options: {
+        rowIndices: readonly number[];
+        columnIndices: readonly number[];
+    }) => ImperativeSelectionSnapshot;
+    getBoundsForRange: (range: SelectionRange | null, fallbackToAll: boolean) => SelectionArea | null;
+    startFillDrag: (event: MouseEvent) => void;
+    autoFillDownFromActiveRange: () => void;
+    handleAutoScrollFrame: () => void;
+    lastCommittedFillArea: any;
+    selectionEnvironment: SelectionEnvironment<RowKey>;
+};
+export {};
+//# sourceMappingURL=useTableSelection.d.ts.map

package/dist/composables/useTableSelection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTableSelection.d.ts","sourceRoot":"","sources":["../../src/composables/useTableSelection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC3C,OAAO,EAKL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAE7C,KAAK,aAAa,IAAI,iBAAiB,EACxC,MAAM,qCAAqC,CAAA;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,KAAK,EAGV,2BAA2B,EAC5B,MAAM,6BAA6B,CAAA;AA8CpC,OAAO,EAQL,KAAK,6BAA6B,EAGnC,MAAM,kDAAkD,CAAA;AAEzD,OAAO,KAAK,EAAE,oBAAoB,EAAsB,MAAM,kBAAkB,CAAA;AAMhF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAA;AAMpF,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,mBAAmB,EAEnB,0BAA0B,EAC1B,wBAAwB,EAExB,UAAU,EACX,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAarD,MAAM,MAAM,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;AAEvD,KAAK,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpH,MAAM,MAAM,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;AAEvD,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAA;AAE7C,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,GAAG,EAAE,GAAG,CAAA;CACT;AA+CD,UAAU,wBAAwB;IAChC,YAAY,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACxC,mBAAmB,CAAC,EAAE,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC7C,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAA;IAClC,aAAa,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;IACxC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC1B,QAAQ,EAAE;QACR,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC/B,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3B,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC1B,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACtB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACvB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACvB,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACrB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC5B,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC1B,cAAc,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACxC,iBAAiB,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;QACtC,kBAAkB,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;QACvC,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACnC,mBAAmB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;QAC9C,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;KACvC,CAAA;IACD,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3B,cAAc,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC,CAAA;IACxE,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,mBAAmB,EAAE,CAAC,QAAQ,EAAE,wBAAwB,KAAK,IAAI,CAAA;IACjE,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QACxF,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;QAC3B,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAA;QACjC,eAAe,CAAC,EAAE,OAAO,CAAA;QACzB,KAAK,CAAC,EAAE,OAAO,CAAA;KAChB,KAAK,OAAO,CAAA;IACb,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAC7F,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;QAC3B,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAA;QACjC,eAAe,CAAC,EAAE,OAAO,CAAA;KAC1B,KAAK,OAAO,CAAA;IACb,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAA;IACvE,cAAc,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,IAAI,CAAA;IACjD,aAAa,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,IAAI,CAAA;IAChD,eAAe,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC3C,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,gBAAgB,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAA;IACvD,WAAW,EAAE,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAA;IAC3C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAA;IACjD,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,MAAM,GAAG,KAAK,CAAA;IACvD,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IACpD,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IAClD,kBAAkB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,WAAW,GAAG,IAAI,CAAA;IAC/E,wBAAwB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,WAAW,GAAG,IAAI,CAAA;IACnE,mBAAmB,CAAC,EAAE,GAAG,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAA;IACtD,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC9B,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC9B,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC/B,iCAAiC,CAAC,EAAE,OAAO,CAAA;CAC5C;AAED,eAAO,MAAM,iBAAiB,GAAI,SAAS,wBAAwB;;;;;;;;;;;;;;;;;;;;sCA6uBxB;QAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,YAAY,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;gCAyhCzF,0BAA0B,GAAG,0BAA0B,EAAE,YAC5D;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;;0BApP7B,MAAM,UAAU,MAAM,GAAG,MAAM,YAAY;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;;gCA7E3D,wBAAwB;0BAxH9B,cAAc,GAAG,IAAI;kCAMb,aAAa,GAAG,IAAI;2BAoX3C,MAAM,aACL,MAAM,6BAEP;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE;mCA8HpC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,SAAS,KAAK,IAAI;4BAqCxF,mBAAmB,EAAE;+BAqBhB,MAAM,YAAY,MAAM;sCA0BjB,MAAM,YAAY,MAAM;sCAJxB,MAAM,YAAY,MAAM;uCAm9C9B,MAAM,YAAY,MAAM;mCApxCrB,MAAM,YAAY,MAAM;mCAvLxB,MAAM;sCAMH,MAAM;qCAIP,MAAM;wCAeH,MAAM;oCAWV,MAAM,YAAY,MAAM;kCAU1B,MAAM,YAAY,MAAM;oCAItB,MAAM,YAAY,MAAM;mCA2IzB,MAAM,YAAY,MAAM;+BAgJ5B,MAAM;4BAYT;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE;gCAgDrF,MAAM,UAAU,UAAU;oCAuCtB,MAAM;+BAoBX;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE;+BA8BzD;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE;;8BAyhB1D,MAAM,YAAY,MAAM,YAAW;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;;sCA2H/C,MAAM,YAAY,MAAM;yBAwBrC,OAAO;4BAx9CJ,MAAM,YAAY;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;wBApB1C,OAAO,GAAG,KAAK,YAAY;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;2BAO5C,OAAO,GAAG,KAAK,YAAY;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;yBAOjD,OAAO,GAAG,KAAK,YAAY;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;;;;;;gCAiZxC,wBAAwB,GAAG,IAAI;;4BA2CrC,OAAO;;qCA2rBI,MAAM,EAAE,EAAE,iBAAiB,kBAAkB,GAAG,IAAI;kCA5DnF,cAAc,GAAG,IAAI,YAClB;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE;sCAliBxB;QACvC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAA;QAC7B,aAAa,EAAE,SAAS,MAAM,EAAE,CAAA;KACjC,KAAG,2BAA2B;+BAyhBG,cAAc,GAAG,IAAI,iBAAiB,OAAO,KAAG,aAAa,GAAG,IAAI;2BAxKxE,UAAU;;;;;CAs7BzC,CAAA"}