@particle-academy/fancy-sheets 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,189 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/** Column-letter + row-number string, e.g. "A1", "BC42" */
+type CellAddress = string;
+/** Primitive cell value */
+type CellValue = string | number | boolean | null;
+/** Text alignment */
+type TextAlign = "left" | "center" | "right";
+/** Cell formatting */
+interface CellFormat {
+    bold?: boolean;
+    italic?: boolean;
+    textAlign?: TextAlign;
+}
+/** A single cell's complete data */
+interface CellData {
+    /** The raw value (what the user typed) */
+    value: CellValue;
+    /** Formula string without leading "=", e.g. "SUM(A1:A5)" */
+    formula?: string;
+    /** Computed value after formula evaluation */
+    computedValue?: CellValue;
+    /** Display formatting */
+    format?: CellFormat;
+}
+
+/** Sparse cell map — only stores cells that have data */
+type CellMap = Record<string, CellData>;
+/** Column width overrides (col index -> px) */
+type ColumnWidths = Record<number, number>;
+/** Merged region defined by top-left and bottom-right addresses */
+interface MergedRegion {
+    start: string;
+    end: string;
+}
+/** A single sheet within a workbook */
+interface SheetData {
+    id: string;
+    name: string;
+    cells: CellMap;
+    columnWidths: ColumnWidths;
+    mergedRegions: MergedRegion[];
+    columnFilters: Record<number, string>;
+    sortColumn?: number;
+    sortDirection?: "asc" | "desc";
+    frozenRows: number;
+    frozenCols: number;
+}
+/** The complete workbook */
+interface WorkbookData {
+    sheets: SheetData[];
+    activeSheetId: string;
+}
+/** Create an empty sheet */
+declare function createEmptySheet(id: string, name: string): SheetData;
+/** Create an empty workbook with one sheet */
+declare function createEmptyWorkbook(): WorkbookData;
+
+/** A rectangular range of cells */
+interface CellRange {
+    start: string;
+    end: string;
+}
+/** Full selection state */
+interface SelectionState {
+    /** The anchor cell (where selection started) */
+    activeCell: string;
+    /** Ranges currently selected (supports multi-select via Ctrl+Click) */
+    ranges: CellRange[];
+}
+
+interface SpreadsheetProps {
+    children: ReactNode;
+    className?: string;
+    /** Controlled workbook data */
+    data?: WorkbookData;
+    /** Default data (uncontrolled) */
+    defaultData?: WorkbookData;
+    /** Called on any data change */
+    onChange?: (data: WorkbookData) => void;
+    /** Number of columns (default: 26) */
+    columnCount?: number;
+    /** Number of rows (default: 100) */
+    rowCount?: number;
+    /** Default column width in px (default: 100) */
+    defaultColumnWidth?: number;
+    /** Row height in px (default: 28) */
+    rowHeight?: number;
+    /** Read-only mode */
+    readOnly?: boolean;
+}
+interface SpreadsheetContextValue {
+    workbook: WorkbookData;
+    activeSheet: SheetData;
+    columnCount: number;
+    rowCount: number;
+    defaultColumnWidth: number;
+    rowHeight: number;
+    readOnly: boolean;
+    selection: SelectionState;
+    editingCell: string | null;
+    editValue: string;
+    setCellValue: (address: string, value: string) => void;
+    setCellFormat: (addresses: string[], format: Partial<CellFormat>) => void;
+    setSelection: (cell: string) => void;
+    extendSelection: (cell: string) => void;
+    addSelection: (cell: string) => void;
+    navigate: (direction: "up" | "down" | "left" | "right", extend?: boolean) => void;
+    startEdit: (value?: string) => void;
+    updateEdit: (value: string) => void;
+    confirmEdit: () => void;
+    cancelEdit: () => void;
+    resizeColumn: (col: number, width: number) => void;
+    addSheet: () => void;
+    renameSheet: (sheetId: string, name: string) => void;
+    deleteSheet: (sheetId: string) => void;
+    setActiveSheet: (sheetId: string) => void;
+    undo: () => void;
+    redo: () => void;
+    canUndo: boolean;
+    canRedo: boolean;
+    getColumnWidth: (col: number) => number;
+    isCellSelected: (address: string) => boolean;
+    isCellActive: (address: string) => boolean;
+}
+
+interface SpreadsheetGridProps {
+    className?: string;
+}
+declare function SpreadsheetGrid({ className }: SpreadsheetGridProps): react_jsx_runtime.JSX.Element;
+declare namespace SpreadsheetGrid {
+    var displayName: string;
+}
+
+interface SpreadsheetToolbarProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare function SpreadsheetToolbar({ children, className }: SpreadsheetToolbarProps): react_jsx_runtime.JSX.Element;
+declare namespace SpreadsheetToolbar {
+    var displayName: string;
+}
+
+interface SpreadsheetSheetTabsProps {
+    className?: string;
+}
+declare function SpreadsheetSheetTabs({ className }: SpreadsheetSheetTabsProps): react_jsx_runtime.JSX.Element;
+declare namespace SpreadsheetSheetTabs {
+    var displayName: string;
+}
+
+declare function SpreadsheetRoot({ children, className, data, defaultData, onChange, columnCount, rowCount, defaultColumnWidth, rowHeight, readOnly, }: SpreadsheetProps): react_jsx_runtime.JSX.Element;
+declare namespace SpreadsheetRoot {
+    var displayName: string;
+}
+declare const Spreadsheet: typeof SpreadsheetRoot & {
+    Toolbar: typeof SpreadsheetToolbar;
+    Grid: typeof SpreadsheetGrid;
+    SheetTabs: typeof SpreadsheetSheetTabs;
+};
+
+declare function useSpreadsheet(): SpreadsheetContextValue;
+
+/** Convert 0-based column index to letter(s): 0="A", 25="Z", 26="AA" */
+declare function columnToLetter(col: number): string;
+/** Convert column letter(s) to 0-based index: "A"=0, "Z"=25, "AA"=26 */
+declare function letterToColumn(letters: string): number;
+/** Parse address string to 0-based row and col: "B3" -> { row: 2, col: 1 } */
+declare function parseAddress(addr: string): {
+    row: number;
+    col: number;
+};
+/** Convert 0-based row and col to address string: (2, 1) -> "B3" */
+declare function toAddress(row: number, col: number): string;
+
+/** Parse CSV text into a 2D string array */
+declare function parseCSV(text: string): string[][];
+/** Stringify a 2D array to CSV text */
+declare function stringifyCSV(data: string[][]): string;
+/** Convert CSV text to a WorkbookData */
+declare function csvToWorkbook(csv: string, sheetName?: string): WorkbookData;
+/** Convert WorkbookData active sheet to CSV */
+declare function workbookToCSV(workbook: WorkbookData, sheetId?: string): string;
+
+type FormulaRangeFunction = (args: CellValue[][]) => CellValue;
+declare function registerFunction(name: string, fn: FormulaRangeFunction): void;
+
+export { type CellAddress, type CellData, type CellFormat, type CellMap, type CellRange, type CellValue, type ColumnWidths, type MergedRegion, type SelectionState, type SheetData, Spreadsheet, type SpreadsheetContextValue, type SpreadsheetProps, type TextAlign, type WorkbookData, columnToLetter, createEmptySheet, createEmptyWorkbook, csvToWorkbook, letterToColumn, parseAddress, parseCSV, registerFunction, stringifyCSV, toAddress, useSpreadsheet, workbookToCSV };