diff --git a/CHANGELOG.md b/CHANGELOG.md index 13d161fe..7201bee8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ ## [Unreleased] +- README: an animated preview and feature screenshots under the banner. The images are kept out of the npm package (`files` excludes `docs/assets/screenshots` and `docs/assets/demo-animated.svg`); the npm page loads them from GitHub. + ## [3.11.1] — 2026-10-27 No library changes; this release moves publishing to npm trusted publishing. diff --git a/README.md b/README.md index f9a9ba9d..c2218a35 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ ![OpenGridX Hero Banner](docs/assets/banner.png) +

+ OpenGridX sorting by revenue, selecting a cell range and showing its sum +

+ + + + + + + + + + + + + +
Cell range selection with count, sum and average
Cell range selection with live count / sum / average
Pivot mode with quarters as columns and a grand total row
Pivot mode with grand totals
Header filter row under the column headers
Header filters per column type
Master-detail row expanded to show a detail panel
Master-detail panels
Right-click context menu with copy, undo, export and delete
Context menu with built-in and custom actions
+ **OpenGridX** is a premium, high-performance React DataGrid engine designed to break the "Pay-to-Play" model in the React ecosystem. It provides a pure-custom, zero-dependency alternative to enterprise grids like **MUI X DataGrid Pro** and **AG Grid**, offering advanced features for free. 👉 **[Live Demo & Docs](https://opencorestack.github.io/OpenGridX/)** — Interactive showcase with full API documentation diff --git a/docs/assets/demo-animated.svg b/docs/assets/demo-animated.svg new file mode 100644 index 00000000..3f082e36 --- /dev/null +++ b/docs/assets/demo-animated.svg @@ -0,0 +1,92 @@ + + OpenGridX in action + A data grid sorts by revenue, selects a cell range and shows its sum, then resets. + + + + + + + + + Sales pipeline + 1,000,000 rows · virtualized + + + + + Account + Region + Stage + Revenue + + Δ + + + + + NorthwindEMEAProposal$42,300+4% + GlobexNAWon$87,950+12% + InitechAPACLead$15,4000% + UmbrellaEMEANegotiation$63,120+7% + HooliNAProposal$29,780+2% + + + + + + + Click to sort · drag to select · right-click for actions + + Count 3   Sum $193,370   Avg $64,457 + + + + + + + diff --git a/docs/assets/screenshots/cell-selection.png b/docs/assets/screenshots/cell-selection.png new file mode 100644 index 00000000..f3ad2b51 Binary files /dev/null and b/docs/assets/screenshots/cell-selection.png differ diff --git a/docs/assets/screenshots/context-menu.png b/docs/assets/screenshots/context-menu.png new file mode 100644 index 00000000..5f663108 Binary files /dev/null and b/docs/assets/screenshots/context-menu.png differ diff --git a/docs/assets/screenshots/header-filters.png b/docs/assets/screenshots/header-filters.png new file mode 100644 index 00000000..54edaf19 Binary files /dev/null and b/docs/assets/screenshots/header-filters.png differ diff --git a/docs/assets/screenshots/master-detail.png b/docs/assets/screenshots/master-detail.png new file mode 100644 index 00000000..0cf0e8e7 Binary files /dev/null and b/docs/assets/screenshots/master-detail.png differ diff --git a/docs/assets/screenshots/pivot.png b/docs/assets/screenshots/pivot.png new file mode 100644 index 00000000..727f37e3 Binary files /dev/null and b/docs/assets/screenshots/pivot.png differ diff --git a/package.json b/package.json index 2180f017..5c1305b2 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,8 @@ "!lib/**/__baseline__", "docs/architecture", "docs/assets", + "!docs/assets/screenshots", + "!docs/assets/demo-animated.svg", "docs/components", "docs/customization", "docs/features",