@jielga/tmdatagrid 1.1.0 → 1.1.1

package/dist/index.d.ts

@@ -352,12 +352,19 @@ type TMDataGridEditRowProjection = {
  * reads a form's store directly - it is mounted for one cell at a time.
  */
 type TMDataGridEditState = {
-  /** The cell whose editor is open; `columnId: null` is a whole row (row mode). */
+  /**
+   * The cell the last open gesture named - where the caret goes. In row mode
+   * the whole row is editing whatever this says, so there it is only the
+   * caret's cell, and `null` for the lane's pencil, which names no column.
+   */
   active: {
     rowId: string;
     columnId: string | null;
   } | null;
-  /** Rows with a live form. In cell mode at most one; in batch, many. */
+  /**
+   * 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.
+   */
   openRowIds: ReadonlyArray<string>;
   rows: Record<string, TMDataGridEditRowProjection>;
   /** Phase 4 - rows being created, not yet in `data`. */
@@ -395,8 +402,13 @@ type TMDataGridEditorArgs = {
   cancel: () => void;
   size: TMDataGridSize;
   /**
-   * Whether this editor should take the focus on mount. True for a single
-   * opened cell; in row mode only the row's first editable cell gets it.
+   * @deprecated The grid places the caret itself, once per open gesture, so
+   * honouring this is optional and it will go in the next major. It focuses
+   * `data-dg-part="editor-input"` when the editor publishes it and the first
+   * focusable element inside the editor otherwise, which is why a custom
+   * editor that ignores this prop still gets the caret. False under
+   * `editMode: "row"`, where a whole row of editors is mounted at once and
+   * only the named cell may take it.
    */
   autoFocus: boolean;
   /**
@@ -471,7 +483,11 @@ type TMDataGridEditApi = {
   canEditCell: (row: ErasedRow, column: ErasedColumn) => boolean;
   /** Whether the row takes edits at all - the edit lane's pencil gate. */
   canEditRow: (row: ErasedRow) => boolean;
-  /** Opens an editor. `columnId: null` opens the whole row (row mode). */
+  /**
+   * Opens an editor. In row mode the whole row opens either way and `columnId`
+   * only says which cell takes the caret; `null` (the lane's pencil) leaves it
+   * to the row's first editable cell.
+   */
   begin: (target: {
     rowId: string;
     columnId: string | null;