@bmsuisse/datagrid 0.38.0 → 0.40.0

package/dist/index.d.ts

@@ -121,6 +121,10 @@ interface FilterLabels {
     clear: string;
     /** NumberHistogramFilter's `loadValues` in-flight message. */
     loading: string;
+    /** NumberHistogramFilter: `loadValues` rejected. */
+    loadFailed: string;
+    /** NumberHistogramFilter: retry action next to `loadFailed`. */
+    retry: string;
     dateToday: string;
     dateLast7Days: string;
     dateThisMonth: string;
@@ -1483,6 +1487,28 @@ interface ActionsMenuProps<TRow> {
  */
 declare function ActionsMenu<TRow>({ items, ctx, triggerLabel }: ActionsMenuProps<TRow>): ReactElement | null;
 
+/** Structured error shown by the grid's error states. Same shape as `@bmsuisse/ui`'s `ErrorInfo`. */
+interface ErrorInfo {
+    title?: string;
+    message?: string;
+    /** Technical details (stack, response body) — shown behind a "Show details" toggle. */
+    details?: string;
+}
+/** What the grids accept for `error` — pass a TanStack Query / SWR / `catch` error straight through. */
+type ErrorInput = ErrorInfo | Error | string | null | undefined | false;
+declare function toErrorInfo(error: unknown): ErrorInfo | undefined;
+/** User-facing strings of the grid's loading/error/empty states. Anything omitted keeps its English default. */
+interface GridStatusLabels {
+    loading: string;
+    noResults: string;
+    errorTitle: string;
+    retry: string;
+    showDetails: string;
+    /** TreeDataGrid: shown on a node whose lazy children failed to load. */
+    nodeLoadFailed: string;
+}
+declare const defaultGridStatusLabels: GridStatusLabels;
+
 /**
  * `"client"`: the grid owns filtering/sorting/pagination and evaluates them
  * in-memory against the full `data` array (via `evaluateFilter`).
@@ -1537,6 +1563,17 @@ interface DataGridProps<TRow> {
      * The two are OR'd together if both happen to be set. Defaults to `false`.
      */
     loading?: boolean;
+    /**
+     * The data fetch failed. With no rows to show, the body is replaced by an error
+     * state (title, message, collapsible details, Retry); with stale rows still shown,
+     * they stay and a slim error banner appears above them. Accepts a string, an
+     * `Error` (message + stack as details) or `{ title, message, details }`.
+     */
+    error?: ErrorInput;
+    /** Shows a Retry action in the error state/banner. */
+    onRetry?: () => void;
+    /** Overrides the grid's "Loading...", "No results." and error-state strings. */
+    statusLabels?: Partial<GridStatusLabels>;
     /** Per-row kebab menu. Evaluated with `ctx.row` set to that row. */
     rowActions?: MenuItem<TRow>[];
     /** Toolbar menu above the table. Evaluated with `ctx.selectedRows` set. */
@@ -1801,7 +1838,7 @@ interface DataGridProps<TRow> {
  * (`"server"`). Column filter UI defaults to the type-appropriate widget
  * from `src/filter` unless a column supplies its own `cell` renderer.
  */
-declare function DataGrid<TRow extends RowData>({ columns, dataSource, getRowId, rowActions, headerActions, enableMultiSort, initialState, columnVisibility, renderDetail, enableColumnResizing, columnResizeMode, columnSizing: controlledColumnSizing, onColumnSizingChange, virtualize, showPagination, getRowProps, getRowTestId, gridState, onGridStateChange, selectedIds: controlledSelectedIds, onSelectedIdsChange, testId, loading: loadingProp, groupBy, renderGroupHeader, defaultGroupsExpanded, expandedGroups: controlledExpandedGroups, onExpandedGroupsChange, zebra, showTotals, editing, cellEditing, filterLabels, }: DataGridProps<TRow>): ReactElement;
+declare function DataGrid<TRow extends RowData>({ columns, dataSource, getRowId, rowActions, headerActions, enableMultiSort, initialState, columnVisibility, renderDetail, enableColumnResizing, columnResizeMode, columnSizing: controlledColumnSizing, onColumnSizingChange, virtualize, showPagination, getRowProps, getRowTestId, gridState, onGridStateChange, selectedIds: controlledSelectedIds, onSelectedIdsChange, testId, loading: loadingProp, error, onRetry, statusLabels, groupBy, renderGroupHeader, defaultGroupsExpanded, expandedGroups: controlledExpandedGroups, onExpandedGroupsChange, zebra, showTotals, editing, cellEditing, filterLabels, }: DataGridProps<TRow>): ReactElement;
 
 interface GridStateController {
     state: GridState;
@@ -1985,6 +2022,16 @@ interface TreeDataGridProps<TRow> extends TreeAccessors<TRow> {
      * Defaults to `false`.
      */
     loading?: boolean;
+    /**
+     * The root data fetch failed. With no rows, the body shows an error state (title,
+     * message, collapsible details, Retry); with rows, they stay and a slim banner
+     * appears above. Per-node lazy-load failures are handled separately (inline, per row).
+     */
+    error?: ErrorInput;
+    /** Shows a Retry action in the error state/banner. */
+    onRetry?: () => void;
+    /** Overrides the grid's "Loading...", "No results." and error-state strings. */
+    statusLabels?: Partial<GridStatusLabels>;
     /**
      * The column whose cell gets the depth indentation + expand/collapse
      * chevron prepended. Defaults to the first column in `columns`.
@@ -2188,6 +2235,20 @@ interface TreeDataGridProps<TRow> extends TreeAccessors<TRow> {
      * bottom) but neither requires the other. Defaults to false.
      */
     showTotals?: boolean;
+    /**
+     * Opt-in: defaults to false. Gives every header a drag handle (and
+     * ArrowLeft/ArrowRight keyboard resize) on its trailing edge, and switches
+     * the table to `table-layout: fixed` so a dragged width is exactly the
+     * rendered width. A column without an explicit `width` stays flexible and
+     * absorbs the leftover space until it is resized itself.
+     */
+    enableColumnResizing?: boolean;
+    /**
+     * Controlled column widths in px, keyed by column id. Both must be supplied
+     * together to control it — omit both for `<TreeDataGrid>` to own the state.
+     */
+    columnSizing?: ColumnSizingState;
+    onColumnSizingChange?: (sizing: ColumnSizingState) => void;
     /**
      * Enables the same built-in inline-editing workflow `<DataGrid>` has:
      * any column with `editable` set renders as an interactive editor
@@ -2216,7 +2277,7 @@ interface TreeDataGridProps<TRow> extends TreeAccessors<TRow> {
  * column's cell matches `treeColumnId` (defaults to `columns[0]`); every
  * other column renders exactly like it would in `<DataGrid>`.
  */
-declare function TreeDataGrid<TRow>({ columns, data, loading, treeColumnId, columnVisibility, getRowId, getChildren, hasChildren, onLoadChildren, initialExpandedLevel, expanded: controlledExpanded, onExpandedChange, childrenMap: controlledChildrenMap, onChildrenMapChange, indentSize, getRowProps, getRowTestId, rowActions, virtualizeThreshold, estimatedRowHeight, maxBodyHeight, testId, selectedIds: controlledSelectedIds, onSelectedIdsChange, getRowSelectionState, isRowSelectionDisabled, groupBy, renderGroupHeader, defaultGroupsExpanded, expandedGroups: controlledExpandedGroups, onExpandedGroupsChange, zebra, showTotals, editing, }: TreeDataGridProps<TRow>): ReactElement;
+declare function TreeDataGrid<TRow>({ columns, data, loading, error, onRetry, statusLabels, treeColumnId, columnVisibility, getRowId, getChildren, hasChildren, onLoadChildren, initialExpandedLevel, expanded: controlledExpanded, onExpandedChange, childrenMap: controlledChildrenMap, onChildrenMapChange, indentSize, getRowProps, getRowTestId, rowActions, virtualizeThreshold, estimatedRowHeight, maxBodyHeight, testId, selectedIds: controlledSelectedIds, onSelectedIdsChange, getRowSelectionState, isRowSelectionDisabled, groupBy, renderGroupHeader, defaultGroupsExpanded, expandedGroups: controlledExpandedGroups, onExpandedGroupsChange, zebra, showTotals, editing, enableColumnResizing, columnSizing: controlledColumnSizing, onColumnSizingChange, }: TreeDataGridProps<TRow>): ReactElement;
 
 interface FlatTreeRow<TRow> {
     row: TRow;
@@ -2272,4 +2333,4 @@ interface UseTreeStateOptions<TRow> extends TreeAccessors<TRow> {
  */
 declare function useTreeState<TRow>({ data, getRowId, getChildren, hasChildren, onLoadChildren, expanded: controlledExpanded, onExpandedChange, childrenMap: controlledChildrenMap, onChildrenMapChange, }: UseTreeStateOptions<TRow>): TreeStateController<TRow>;
 
-export { ActionsMenu, type BaseColumn, type BooleanColumn, BooleanEditor, BooleanFilter, type CellAddress, type CellChange, type CellEditingCellContext, type CellEditingOptions, type CellEditingState, type CellRange, type CellSelectionController, type CellSelectionOptions, type ClientProcessingResult, type ColumnAlign, type ColumnDef, type ColumnGroup, ColumnSelector, type ColumnSelectorProps, type ColumnVisibility, type CompositeFilterDescriptor, DataGrid, type DataGridProps, type DataSource, type DateColumn, DateEditor, DateRangeFilter, type DebouncedCallback, EditFieldError, type EditWidgetProps, type EditedRow, EditingBar, type EditingBarProps, type EditingCellContext, type EditingOptions, type EditingState, type EnumColumn, EnumEditor, EnumFilter, type EnumOption, type FilterDescriptor, type FilterLabels, FilterLabelsProvider, type FilterOperator, type FilterWidgetProps, type FlatTreeRow, type GridState, type GridStateController, type GroupExpansionController, type MenuItem, type MenuItemContext, MultilineStringEditor, type NavigationDirection, type NormalizedRange, type NumberColumn, NumberComparisonFilter, NumberEditor, NumberHistogramFilter, type NumberHistogramFilterProps, NumberRangeFilter, type PendingRowEdit, type ResolvedMenuItem, SelectionOverlay, type SortDescriptor, type StickyGroupHeaderTop, type StringColumn, StringEditor, StringFilter, type TreeAccessors, TreeDataGrid, type TreeDataGridProps, type TreeStateController, UNARY_OPERATORS, type UseTreeStateOptions, alignClassName, applyColumnOrder, buildIndexMap, canHideColumn, canHideGroup, cellsInRange, coerceValueForColumn, computeFillChanges, countVisible, defaultAlign, defaultFilterLabels, defaultFormat, editErrorId, evaluateFilter, extendRangeForFill, facetedNumberValues, fieldKey, flattenTree, getColumnValue, groupColumns, isCellInRange, isColumnVisible, isCompositeFilterDescriptor, isEditable, isFilterDescriptor, isFilterable, isSortable, mergeFilterLabels, moveColumnBefore, normalizeRange, orderStorageKeyFor, parseTsv, processClientData, rangeToTsv, renderCellModeCell, renderDefaultEditWidget, renderDefaultFilterWidget, renderEditableCell, resolveMenuItems, storageKeyFor, toDate, useCellEditingState, useCellSelection, useDebouncedCallback, useEditingState, useFilterLabels, useGridState, useGroupExpansion, useStickyGroupHeaderTop, useTreeState, useVisibleColumns };
+export { ActionsMenu, type BaseColumn, type BooleanColumn, BooleanEditor, BooleanFilter, type CellAddress, type CellChange, type CellEditingCellContext, type CellEditingOptions, type CellEditingState, type CellRange, type CellSelectionController, type CellSelectionOptions, type ClientProcessingResult, type ColumnAlign, type ColumnDef, type ColumnGroup, ColumnSelector, type ColumnSelectorProps, type ColumnVisibility, type CompositeFilterDescriptor, DataGrid, type DataGridProps, type DataSource, type DateColumn, DateEditor, DateRangeFilter, type DebouncedCallback, EditFieldError, type EditWidgetProps, type EditedRow, EditingBar, type EditingBarProps, type EditingCellContext, type EditingOptions, type EditingState, type EnumColumn, EnumEditor, EnumFilter, type EnumOption, type ErrorInfo, type ErrorInput, type FilterDescriptor, type FilterLabels, FilterLabelsProvider, type FilterOperator, type FilterWidgetProps, type FlatTreeRow, type GridState, type GridStateController, type GridStatusLabels, type GroupExpansionController, type MenuItem, type MenuItemContext, MultilineStringEditor, type NavigationDirection, type NormalizedRange, type NumberColumn, NumberComparisonFilter, NumberEditor, NumberHistogramFilter, type NumberHistogramFilterProps, NumberRangeFilter, type PendingRowEdit, type ResolvedMenuItem, SelectionOverlay, type SortDescriptor, type StickyGroupHeaderTop, type StringColumn, StringEditor, StringFilter, type TreeAccessors, TreeDataGrid, type TreeDataGridProps, type TreeStateController, UNARY_OPERATORS, type UseTreeStateOptions, alignClassName, applyColumnOrder, buildIndexMap, canHideColumn, canHideGroup, cellsInRange, coerceValueForColumn, computeFillChanges, countVisible, defaultAlign, defaultFilterLabels, defaultFormat, defaultGridStatusLabels, editErrorId, evaluateFilter, extendRangeForFill, facetedNumberValues, fieldKey, flattenTree, getColumnValue, groupColumns, isCellInRange, isColumnVisible, isCompositeFilterDescriptor, isEditable, isFilterDescriptor, isFilterable, isSortable, mergeFilterLabels, moveColumnBefore, normalizeRange, orderStorageKeyFor, parseTsv, processClientData, rangeToTsv, renderCellModeCell, renderDefaultEditWidget, renderDefaultFilterWidget, renderEditableCell, resolveMenuItems, storageKeyFor, toDate, toErrorInfo, useCellEditingState, useCellSelection, useDebouncedCallback, useEditingState, useFilterLabels, useGridState, useGroupExpansion, useStickyGroupHeaderTop, useTreeState, useVisibleColumns };