@jielga/tmdatagrid 2.0.0-beta.1 → 2.0.0-beta.2

package/dist/index.d.ts

@@ -59,7 +59,7 @@ type TMDataGridEditActionsProps = {
   renderActions?: (args: TMDataGridEditActionsSlotArgs) => ReactNode;
 };
 /**
- * Batch mode's toolbar chrome: Save with the dirty-row count, and Discard.
+ * Draft mode's toolbar chrome: Save with the dirty-row count, and Discard.
  * Both read the edit store, so they grey out while nothing is dirty and the
  * Save spins while a submit is in flight. Works under any `editing.mode` - a
  * cellConfirm grid accumulating drafts can offer the same pair - and renders
@@ -262,7 +262,7 @@ declare function tmDataGridFilterFn<TFeatures extends TableFeatures, TData exten
  * How commits happen - one axis, each mode a thin policy over the same
  * engine. See `editMode` on `UseTMDataGridOptions`.
  */
-type TMDataGridEditMode = "cell" | "cellConfirm" | "row" | "batch";
+type TMDataGridEditMode = "cell" | "cellConfirm" | "row" | "draft";
 /**
  * One editing row's live form. TanStack Form's `FormApi`, not a wrapper: the
  * engine is a form library, and everything mid-edit - values, dirty state,
@@ -344,6 +344,12 @@ type TMDataGridEditRowProjection = {
   /** A row-level error - a pathless `.refine()`, or a rejected commit. */
   hasRowError: boolean;
   isSubmitting: boolean;
+  /**
+   * The row as drafted - the form's `state.values`. Reference-stable while no
+   * value changes, so a cell may subscribe to it and repaint only when its
+   * row's draft actually moves.
+   */
+  values: TMDataGridRowData;
 };
 /**
  * The grid-facing index of everything mid-edit. A projection synced from the
@@ -363,15 +369,21 @@ type TMDataGridEditState = {
   } | null;
   /**
    * Rows with a live form. In cell mode at most one; in row, cellConfirm and
-   * batch, as many as the user opened - which rows are editing.
+   * draft, as many as the user opened - which rows are editing.
    */
   openRowIds: ReadonlyArray<string>;
   rows: Record<string, TMDataGridEditRowProjection>;
-  /** Phase 4 - rows being created, not yet in `data`. */
+  /**
+   * Rows being created, not yet in `data`. `confirmed` is draft mode's
+   * "entered, awaiting Save all": the entry row renders as a value row until
+   * `begin` re-opens it. Under the immediate modes a confirm commits through
+   * `onRowAdd` and the entry is dropped, so there it never turns `true`.
+   */
   newRows: ReadonlyArray<{
     tempId: string;
+    confirmed: boolean;
   }>;
-  /** Phase 4 - rows marked deleted under batch mode. */
+  /** Rows marked deleted under draft mode. */
   deletedRowIds: ReadonlyArray<string>;
 };
 type ErasedRow = Row<TMDataGridFeatures, TMDataGridRowData>;
@@ -492,13 +504,13 @@ type TMDataGridRowDeleteArgs<TData extends RowData> = {
   rowId: string;
   row: Row<TMDataGridFeatures, TData>;
 };
-/** What `submitAll` hands `onEditCommitBatch` - everything pending at once. */
-type TMDataGridEditCommitBatchArgs<TData extends RowData> = {
+/** What `submitAll` hands `onEditCommitDrafts` - everything pending at once. */
+type TMDataGridEditCommitDraftsArgs<TData extends RowData> = {
   /** Every valid dirty existing row. */
   rows: Array<TMDataGridEditCommitArgs<TData>>;
   /** Every valid new row from the entry block. */
   added: Array<TMDataGridRowAddArgs<TData>>;
-  /** Ids marked deleted while the batch accumulated. */
+  /** Ids marked deleted while the drafts accumulated. */
   deleted: Array<string>;
 };
 /**
@@ -567,7 +579,7 @@ type TMDataGridEditApi = {
   deactivate: () => void;
   /** Drops every draft. */
   cancelAll: () => void;
-  /** Commits every open row - batch mode's save. `true` when all landed. */
+  /** Commits every open row - draft mode's save. `true` when all landed. */
   submitAll: () => Promise<boolean>;
   /** Writes the type's empty value into a cell and commits it - Delete. */
   clearCell: (rowId: string, columnId: string) => Promise<boolean>;
@@ -575,12 +587,12 @@ type TMDataGridEditApi = {
    * Opens a new entry row (the sticky block under the header) seeded from
    * `newRowDefaults`. Returns its temporary id - a form with no backing row
    * yet. Committing it calls `onRowAdd` (immediate modes) or joins
-   * `submitAll`'s `added` (batch).
+   * `submitAll`'s `added` (draft).
    */
   addRow: () => string;
   /**
    * Deletes a row: `onRowDelete` straight away under the immediate modes;
-   * under batch it toggles the id in `deletedRowIds` - the row renders
+   * under draft it toggles the id in `deletedRowIds` - the row renders
    * struck through until `submitAll` reports it. On an uncommitted entry
    * row it just discards the entry.
    */
@@ -701,8 +713,16 @@ type TMDataGridLabels = {
   discardNewRow: string;
   /** The lane's trash can. */
   deleteRow: string;
-  /** The lane's undo on a row marked deleted (batch). */
+  /** The lane's undo on a row marked deleted (draft). */
   restoreRow: string;
+  /** The lane's undo on a row with a dirty draft (draft) - drops it. */
+  revertRow: string;
+  /** The lane's state icon on a confirmed entry row (draft). */
+  rowStateNew: string;
+  /** The lane's state icon on a row with a dirty draft (draft). */
+  rowStateEdited: string;
+  /** The lane's state icon on a row marked deleted (draft). */
+  rowStateDeleted: string;
   cellCount: (count: number) => string;
   copy: string;
   exportCsv: string;
@@ -987,6 +1007,13 @@ type TMDataGridFeatureFlags = {
   editing: boolean;
   /** The commit policy, or `null` while editing is off. */
   editMode: TMDataGridEditMode | null;
+  /**
+   * Whether a confirmed entry row stays pinned in the sticky entry block
+   * until Save all - `editing.newRowsSticky`, draft mode only. Off by
+   * default: a confirmed row joins the scrolling flow instead, so entering
+   * many rows cannot fill the viewport with sticky chrome.
+   */
+  editNewRowsSticky: boolean;
   /** The generated row-number gutter - `enableRowNumbers`. Off by default. */
   rowNumbers: boolean;
   /**
@@ -1601,13 +1628,13 @@ type TMDataGridEditingCallbacks<TData extends RowData> = {
   newRowDefaults?: TData | (() => TData);
   /**
    * Called when an entry row commits: `Enter` or the lane's ✓ under the
-   * immediate modes, `submitAll` under batch. Create the record and let it
+   * immediate modes, `submitAll` under draft. Create the record and let it
    * arrive back through `data`; the engine's `tempId` never leaves the grid.
    */
   onRowAdd?: (args: TMDataGridRowAddArgs<TData>) => void | Promise<void>;
   /**
    * Called by `edit.deleteRow` under the immediate modes - confirmation, if
-   * any, belongs in here. Under batch, deletions accumulate in
+   * any, belongs in here. Under draft, deletions accumulate in
    * `edit.state.deletedRowIds` instead and are reported by `submitAll`.
    * Setting this also puts the trash can in the edit lane.
    */
@@ -1623,11 +1650,11 @@ type TMDataGridEditingCallbacks<TData extends RowData> = {
  * | `"cell"` | Enter, Tab, blur - Sheets | Escape |
  * | `"cellConfirm"` | ✓ or Enter only; blur keeps the draft | ✕ or Escape |
  * | `"row"` | Save in the edit lane, or Ctrl+Enter | Cancel, or Escape |
- * | `"batch"` | `edit.submitAll()` | `edit.cancelAll()` |
+ * | `"draft"` | `edit.submitAll()` | `edit.cancelAll()` |
  *
  * Setting `editing` makes `getRowId` required - drafts are keyed by row id,
  * and the index fallback would name a different record after any sort - and
- * `onCommitBatch` exists only under `mode: "batch"`, the one mode whose
+ * `onCommitDrafts` exists only under `mode: "draft"`, the one mode whose
  * `submitAll` calls it.
  *
  * The object may be written inline: the callbacks are read through a ref
@@ -1640,18 +1667,28 @@ type TMDataGridEditingCallbacks<TData extends RowData> = {
  * override the rest.
  */
 type TMDataGridEditingOptions<TData extends RowData> = TMDataGridEditingCallbacks<TData> & ({
-  mode: "batch";
+  mode: "draft";
   /**
-   * Batch mode's save, called once by `edit.submitAll()` with every
+   * Draft mode's save, called once by `edit.submitAll()` with every
    * valid dirty row. Without it, `submitAll` falls back to the per-row
    * {@link TMDataGridEditingCallbacks.onCommit} loop. Rows failing
    * validation stay open either way; a rejection keeps every draft.
    */
-  onCommitBatch?: (args: TMDataGridEditCommitBatchArgs<TData>) => void | Promise<void>;
+  onCommitDrafts?: (args: TMDataGridEditCommitDraftsArgs<TData>) => void | Promise<void>;
+  /**
+   * Keep confirmed entry rows pinned in the sticky entry block until
+   * Save all. Off by default: a confirmed row joins the scrolling
+   * flow above the body rows instead - the block a row is *typed*
+   * into is always sticky, but entered rows scroll, so entering many
+   * cannot fill the viewport with sticky chrome.
+   */
+  newRowsSticky?: boolean;
 } | {
-  mode: Exclude<TMDataGridEditMode, "batch">;
-  /** Only `"batch"`'s `submitAll` ever calls it - see the other branch. */
-  onCommitBatch?: never;
+  mode: Exclude<TMDataGridEditMode, "draft">;
+  /** Only `"draft"`'s `submitAll` ever calls it - see the other branch. */
+  onCommitDrafts?: never;
+  /** Confirmed entry rows exist only under `"draft"` - see there. */
+  newRowsSticky?: never;
 });
 type UseTMDataGridOptions<TData extends RowData> = Omit<TableOptions<TMDataGridFeatures, TData>, "features"> & ({
   editing?: undefined;
@@ -3069,4 +3106,4 @@ declare function getSelectableRowIds<TData extends RowData>(row: Row<TMDataGridF
  */
 declare function resolveRowSelectionClick<TData extends RowData>({ rows, rowId, anchorRowId, modifiers, selection, canReplaceSelection }: ResolveRowSelectionClickArgs<TData>): ResolvedRowSelection;
 //#endregion
-export { type BuildCellMatrixArgs, type ColumnStepArgs, DATA_STATE_SLICES, DEFAULT_CELL_EXPORT_OPTIONS, DEFAULT_TMDATAGRID_SIZE, DETAILS_COLUMN_ID, DgAutocompleteFilter, DgDateRangeFilter, DgRangeSliderFilter, DgTriStateFilter, EDIT_COLUMN_ID, FILTER_OPERATOR_LABELS, GROUP_COLUMN_ID, type MoveColumnArgs, PERSIST_PAYLOAD_VERSION, ROW_NUMBER_COLUMN_ID, type ResolveCellMoveArgs, type ResolveRangeBoundsArgs, type ResolveRowSelectionClickArgs, type ResolvedRowSelection, SELECT_COLUMN_ID, SETTINGS_STATE_SLICES, SIZE_CONTROL_SIZE, SIZE_ROW_HEIGHT, TMDATAGRID_LABELS_EN, TMDATAGRID_LABELS_SV, TMDataGrid, type TMDataGridAggregationName, type TMDataGridApi, TMDataGridBooleanEditor, type TMDataGridCapabilities, type TMDataGridCellCoords, type TMDataGridCellEventArgs, type TMDataGridCellExportOptions, type TMDataGridCellMatrix, type TMDataGridCellNav, type TMDataGridCellPosition, type TMDataGridCellRange, type TMDataGridCellSelectionMode, type TMDataGridColumnCapabilities, type TMDataGridColumnEditOptions, type TMDataGridColumnFilterOptions, type TMDataGridColumnLayout, type TMDataGridColumnMenuItemsArgs, type TMDataGridColumnMenuItemsRenderer, type TMDataGridColumnMeta, type TMDataGridColumnRegion, type TMDataGridColumnType, type TMDataGridContextValue, type TMDataGridDataSlice, TMDataGridDateEditor, type TMDataGridDetailsArgs, type TMDataGridDetailsRenderer, type TMDataGridDropSide, TMDataGridEditActions, type TMDataGridEditActionsActions, type TMDataGridEditActionsControls, type TMDataGridEditActionsProps, type TMDataGridEditActionsSlotArgs, type TMDataGridEditActionsState, type TMDataGridEditApi, type TMDataGridEditChange, type TMDataGridEditCommitArgs, type TMDataGridEditCommitBatchArgs, type TMDataGridEditField, type TMDataGridEditMode, type TMDataGridEditRowProjection, type TMDataGridEditState, type TMDataGridEditValueMap, type TMDataGridEditValueMapArgs, type TMDataGridEditingOptions, type TMDataGridEditorArgs, type TMDataGridEditorComponent, type TMDataGridExpandAllArgs, type TMDataGridExpandTarget, type TMDataGridFeatureFlags, type TMDataGridFeatures, type TMDataGridFieldValidate, type TMDataGridFilterControlArgs, type TMDataGridFilterControlComponent, type TMDataGridFilterOperator, TMDataGridFilterPills, type TMDataGridFilterPillsProps, type TMDataGridFilterValue, TMDataGridFilterValueInput, type TMDataGridFooterProps, type TMDataGridLabels, type TMDataGridLabelsOverride, TMDataGridMultiSelectEditor, TMDataGridNumberEditor, type TMDataGridOption, type TMDataGridOptionsArgs, type TMDataGridOptionsSource, type TMDataGridPaginationActions, type TMDataGridPaginationApi, type TMDataGridPaginationControls, type TMDataGridPaginationSlotArgs, type TMDataGridPaginationState, type TMDataGridPersistKey, type TMDataGridPersistence, type TMDataGridProps, type TMDataGridQuickSearchMode, type TMDataGridRangeBounds, type TMDataGridRowAddArgs, type TMDataGridRowClickModifiers, type TMDataGridRowContextMenuArgs, type TMDataGridRowContextMenuRenderer, type TMDataGridRowData, type TMDataGridRowDeleteArgs, type TMDataGridRowEditForm, type TMDataGridRowStyle, type TMDataGridRowValidators, type TMDataGridScrollAlign, type TMDataGridScrollToRowArgs, TMDataGridSearch, type TMDataGridSearchProps, TMDataGridSelectEditor, type TMDataGridSelectionMode, type TMDataGridSettingsSlice, type TMDataGridSize, type TMDataGridStorageMode, TMDataGridStringEditor, type TMDataGridTable, type TMDataGridTableMeta, type TMDataGridTableProps, type TMDataGridUiActions, type TMDataGridUiState, type TMDataGridUiStore, type UseTMDataGridOptions, aggregateColumn, areAllRowsExpanded, autosizeColumn, boundsCellCount, boundsEdges, buildCellMatrix, buildGridCellMatrix, clearedValueForType, createTMDataGridColumnHelper, downloadTextFile, emptyValueForOperator, exportGridToCsv, formatExportValue, formatFilterLabel, formatGroupValue, fuzzyGlobalFilterFn, getColumnCapabilities, getColumnDefaultOperator, getColumnFilterControl, getColumnLabel, getColumnRegion, getColumnType, getDefaultOperator, getDisplayedRows, getEditFieldName, getGridCapabilities, getGroupDataRows, getOperatorsForType, getSelectableRowIds, getStepTargetColumn, getTMDataGridPaginationApi, isColumnEditableForRow, isColumnReorderable, isControlColumn, isFilterActive, isGeneratedColumn, isPagingActive, isSameCell, isWithinBounds, keepGeneratedColumnsOutermost, measureColumnContentWidth, mergeLabels, moveColumn, moveColumnByStep, normalizeFieldValidate, openColumnFilter, operatorNeedsValue, operatorTakesArrayValue, operatorTakesRangeValue, optionsToComboboxData, readFeatureFlags, resolveCellMove, resolveColumnOptions, resolveExpandAll, resolveRangeBounds, resolveRowSelectionClick, tmDataGridFeatures, toClipboardText, toExcelCsv, useCellControlTabIndex, useTMDataGrid, useTMDataGridContext, writeClipboardText };
+export { type BuildCellMatrixArgs, type ColumnStepArgs, DATA_STATE_SLICES, DEFAULT_CELL_EXPORT_OPTIONS, DEFAULT_TMDATAGRID_SIZE, DETAILS_COLUMN_ID, DgAutocompleteFilter, DgDateRangeFilter, DgRangeSliderFilter, DgTriStateFilter, EDIT_COLUMN_ID, FILTER_OPERATOR_LABELS, GROUP_COLUMN_ID, type MoveColumnArgs, PERSIST_PAYLOAD_VERSION, ROW_NUMBER_COLUMN_ID, type ResolveCellMoveArgs, type ResolveRangeBoundsArgs, type ResolveRowSelectionClickArgs, type ResolvedRowSelection, SELECT_COLUMN_ID, SETTINGS_STATE_SLICES, SIZE_CONTROL_SIZE, SIZE_ROW_HEIGHT, TMDATAGRID_LABELS_EN, TMDATAGRID_LABELS_SV, TMDataGrid, type TMDataGridAggregationName, type TMDataGridApi, TMDataGridBooleanEditor, type TMDataGridCapabilities, type TMDataGridCellCoords, type TMDataGridCellEventArgs, type TMDataGridCellExportOptions, type TMDataGridCellMatrix, type TMDataGridCellNav, type TMDataGridCellPosition, type TMDataGridCellRange, type TMDataGridCellSelectionMode, type TMDataGridColumnCapabilities, type TMDataGridColumnEditOptions, type TMDataGridColumnFilterOptions, type TMDataGridColumnLayout, type TMDataGridColumnMenuItemsArgs, type TMDataGridColumnMenuItemsRenderer, type TMDataGridColumnMeta, type TMDataGridColumnRegion, type TMDataGridColumnType, type TMDataGridContextValue, type TMDataGridDataSlice, TMDataGridDateEditor, type TMDataGridDetailsArgs, type TMDataGridDetailsRenderer, type TMDataGridDropSide, TMDataGridEditActions, type TMDataGridEditActionsActions, type TMDataGridEditActionsControls, type TMDataGridEditActionsProps, type TMDataGridEditActionsSlotArgs, type TMDataGridEditActionsState, type TMDataGridEditApi, type TMDataGridEditChange, type TMDataGridEditCommitArgs, type TMDataGridEditCommitDraftsArgs, type TMDataGridEditField, type TMDataGridEditMode, type TMDataGridEditRowProjection, type TMDataGridEditState, type TMDataGridEditValueMap, type TMDataGridEditValueMapArgs, type TMDataGridEditingOptions, type TMDataGridEditorArgs, type TMDataGridEditorComponent, type TMDataGridExpandAllArgs, type TMDataGridExpandTarget, type TMDataGridFeatureFlags, type TMDataGridFeatures, type TMDataGridFieldValidate, type TMDataGridFilterControlArgs, type TMDataGridFilterControlComponent, type TMDataGridFilterOperator, TMDataGridFilterPills, type TMDataGridFilterPillsProps, type TMDataGridFilterValue, TMDataGridFilterValueInput, type TMDataGridFooterProps, type TMDataGridLabels, type TMDataGridLabelsOverride, TMDataGridMultiSelectEditor, TMDataGridNumberEditor, type TMDataGridOption, type TMDataGridOptionsArgs, type TMDataGridOptionsSource, type TMDataGridPaginationActions, type TMDataGridPaginationApi, type TMDataGridPaginationControls, type TMDataGridPaginationSlotArgs, type TMDataGridPaginationState, type TMDataGridPersistKey, type TMDataGridPersistence, type TMDataGridProps, type TMDataGridQuickSearchMode, type TMDataGridRangeBounds, type TMDataGridRowAddArgs, type TMDataGridRowClickModifiers, type TMDataGridRowContextMenuArgs, type TMDataGridRowContextMenuRenderer, type TMDataGridRowData, type TMDataGridRowDeleteArgs, type TMDataGridRowEditForm, type TMDataGridRowStyle, type TMDataGridRowValidators, type TMDataGridScrollAlign, type TMDataGridScrollToRowArgs, TMDataGridSearch, type TMDataGridSearchProps, TMDataGridSelectEditor, type TMDataGridSelectionMode, type TMDataGridSettingsSlice, type TMDataGridSize, type TMDataGridStorageMode, TMDataGridStringEditor, type TMDataGridTable, type TMDataGridTableMeta, type TMDataGridTableProps, type TMDataGridUiActions, type TMDataGridUiState, type TMDataGridUiStore, type UseTMDataGridOptions, aggregateColumn, areAllRowsExpanded, autosizeColumn, boundsCellCount, boundsEdges, buildCellMatrix, buildGridCellMatrix, clearedValueForType, createTMDataGridColumnHelper, downloadTextFile, emptyValueForOperator, exportGridToCsv, formatExportValue, formatFilterLabel, formatGroupValue, fuzzyGlobalFilterFn, getColumnCapabilities, getColumnDefaultOperator, getColumnFilterControl, getColumnLabel, getColumnRegion, getColumnType, getDefaultOperator, getDisplayedRows, getEditFieldName, getGridCapabilities, getGroupDataRows, getOperatorsForType, getSelectableRowIds, getStepTargetColumn, getTMDataGridPaginationApi, isColumnEditableForRow, isColumnReorderable, isControlColumn, isFilterActive, isGeneratedColumn, isPagingActive, isSameCell, isWithinBounds, keepGeneratedColumnsOutermost, measureColumnContentWidth, mergeLabels, moveColumn, moveColumnByStep, normalizeFieldValidate, openColumnFilter, operatorNeedsValue, operatorTakesArrayValue, operatorTakesRangeValue, optionsToComboboxData, readFeatureFlags, resolveCellMove, resolveColumnOptions, resolveExpandAll, resolveRangeBounds, resolveRowSelectionClick, tmDataGridFeatures, toClipboardText, toExcelCsv, useCellControlTabIndex, useTMDataGrid, useTMDataGridContext, writeClipboardText };