@galaxy-io/dls 1.6.0 → 2.0.0

package/dist/table/InfiniteSpreadsheet.d.ts

@@ -1,13 +1,143 @@
-import { type InfiniteSpreadsheetProps } from "./types";
-export { ColumnAlign, ColumnPin, ColumnResizeMode, TableDensity, TableVariant } from "./types";
-export type { ColumnSizingState, EditingCell, InfiniteSpreadsheetProps, Row, SpreadsheetColumnAction, SpreadsheetColumnDef, SpreadsheetHeaderAction, SpreadsheetRowAction, SpreadsheetRowsContext, } from "./types";
-export { CellEnrichmentStatus, SpreadsheetCellType } from "./types";
+import { type AriaAttributes, type CSSProperties, type ReactElement, type ReactNode, type RefAttributes } from "react";
+import { type SelectOption } from "../inputs/SelectInput.js";
+import type { TableCellContext, TableColumn, TableColumnLayout } from "./types.js";
+/** Row rung of the grid (canonical subset; the 1.x TableDensity members). Same rows as InfiniteTableSize. */
+export declare enum InfiniteSpreadsheetSize {
+    /** 32px rows, body_sm text, 24px editors. */
+    SMALL = "SMALL",
+    /** 48px rows, body_md text, 32px editors. The default. */
+    MEDIUM = "MEDIUM",
+    /** 52px rows, body_lg text, 36px editors. */
+    LARGE = "LARGE"
+}
+/** Type of a column's values; picks the display format and the editor. */
+export declare enum SpreadsheetCellType {
+    /** Free text; edited with TextInput. */
+    TEXT = "TEXT",
+    /** A number; mono, right-aligned, edited with NumberInput. */
+    NUMBER = "NUMBER",
+    /** Yes / no; edited with SwitchInput, or toggled with Space. */
+    BOOLEAN = "BOOLEAN",
+    /** One of `options`; edited with SelectInput. */
+    ENUM = "ENUM",
+    /** A date; edited with DateInput. */
+    DATE = "DATE"
+}
+/** Background work on a cell's value, shown as a dot (`IDLE` shows none). */
+export declare enum SpreadsheetCellStatus {
+    /** Nothing in progress: no dot. */
+    IDLE = "IDLE",
+    /** Queued. */
+    PENDING = "PENDING",
+    /** In progress: the dot pulses. */
+    RUNNING = "RUNNING",
+    /** Finished. */
+    COMPLETE = "COMPLETE",
+    /** Failed. */
+    ERROR = "ERROR"
+}
+/** Fields every spreadsheet column has (TableColumn without sorting, with editing). */
+interface SpreadsheetColumnBase<TData> extends Omit<TableColumn<TData>, "accessor" | "cell" | "canSort"> {
+    /** Cells show their value but cannot be edited. @default false */
+    isReadOnly?: boolean;
+    /** Status of background work on a cell's value, shown as a dot before it. */
+    getCellStatus?: (row: TData, rowIndex: number) => SpreadsheetCellStatus;
+}
+/** Fields that depend on the value type. */
+interface SpreadsheetTypedColumn<TData, TType extends SpreadsheetCellType, TValue, TCommit> {
+    /** The type of the values; picks the display format and the editor. */
+    cellType: TType;
+    /** Reads the cell value from a row. */
+    accessor(row: TData): TValue;
+    /** Custom display of the cell (not the editor). */
+    cell?(context: TableCellContext<TData, TValue>): ReactNode;
+    /** Called with the committed value when it differs from the current one. The app stores it. */
+    onCellChange?: (value: TCommit, row: TData, rowIndex: number) => void;
+}
+/** One column of an InfiniteSpreadsheet, typed by its `cellType`. */
+export type InfiniteSpreadsheetColumn<TData> = SpreadsheetColumnBase<TData> & (SpreadsheetTypedColumn<TData, SpreadsheetCellType.TEXT, string | null, string> | SpreadsheetTypedColumn<TData, SpreadsheetCellType.NUMBER, number | null, number | null> | SpreadsheetTypedColumn<TData, SpreadsheetCellType.BOOLEAN, boolean, boolean> | (SpreadsheetTypedColumn<TData, SpreadsheetCellType.ENUM, string | null, string | null> & {
+    /** The choices; `id` is the stored value, `label` what the cell shows. */
+    options: SelectOption[];
+}) | SpreadsheetTypedColumn<TData, SpreadsheetCellType.DATE, Date | null, Date | null>);
+/** A cell, by row index and column id. */
+export interface SpreadsheetCellPosition {
+    /** Row index, from 0. */
+    rowIndex: number;
+    /** `id` of the column. */
+    columnId: string;
+}
+export interface InfiniteSpreadsheetProps<TData> extends AriaAttributes {
+    /** The columns in their default order; each declares its `cellType` and how to read and commit its value. */
+    columns: InfiniteSpreadsheetColumn<TData>[];
+    /** Number of rows, loaded or not. Grow it as pages arrive or rows are added. */
+    totalRowCount: number;
+    /** Returns the row at `index`, or `undefined` while it is not loaded (a skeleton row). Called for visible rows only. */
+    getRowData: (index: number) => TData | undefined;
+    /**
+     * Stable identity of a loaded row, for React keys.
+     * @default (row, index) => String(index)
+     */
+    getRowId?: (row: TData, index: number) => string;
+    /**
+     * Row rung: 32 / 48 / 52px rows, with matching text and editor sizes.
+     * @default InfiniteSpreadsheetSize.MEDIUM
+     */
+    size?: InfiniteSpreadsheetSize;
+    /**
+     * Rows are loading: skeleton rows replace an empty body, or follow the last row while more load. Sets `aria-busy`.
+     * @default false
+     */
+    isLoading?: boolean;
+    /** Message from the app when loading failed. Shown as an error state in an empty body, or as an error row after the last row. `onEndReached` pauses while it is set. */
+    error?: string;
+    /**
+     * Shown when `totalRowCount` is 0 and the grid is neither loading nor in error. With `onAddRow`, the default adds an "Add row" action.
+     * @default <EmptyState header="No rows" />
+     */
+    emptyState?: ReactNode;
+    /** Called when the last row comes within 500px of view, for loading the next page; called again only after `totalRowCount` grows. */
+    onEndReached?: () => void;
+    /** Menu rows (`MenuItem`, `MenuSeparator`, …) for a row's actions menu, opened from a trailing "…" button. Return `null` for a row with no actions. */
+    rowActions?: (row: TData, rowIndex: number) => ReactNode;
+    /** Shows an "Add row" button after the last row. The app adds the row and grows `totalRowCount`. */
+    onAddRow?: () => void;
+    /** Shows an "Add column" button at the end of the header. */
+    onAddColumn?: () => void;
+    /** Controlled cell being edited (`null`: none). When set, the grid calls `onEditingCellChange` and lets the caller decide. */
+    editingCell?: SpreadsheetCellPosition | null;
+    /** Called when editing starts on a cell and with `null` when it is committed or cancelled (after `onCellChange`). */
+    onEditingCellChange?: (cell: SpreadsheetCellPosition | null) => void;
+    /** Controlled column arrangement: order, hidden column ids and widths. Persist it to keep a user's layout. */
+    columnLayout?: TableColumnLayout;
+    /**
+     * Initial arrangement while uncontrolled (for example, columns hidden by default).
+     * @default {}
+     */
+    defaultColumnLayout?: TableColumnLayout;
+    /** Called with the full new arrangement when the user resizes, moves, hides, shows or resets columns. Columns are always resizable here. */
+    onColumnLayoutChange?: (columnLayout: TableColumnLayout) => void;
+    /**
+     * Lets the user reorder columns (drag a header, or Alt+ArrowLeft / Alt+ArrowRight on it) and show or hide them from a Columns menu at the end of the header.
+     * @default false
+     */
+    canCustomizeColumns?: boolean;
+    /** Accessible name of the grid. Use `aria-labelledby` instead when a visible heading names it. */
+    ariaLabel?: string;
+    /** DOM id on the root `<div>`. */
+    id?: string;
+    /** Any `data-*` attribute, forwarded to the root `<div>`. */
+    [dataAttribute: `data-${string}`]: string | number | boolean | undefined;
+    /** Extra class on the root `<div>`. */
+    className?: string;
+    /** Inline style on the root `<div>`; only for setting CSS custom properties. */
+    style?: CSSProperties;
+}
 /**
- * An editable grid — cell-level editing, keyboard navigation between cells, and
- * per-row actions, over the same infinite-scroll machinery as `InfiniteTable`.
- *
- * Reach for this when cells are inputs. When the data is read-only, the tables
- * are lighter.
+ * The public, generic call signature (`TData` inferred from `getRowData` and `columns`). Never
+ * called: it only types the default export. An arrow function rather than a type literal, so
+ * react-docgen-typescript reads the props for the Docs tab (the SelectInput precedent).
  */
-declare function InfiniteSpreadsheet<TData>(props: InfiniteSpreadsheetProps<TData>): import("react").JSX.Element;
+declare const INFINITE_SPREADSHEET_SIGNATURE: <TData>(_props: InfiniteSpreadsheetProps<TData> & RefAttributes<HTMLDivElement>) => ReactElement | null;
+/** The editable grid. */
+declare const InfiniteSpreadsheet: typeof INFINITE_SPREADSHEET_SIGNATURE;
 export default InfiniteSpreadsheet;