apexgrid-skill 1.0.0 → 2.0.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 +22 -7
- package/SKILL.md +274 -291
- package/index.js +1 -0
- package/package.json +1 -1
- package/references/columns-and-templates.md +55 -13
- package/references/data-pipeline.md +12 -7
- package/references/framework-integration.md +92 -47
- package/references/vanilla-js.md +154 -0
package/README.md
CHANGED
|
@@ -4,18 +4,32 @@ AI coding skill for building UIs with the [`apex-grid`](https://github.com/apexc
|
|
|
4
4
|
|
|
5
5
|
> **Naming heads-up.** The npm package is `apex-grid` (with a hyphen), the custom-element tag is `<apex-grid>`, and the exported class is `ApexGrid<T>`.
|
|
6
6
|
|
|
7
|
+
> **Separate skill — one of the ApexCharts ecosystem skills.** This is the dedicated skill for **Apex Grid** (`apex-grid`), shipped as its own `apexgrid-skill` package and repo — distinct from the core `apexcharts-skill` and the other product skills. Each product has its own library and skill; use the one that matches yours:
|
|
8
|
+
>
|
|
9
|
+
> | Product | npm library | Skill package & repo |
|
|
10
|
+
> |---|---|---|
|
|
11
|
+
> | ApexCharts — charts | `apexcharts` | [`apexcharts-skill`](https://github.com/apexcharts/apexcharts-skill) |
|
|
12
|
+
> | ApexGantt — Gantt / timeline | `apexgantt` | [`apexgantt-skill`](https://github.com/apexcharts/apexgantt-skill) |
|
|
13
|
+
> | ApexTree — hierarchy / org charts | `apextree` | [`apextree-skill`](https://github.com/apexcharts/apextree-skill) |
|
|
14
|
+
> | ApexSankey — flow / Sankey | `apexsankey` | [`apexsankey-skill`](https://github.com/apexcharts/apexsankey-skill) |
|
|
15
|
+
> | **Apex Grid** — data grid · *this skill* | `apex-grid` | `apexgrid-skill` |
|
|
16
|
+
|
|
7
17
|
## What This Does
|
|
8
18
|
|
|
9
19
|
AI models routinely get web-component grid code wrong: they treat `<apex-grid>` like a class with a constructor, forget to register the custom element, set `columns` as a stringified attribute, return strings (not Lit `TemplateResult`s) from `cellTemplate`, or expect events from programmatic `sort()` calls. This skill ships structured reference files so the assistant generates correct `apex-grid` code on the first try.
|
|
10
20
|
|
|
11
21
|
### Coverage
|
|
12
22
|
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
17
|
-
- **
|
|
23
|
+
- **Quickstart** — register + size the host (`setup()` does both); no theme import — the grid self-styles via `--ag-*` CSS variables
|
|
24
|
+
- **Custom-element registration** — `setup()`, `import 'apex-grid/define'`, or `ApexGrid.register()`
|
|
25
|
+
- **Generic `ColumnConfiguration<T>`** — `key`, the 13 column `type`s (incl. `date`, `select`, `currency`, …), templates, `sort`, `filter`, `pinned`, explicit widths
|
|
26
|
+
- **Lit cell, header & editor templates** with the right context shapes
|
|
27
|
+
- **Sort, filter & quick-filter** — programmatic API, UI events, operands, multi-column
|
|
28
|
+
- **Editing, selection, pagination, tree & master-detail** — the opt-in feature config objects
|
|
29
|
+
- **Server-side data** — `dataPipelineConfiguration` async hooks (sort/filter/pagination/quickFilter)
|
|
30
|
+
- **CSV export & column reordering/pinning**
|
|
18
31
|
- **Virtualization** — `grid.rows` vs `grid.dataView` vs `grid.totalItems`
|
|
32
|
+
- **Vanilla JS** — full setup without using Lit's `render()` in app code
|
|
19
33
|
- **Framework integration** — Lit, React, Vue, Angular
|
|
20
34
|
|
|
21
35
|
## Installation
|
|
@@ -58,9 +72,10 @@ const cols = await readFile(referencePath('columns-and-templates.md'), 'utf8');
|
|
|
58
72
|
├── SKILL.md # Main entry point
|
|
59
73
|
├── .cursorrules # Self-contained Cursor / Windsurf version
|
|
60
74
|
├── references/
|
|
61
|
-
│ ├── columns-and-templates.md # ColumnConfiguration, types, Lit templates
|
|
75
|
+
│ ├── columns-and-templates.md # ColumnConfiguration, types, Lit templates, widths
|
|
62
76
|
│ ├── sort-and-filter.md # operands, expressions, events, multi-column
|
|
63
77
|
│ ├── data-pipeline.md # async hooks, server-side, virtualization
|
|
78
|
+
│ ├── vanilla-js.md # full setup without Lit render() in app code
|
|
64
79
|
│ └── framework-integration.md # Lit, React, Vue, Angular
|
|
65
80
|
└── install/
|
|
66
81
|
├── claude-code.md
|
|
@@ -73,7 +88,7 @@ const cols = await readFile(referencePath('columns-and-templates.md'), 'utf8');
|
|
|
73
88
|
- [apex-grid GitHub](https://github.com/apexcharts/apexgrid)
|
|
74
89
|
- [npm: apex-grid](https://www.npmjs.com/package/apex-grid)
|
|
75
90
|
- [Lit framework](https://lit.dev)
|
|
76
|
-
- [igniteui-webcomponents](https://www.npmjs.com/package/igniteui-webcomponents) (
|
|
91
|
+
- [igniteui-webcomponents](https://www.npmjs.com/package/igniteui-webcomponents) (transitive dep — installs automatically)
|
|
77
92
|
|
|
78
93
|
## License
|
|
79
94
|
|