@gridkitjs/react 0.11.0 → 0.11.1

package/README.md

@@ -1,7 +1,9 @@
 # @gridkitjs/react
 
 React data-grid components built on
-[`@gridkitjs/core`](https://www.npmjs.com/package/@gridkitjs/core).
+[`@gridkitjs/core`](https://www.npmjs.com/package/@gridkitjs/core) for the
+grid's logic and [`@gridkitjs/dom`](https://www.npmjs.com/package/@gridkitjs/dom)
+for its browser behaviours. Both are installed with it.
 
 > **Early development.** The API is still moving and may break between minor
 > versions.
@@ -58,6 +60,14 @@ The grid is an ARIA grid: one tab stop, with the arrow keys moving cell to cell
 within it, `Ctrl+Arrow` reordering a column and `Alt+Arrow` resizing one. Name
 it with `label`, or a screen reader announces only "grid".
 
+`contextMenu` gives headers, cells and group rows a menu of their own — sort,
+group, autofit, hide and choose columns, select and clear, expand and collapse
+— and `toolbar` puts a toolbar above the grid, with a search box, "Clear
+filters" and "Choose columns" by default. Both list built-in commands by id,
+and `commands` adds your own beside them; the column chooser shows and hides
+columns from either. `messages` translates every string the grid shows or
+announces, and `locale` formats dates and numbers.
+
 Requires React 19.
 
 Full documentation: [github.com/blagojablazhevski/gridkit](https://github.com/blagojablazhevski/gridkit#readme)

package/dist/index.d.ts

@@ -126,7 +126,7 @@ interface DataGridApi<Row> {
      * callbacks once for the whole call, and none when nothing changed.
      */
     selectRows(rowIds: readonly string[], intent?: "replace" | "toggle"): void;
-    /** Expands every group at once — there is no dedicated UI control for it. */
+    /** Expands every group at once, as the `group.expandAll` command does. */
     expandAllGroups(): void;
     /** Collapses every group currently shown at once — see `collapseAllGroups` in `@gridkitjs/core` for what "currently shown" means for a group already nested under a collapsed one. */
     collapseAllGroups(): void;
@@ -443,8 +443,8 @@ interface FilterStateApi<Row> {
 }
 /**
  * Reactive filter state read off a mounted `DataGrid`'s `ref`, for a filter
- * bar or search box living outside the grid's own DOM — which, while the grid
- * has no filter UI of its own, is where filtering happens. `setFilter`
+ * bar or search box living outside the grid's own DOM, which sees every change
+ * however it was made — the toolbar's search box included. `setFilter`
  * replaces the whole filter and sends the grid back to its first page.
  *
  * Before the grid mounts, `filter` reads as an empty array and `setFilter`