@one-grid-core/angular 0.2.0 → 0.4.0

package/README.md

@@ -18,7 +18,21 @@ Requires Angular 17 or newer.
 
 ## Usage
 
-Import the module:
+Everything in the library is standalone, so import the component directly:
+
+```ts
+import { OneGridComponent } from '@one-grid-core/angular';
+
+@Component({
+  standalone: true,
+  imports: [OneGridComponent],
+  // ...
+})
+export class MyComponent {}
+```
+
+`OneGridModule` still works and exports the same components, for apps that are
+not standalone yet:
 
 ```ts
 import { OneGridModule } from '@one-grid-core/angular';
@@ -29,6 +43,9 @@ import { OneGridModule } from '@one-grid-core/angular';
 export class AppModule {}
 ```
 
+Both paths render identically — the icons the grid draws travel with the
+components, so nothing extra needs registering either way.
+
 Use the component:
 
 ```html
@@ -182,31 +199,60 @@ A header is one cell for the whole column, so there is no row: `columnDef`,
 ## Features
 
 - Column definitions with value getters, value formatters, cell renderers and validation
+- Column visibility (`hide` / `api.setColumnVisible`) and a JSON-safe layout
+  round-trip (`api.getColumnStateSnapshot` / `api.applyColumnState`)
 - Sorting, including multi-column through the sort model
-- Quick filter and a programmatic column filter model
+- Quick filter and a programmatic column filter model with thirteen operators,
+  including negations, inclusive `inRange` and `blank` / `notBlank`
 - Tree data with expand/collapse and auto group columns
+- Row grouping (`columnDef.rowGroup`, nesting in column order) with
+  aggregation (`columnDef.aggFunc`: sum/min/max/avg/count/first/last or a
+  custom function over the leaves)
 - Master/detail nested grids
-- Inline cell editing with input validation
+- Inline cell editing with input validation, including a `select` editor whose
+  options commit typed values
+- Full-row editing (`editType="fullRow"`): every editable cell of the row
+  opens together, Enter or leaving the row commits, Escape abandons
+- Undo/redo of committed cell edits (`[undoRedoCellEditing]`,
+  `api.undoCellEditing` / `redoCellEditing`, Ctrl+Z / Ctrl+Y in the grid)
 - Row and cell selection, header checkbox select-all
 - Pinned columns (left/right) and pinned rows (top/bottom)
 - Row drag & drop, operable by pointer or keyboard
 - Row action buttons and per-cell option menus
 - Virtual scrolling (Angular CDK)
+- Flex column sizing (`columnDef.flex`) against the grid's own viewport;
+  hand-resizing a column takes it out of the flex pool
+- A default column menu behind the header ⋮ button (`[headerMenu]`) — sort,
+  pin, hide — with `(headerMenuClick)` still emitted for hosts that bring
+  their own
+- A filter row (`[filterRow]`) with an input under every column whose
+  `filterable` resolves true, feeding the filter model debounced
+- Client-side pagination (`[clientSidePagination]` + `[pageSize]`): the grid
+  slices the filtered rows and drives its own bar; the default mode still
+  leaves paging to the host
+- CSV export (`api.getDataAsCsv` / `api.exportDataAsCsv`), through the same
+  value getter/formatter pipeline the cells render with
+- Host outputs for sort changes (`sortChanged`), committed cell edits
+  (`cellValueChanged`), and completed column drags and resizes
+  (`columnMoved` / `columnResized`)
 
 ## Not implemented
 
 Declared in the public types but inert, and documented as such rather than
 quietly omitted:
 
-- `columnDef.flex` — no flex sizing; use explicit widths
-- `columnDef.filterable` — no filter UI ships; filtering is API-driven
 - `columnDef.valueSetter` — never invoked, and its signature could not work
 
-No output reaches the host for a committed cell edit or a sort change; read
-`api.sortModel` and handle edits through `node.setDataValue`.
+Deliberately out of scope, so nobody goes looking:
 
-Pagination renders a bar and emits navigation intents — it does not page your
-rows for you.
+- **Pivoting** — row grouping aggregates down a tree; turning values into
+  columns is a different engine.
+- **A server-side / infinite row model** — the host-driven pagination
+  contract plus the sort and filter models *is* this grid's server story:
+  page, sort and filter server-side and hand the grid each page. A block
+  cache would duplicate that with more machinery.
+- **Cell/row spanning** — incompatible with fixed-height virtual scrolling
+  as built.
 
 ## License