@weaver-apps/data-grid 0.0.0-stage → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,3 +1,28 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @weaver-apps/data-grid
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The list grid the Weaver Apps weavers share: AG Grid Community on LoomWeaver's `--lw-*` tokens, following the
|
|
4
|
+
interface language, with scrolling through a server listing and a multi-select list filter.
|
|
5
|
+
|
|
6
|
+
A host does not compose this package. It comes along as a dependency of `@weaver-apps/calendar` and
|
|
7
|
+
`@weaver-apps/service-desk`, contributes no plugin and no translation namespace, and takes its words from AG
|
|
8
|
+
Grid's own German and English texts. A host that compiles the shell's theme with Tailwind adds it as an `@source`, like
|
|
9
|
+
the weavers.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
AG Grid is a peer dependency, so a host that already has it loads one copy:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm i ag-grid-community@^36.2 ag-grid-angular@^36.2 @ag-grid-community/locale@^36.2
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## What it offers
|
|
20
|
+
|
|
21
|
+
- `DataGrid` (`<wa-data-grid [options]>`): the themed grid. It registers the AG Grid modules it needs once,
|
|
22
|
+
follows the active Transloco language, and scrolls a server listing in blocks of `DATA_GRID_BLOCK_SIZE` rows
|
|
23
|
+
unless the options ask for `rowModelType: 'clientSide'`.
|
|
24
|
+
- `listingDatasource(fetch, { answered, failed })`: turns the grid's window, sort and filters into one
|
|
25
|
+
`ListingRequest` (`offset`, `limit`, `sort`, `filters`) and reports the total of the latest query only.
|
|
26
|
+
- `ListFilter`: a column filter for picking any number of values, given `options` and, for rows held in the
|
|
27
|
+
browser, a `rowValue`.
|
|
28
|
+
- `dataGridTheme`, `dataGridModules`, `dataGridLocaleText` for a grid that is built without `DataGrid`.
|