@everygrid/grid 0.4.7 → 0.4.8
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 +13 -15
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -3,14 +3,13 @@
|
|
|
3
3
|
A config-driven React data grid. Filtering, sorting and paging over millions of rows run in a
|
|
4
4
|
**Rust - WASM engine** inside a Web Worker, so the UI never blocks.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
**[Live demo & API docs →](https://d3886c7yrxubj8.cloudfront.net/)** — React, vanilla JS and jQuery demos, a
|
|
7
|
+
1.6M-row virtual-scroll grid, and JSON-to-grid.
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
deploy publishes an immutable tarball at `/packages/everygrid-grid-<version>-<hash>.tgz`, which is
|
|
10
|
-
what you install and what your lockfile pins.
|
|
9
|
+
## Installation
|
|
11
10
|
|
|
12
11
|
```bash
|
|
13
|
-
npm install
|
|
12
|
+
npm install @everygrid/grid
|
|
14
13
|
```
|
|
15
14
|
|
|
16
15
|
React 18+ is a peer dependency. For a plain `<script>` page with no bundler, see [CDN Usage](#cdn-usage).
|
|
@@ -20,7 +19,7 @@ React 18+ is a peer dependency. For a plain `<script>` page with no bundler, see
|
|
|
20
19
|
### 1. Install the library
|
|
21
20
|
|
|
22
21
|
```bash
|
|
23
|
-
npm install
|
|
22
|
+
npm install @everygrid/grid
|
|
24
23
|
```
|
|
25
24
|
|
|
26
25
|
### 2. Import CSS
|
|
@@ -130,10 +129,10 @@ The standalone build is one self-contained file — React, the WASM engine, the
|
|
|
130
129
|
are all inlined — exposed as `window.Everygrid`. No stylesheet, no React script tags, no build step.
|
|
131
130
|
|
|
132
131
|
```html
|
|
133
|
-
<!--
|
|
134
|
-
<script src="https://
|
|
135
|
-
<!-- or
|
|
136
|
-
<script src="https://
|
|
132
|
+
<!-- newest compatible 0.4.x — pin an exact version (e.g. @0.4.8) for production -->
|
|
133
|
+
<script src="https://cdn.jsdelivr.net/npm/@everygrid/grid@0.4"></script>
|
|
134
|
+
<!-- or the same file via unpkg:
|
|
135
|
+
<script src="https://unpkg.com/@everygrid/grid@0.4"></script> -->
|
|
137
136
|
|
|
138
137
|
<div id="user-grid"></div>
|
|
139
138
|
|
|
@@ -173,6 +172,7 @@ apply to every grid in the file.
|
|
|
173
172
|
|-------|------|-------------|
|
|
174
173
|
| `id` | `string` | The DOM element id the grid mounts into |
|
|
175
174
|
| `title` | `string` | Heading shown above the grid |
|
|
175
|
+
| `data` | `object[]` | Rows inline in the config — for small static grids that need no fetcher |
|
|
176
176
|
| `links` | `string[]` | Fields rendered as links |
|
|
177
177
|
| `editableCols` | `string[]` | Fields the reader may edit |
|
|
178
178
|
| `rowKey` | `string \| string[]` | Field (or fields) that identify a row — what `patch()` and change events report as `key`. Without it, the row's data index |
|
|
@@ -659,11 +659,9 @@ I18n.setLocale('en'); // 'en' | 'ko'
|
|
|
659
659
|
|
|
660
660
|
## Versioning
|
|
661
661
|
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
is a compatibility promise, not a build id — it moves only when the public API does, and several
|
|
666
|
-
deploys may share one version.
|
|
662
|
+
Releases are published to npm as [`@everygrid/grid`](https://www.npmjs.com/package/@everygrid/grid);
|
|
663
|
+
the `<script>` build is served from the same release by jsDelivr / unpkg. npm versions are immutable,
|
|
664
|
+
so every release gets a new version number.
|
|
667
665
|
|
|
668
666
|
The public API is the exports of `@everygrid/grid`, the config schema (`types.ts`), the
|
|
669
667
|
`everygrid.config.json` contract and the `window.Everygrid` global. While at `0.x`, npm's caret makes
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@everygrid/grid",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.8",
|
|
4
4
|
"description": "Config-driven React data grid with a Rust/WASM engine in a Web Worker — filter, sort and paginate millions of rows without blocking the UI.",
|
|
5
5
|
"author": "Ilsan Software <support@ilsansoftware.com> (https://ilsansoftware.com)",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"homepage": "https://
|
|
7
|
+
"homepage": "https://d3886c7yrxubj8.cloudfront.net/",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "git+https://github.com/leeey/everygrid.git",
|