@galaxy-io/dls 1.6.0 → 2.0.0

package/dist/table/InfiniteTable.d.ts

@@ -1,17 +1,119 @@
-import React from "react";
-import { type Table as TanstackTable } from "@tanstack/react-table";
-import { type InfiniteTableProps } from "./types";
-export { ColumnAlign, ColumnPin, ColumnResizeMode, TableDensity, TableVariant } from "./types";
-export type { ColumnDef, ColumnSizingState, EstimateColumnWidthOptions, InfiniteTableProps, Row, } from "./types";
-export { estimateColumnWidth } from "./utils";
+import { type AriaAttributes, type CSSProperties, type KeyboardEvent, type MouseEvent, type ReactElement, type ReactNode, type RefAttributes } from "react";
+import type { TableColumn, TableColumnLayout, TableSort } from "./types.js";
+/** Row rung of the table (canonical subset; the 1.x TableDensity members). */
+export declare enum InfiniteTableSize {
+    /** 32px rows, body_sm text. Dense lists and side panels. */
+    SMALL = "SMALL",
+    /** 48px rows, body_md text. The default. */
+    MEDIUM = "MEDIUM",
+    /** 52px rows, body_lg text. Rows with avatars or two-line cells. */
+    LARGE = "LARGE"
+}
+export interface InfiniteTableProps<TData> extends AriaAttributes {
+    /** The columns in their default order. See `TableColumn` in `@galaxy-io/dls/table/types`. */
+    columns: TableColumn<TData>[];
+    /** The rows loaded so far, in display order (unless the table sorts them). */
+    data: TData[];
+    /**
+     * Stable identity of a row. Selection, expansion, `activeRowId` and React keys use it; pass it whenever rows can be inserted, removed or re-sorted.
+     * @default (row, index) => String(index)
+     */
+    getRowId?: (row: TData, index: number) => string;
+    /**
+     * Row rung: 32 / 48 / 52px rows with matching type, checkbox and button sizes.
+     * @default InfiniteTableSize.MEDIUM
+     */
+    size?: InfiniteTableSize;
+    /**
+     * 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 in the body when there are no rows and the table is neither loading nor in error. Usually an `EmptyState` with an action.
+     * @default <EmptyState header="No results" />
+     */
+    emptyState?: ReactNode;
+    /** Called when the last row comes within 500px of view, for loading the next page; called again only after `data` grows. Setting it also makes sorting server-side. */
+    onEndReached?: () => void;
+    /** Called when a row is clicked or Enter is pressed on it. Not called for clicks on a control inside the row. */
+    onRowClick?: (row: TData, event: MouseEvent<HTMLTableRowElement> | KeyboardEvent<HTMLTableRowElement>) => void;
+    /** Id of the row shown as current, such as the one open in a side panel. Display only: set it from `onRowClick`. */
+    activeRowId?: string | null;
+    /** 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;
+    /** Controlled sorted column. `null` is unsorted. */
+    sort?: TableSort | null;
+    /**
+     * Initial sort while uncontrolled.
+     * @default null
+     */
+    defaultSort?: TableSort | null;
+    /** Called with the next sort when a sortable header is pressed: ascending, then descending, then unsorted. */
+    onSortChange?: (sort: TableSort | null) => void;
+    /**
+     * Adds a leading checkbox column, a select-all checkbox in the header, and Space / Shift+Space to select rows.
+     * @default false
+     */
+    isSelectable?: boolean;
+    /** Controlled selected row ids. Pass it with `onChange`. */
+    value?: string[];
+    /**
+     * Initial selected row ids while uncontrolled.
+     * @default []
+     */
+    defaultValue?: string[];
+    /** Called with the new list of selected row ids, in row order. */
+    onChange?: (value: string[]) => void;
+    /** Content of a row's expanded panel, shown under it. Adds a leading caret column. Return `null` for rows that cannot expand. Called for every rendered row, so keep it cheap. */
+    renderExpandedRow?: (row: TData) => ReactNode | null;
+    /** Controlled expanded row ids. */
+    expandedIds?: string[];
+    /**
+     * Initial expanded row ids while uncontrolled.
+     * @default []
+     */
+    defaultExpandedIds?: string[];
+    /** Called with the new list whenever a row expands or collapses. */
+    onExpandedIdsChange?: (expandedIds: string[]) => 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. Fires on every resize step; debounce before saving. */
+    onColumnLayoutChange?: (columnLayout: TableColumnLayout) => void;
+    /**
+     * Adds a drag handle at the end of each header cell (arrow keys too). Columns opt out with `canResize: false`.
+     * @default false
+     */
+    canResizeColumns?: boolean;
+    /**
+     * 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. Columns opt out of hiding with `canHide: false`.
+     * @default false
+     */
+    canCustomizeColumns?: boolean;
+    /** Accessible name of the table. 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;
+}
 /**
- * A data table with infinite scroll, sorting, row selection, expandable rows and
- * resizable columns. Define the shape with `ColumnDef[]`; `TData` is inferred
- * from your row type.
- *
- * Renders every loaded row. Past a few thousand rows reach for
- * `VirtualizedInfiniteTable`, which shares the same column and row API.
+ * The public, generic call signature (`TData` inferred from `data` 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 InfiniteTable<TData>(props: InfiniteTableProps<TData>): React.JSX.Element;
+declare const INFINITE_TABLE_SIGNATURE: <TData>(_props: InfiniteTableProps<TData> & RefAttributes<HTMLDivElement>) => ReactElement | null;
+/** The read-only data table. */
+declare const InfiniteTable: typeof INFINITE_TABLE_SIGNATURE;
 export default InfiniteTable;
-export type { TanstackTable as Table };