@1771technologies/lytenyte-pro
Version:
Blazingly fast headless React data grid with 100s of features.
433 lines (332 loc) • 29.7 kB
Markdown
<div align="center">
<br><br>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://xwhoymbxqtnizjadugph.supabase.co/storage/v1/object/public/images/github-lytenyte-dark.svg"/>
<source media="(prefers-color-scheme: light)" srcset="https://xwhoymbxqtnizjadugph.supabase.co/storage/v1/object/public/images/github-lytenyte-light.svg"/>
<img width="360" alt="Logo of LyteNyte Grid" src="https://xwhoymbxqtnizjadugph.supabase.co/storage/v1/object/public/images/github-lytenyte-light.svg"/>
</picture>
<br><br>
<h3>
The Fastest React Data Grid On The Modern Web
</h3>
</div>
<div align="center">
LyteNyte Grid is a **~40 KB, zero-dependency React data grid** engineered for
high performance and enterprise-scale datasets. It can handle **10,000 updates/sec**
and render **millions of rows**. No wrappers. No heavy abstractions.
Choose between **headless** components or a **pre-styled** grid out of
the box, and ship faster with a **declarative API** that
is purpose-built for React.
Start with **LyteNyte Grid Core** (free and open source). Upgrade
to **LyteNyte Grid PRO** for advanced enterprise features and support.
[Compare Features](https://1771technologies.com/pricing)
</div>
<div align="center">
[](https://www.npmjs.com/package/@1771technologies/lytenyte-pro)
[](https://www.npmjs.com/package/@1771technologies/lytenyte-core)
[](https://github.com/1771-Technologies/lytenyte/tree/main)
[](https://github.com/1771-Technologies/lytenyte)
[](code_of_conduct.md)
[](https://github.com/1771-Technologies/lytenyte/actions/workflows/release.yml?query=branch%3Amain)
[](https://x.com/1771tech)
[](https://www.linkedin.com/company/1771technologies)
[](https://youtube.com/@1771technologies)
</div>
<div align="center">
<a href="https://1771technologies.com">Website</a> — <a href="https://1771technologies.com/docs/intro-getting-started">Documentation</a> — <a href="https://1771technologies.com/demo">Demo</a> — <a href="https://1771technologies.com/pricing">Pricing</a> — <a href="https://1771technologies.com/eula">EULA</a>
</div>
## LyteNyte Editions
LyteNyte Grid is available in two editions:
1. **LyteNyte Grid Core: Free, open-source edition** for building high-performance data tables.
Includes sorting, filtering, editing, row selection, detail views, and more. Also includes advanced
features such as aggregation, row grouping, and data export, often locked behind paywalls in other grids.
2. **LyteNyte Grid PRO: Commercial edition** that extends Core with powerful enterprise
features such as server-side data loading, pivoting, tree data, component managers,
and advanced filtering. Build custom menus, popovers and dialogs,
and workflow-driven UIs with ease.
## Features
<details>
<summary><b>⚛️ Reactive Architecture</b></summary>
<br>
| Feature | Core | PRO |
| ---------------------------------------------------------------------------------------------------------- | :--: | :-: |
| [Declarative Prop Configuration](https://www.1771technologies.com/docs/grid-reactivity#props-as-state) | ✅ | ✅ |
| [Controlled or Uncontrolled State](https://www.1771technologies.com/docs/grid-reactivity#controlled-state) | ✅ | ✅ |
| [React Compiler Support](https://www.1771technologies.com/docs/grid-react-compiler) | ✅ | ✅ |
| [Headless Components](https://www.1771technologies.com/docs/grid-headless-parts) | ✅ | ✅ |
</details>
<details>
<summary><b>🔌 API Extensions</b></summary>
<br>
| Feature | Core | PRO |
| --------------------------------------------------------------------------------------------- | :--: | :-: |
| [Imperative Method Extensions](https://www.1771technologies.com/docs/grid-api-extensions) | ✅ | ✅ |
| [Column Extensions](https://www.1771technologies.com/docs/reference/column#extending-columns) | ✅ | ✅ |
</details>
<details>
<summary><b>🚀 Virtualization</b></summary>
<br>
| Feature | Core | PRO |
| ---------------------------------------------------------------------------------- | :--: | :-: |
| [Row Virtualization](https://www.1771technologies.com/docs/grid-virtualization) | ✅ | ✅ |
| [Column Virtualization](https://www.1771technologies.com/docs/grid-virtualization) | ✅ | ✅ |
</details>
<details>
<summary><b>🎨 Styling & Theming</b></summary>
<br>
| Feature | Core | PRO |
| ---------------------------------------------------------------------------------------------------------- | :--: | :-: |
| [Unstyled Support](https://www.1771technologies.com/docs/grid-theming) | ✅ | ✅ |
| **Styled Themes** | ✅ | ✅ |
| ↳ [Prebuilt Themes](https://www.1771technologies.com/docs/grid-theming#pre-built-themes) | ✅ | ✅ |
| ↳ [Tailwind](https://www.1771technologies.com/docs/grid-theming-tailwind) | ✅ | ✅ |
| ↳ [CSS Modules](https://www.1771technologies.com/docs/grid-theming-css-modules) | ✅ | ✅ |
| ↳ [CSS-in-JS](https://www.1771technologies.com/docs/grid-theming-emotion) | ✅ | ✅ |
</details>
<details>
<summary><b>📋 Rows</b></summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------------------------------------------------- | :--: | :-: |
| **Basic Row Operations** | ✅ | ✅ |
| ↳ [Row Pinning](https://www.1771technologies.com/docs/row-pinning) | ✅ | ✅ |
| ↳ [Row Spanning](https://www.1771technologies.com/docs/row-spanning) | ✅ | ✅ |
| **Row Height** | ✅ | ✅ |
| ↳ [Variable Row Height](https://www.1771technologies.com/docs/row-height#variable-row-height) | ✅ | ✅ |
| ↳ [Fixed Row Height](https://www.1771technologies.com/docs/row-height#number-row-heights) | ✅ | ✅ |
| ↳ [Fill Row Height](https://www.1771technologies.com/docs/row-height#fill-row-height) | ✅ | ✅ |
| [Full Width Rows](https://www.1771technologies.com/docs/row-full-width) | ✅ | ✅ |
| **Row Dragging / Reordering** | ✅ | ✅ |
| ↳ [Single Row Dragging](https://www.1771technologies.com/docs/row-dragging#single-row-dragging) | ✅ | ✅ |
| ↳ [Multi-Row Dragging](https://www.1771technologies.com/docs/row-dragging#multi-row-dragging) | ✅ | ✅ |
| ↳ [Grid to Grid Dragging](https://www.1771technologies.com/docs/row-dragging#dragging-between-grids) | ✅ | ✅ |
| ↳ [External Drop Zone Dragging](https://www.1771technologies.com/docs/row-dragging#external-drop-zones) | ✅ | ✅ |
</details>
<details>
<summary><b>📊 Columns</b></summary>
<br>
| Feature | Core | PRO |
| --------------------------------------------------------------------------------------------------------------------------- | :--: | :-: |
| **Basic Column Operations** | ✅ | ✅ |
| ↳ [Column Resizing](https://www.1771technologies.com/docs/column-resizing) | ✅ | ✅ |
| ↳ [Column Pinning](https://www.1771technologies.com/docs/column-pinning) | ✅ | ✅ |
| ↳ [Column Spanning](https://www.1771technologies.com/docs/column-spanning) | ✅ | ✅ |
| ↳ [Column Reordering](https://www.1771technologies.com/docs/column-moving) | ✅ | ✅ |
| ↳ [Column Grouping](https://www.1771technologies.com/docs/column-groups) | ✅ | ✅ |
| ↳ [Column Visibility](https://www.1771technologies.com/docs/column-visibility) | ✅ | ✅ |
| **Column Autosizing** | ✅ | ✅ |
| ↳ [Cell Autosizing](https://www.1771technologies.com/docs/column-autosizing#autosizing-cells) | ✅ | ✅ |
| ↳ [Header Autosizing](https://www.1771technologies.com/docs/column-autosizing#autosize-header-text) | ✅ | ✅ |
| ↳ [Double Click Resizing](https://www.1771technologies.com/docs/column-autosizing#double-click-to-resize) | ✅ | ✅ |
| [Custom Header Render](https://www.1771technologies.com/docs/column-header-renderer) | ✅ | ✅ |
| [Column Floating Header](https://www.1771technologies.com/docs/column-floating-header) | ✅ | ✅ |
| [Dynamic Field Computation](https://www.1771technologies.com/docs/column-field) | ✅ | ✅ |
| [Marker Column](https://www.1771technologies.com/docs/marker-column) | ✅ | ✅ |
</details>
<details>
<summary><b>🔲 Cells</b></summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------- | :--: | :-: |
| [Cell Rendering](https://www.1771technologies.com/docs/cell-renderers) | ✅ | ✅ |
| [Cell Diff Flashing](https://www.1771technologies.com/docs/cell-diff-flashing) | ✅ | ✅ |
| [Cell Tooltips & Popovers](https://www.1771technologies.com/docs/cell-tooltips) | ✅ | ✅ |
</details>
<details>
<summary><b>🔀 Sorting</b></summary>
<br>
| Feature | Core | PRO |
| ---------------------------------------------------------------------------------------------------- | :--: | :-: |
| [Single Column Sort](https://www.1771technologies.com/docs/client-source-row-sorting#sort-functions) | ✅ | ✅ |
| [Multi Column Sort](https://www.1771technologies.com/docs/client-source-row-sorting#dimension-sorts) | ✅ | ✅ |
| [Custom Dynamic Sort](https://www.1771technologies.com/docs/client-source-row-sorting) | ✅ | ✅ |
</details>
<details>
<summary><b>☑️ Selection</b> </summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------------------------------------------------ | :--: | :-: |
| **Row Selection** | ✅ | ✅ |
| ↳ [Single Row Selection](https://www.1771technologies.com/docs/row-selection#enabling-row-selection) | ✅ | ✅ |
| ↳ [Multi Row Selection](https://www.1771technologies.com/docs/row-selection#multiple-row-selection) | ✅ | ✅ |
| ↳ [Checkbox Row Selection](https://www.1771technologies.com/docs/row-selection#checkbox-selection) | ✅ | ✅ |
| ↳ [Isolated Row Selection](https://www.1771technologies.com/docs/row-selection#isolated-row-selection) | ✅ | ✅ |
| ↳ [Linked Row Selection](https://www.1771technologies.com/docs/row-selection#linked-row-selection) | ✅ | ✅ |
| [Cell Selection](https://www.1771technologies.com/docs/cell-selection#single-range-selection) | — | ✅ |
| [Cell Range Selection](https://www.1771technologies.com/docs/cell-selection#multi-range-selection) | — | ✅ |
</details>
<details>
<summary><b>✏️ Editing</b></summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------------------------------------- | :--: | :-: |
| **Cell Editing** | ✅ | ✅ |
| ↳ [Basic Cell Edits](https://www.1771technologies.com/docs/cell-editing#basic-cell-editing) | ✅ | ✅ |
| ↳ [Linked Cell Edits](https://www.1771technologies.com/docs/cell-editing-linked-cell-edits) | ✅ | ✅ |
| ↳ [Full Row Editing](https://www.1771technologies.com/docs/cell-editing-full-row) | ✅ | ✅ |
| ↳ [Bulk Cell Editing](https://www.1771technologies.com/docs/cell-editing-bulk-editing) | ✅ | ✅ |
| [Edit Validation](https://www.1771technologies.com/docs/cell-editing-validation) | ✅ | ✅ |
| [Custom Cell Editors](https://www.1771technologies.com/docs/cell-editing-renderers) | ✅ | ✅ |
| [Programmatic Editing](https://www.1771technologies.com/docs/cell-editing#programmatic-editing) | ✅ | ✅ |
</details>
<details>
<summary><b>🔍 Filtering</b> </summary>
<br>
| Feature | Core | PRO |
| -------------------------------------------------------------------------------------------------------------------- | :--: | :-: |
| **Column Filters** | ✅ | ✅ |
| ↳ [Text Filters](https://www.1771technologies.com/docs/filtering-text) | ✅ | ✅ |
| ↳ [Number Filters](https://www.1771technologies.com/docs/filtering-numbers) | ✅ | ✅ |
| ↳ [Date Filters](https://www.1771technologies.com/docs/filtering-dates) | ✅ | ✅ |
| [Quick Search Filter](https://www.1771technologies.com/docs/filtering-quick-search) | ✅ | ✅ |
| [Label Filters](https://www.1771technologies.com/docs/client-source-label-filters) | — | ✅ |
| **Advanced Filters** | - | ✅ |
| ↳ [Set Filters](https://www.1771technologies.com/docs/filtering-set-filters#basic-set-filtering) | ✅ | ✅ |
| ↳ [Tree Set Filters](https://www.1771technologies.com/docs/filtering-set-filters#tree-set-filters) | ✅ | ✅ |
| ↳ [Having Filters](https://www.1771technologies.com/docs/client-source-having-filters) | — | ✅ |
</details>
<details>
<summary><b>📦 Grouping & Aggregations</b></summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------------------------------------------------------------ | :--: | :-: |
| **Row Grouping** | ✅ | ✅ |
| ↳ [Uniform Row Groups](https://www.1771technologies.com/docs/client-source-row-grouping#grouping-function) | ✅ | ✅ |
| ↳ [Non-uniform Row Groups](https://www.1771technologies.com/docs/client-source-row-grouping#non-uniform-groups) | ✅ | ✅ |
| ↳ [Dynamic Group Dimensions](https://www.1771technologies.com/docs/client-source-row-grouping#grouping-dimensions) | ✅ | ✅ |
| [Aggregations](https://www.1771technologies.com/docs/client-source-aggregations) | ✅ | ✅ |
| **Master Detail** | ✅ | ✅ |
| ↳ [Row Master Detail](https://www.1771technologies.com/docs/row-detail) | ✅ | ✅ |
| ↳ [Auto Height Master Detail](https://www.1771technologies.com/docs/row-detail#row-detail-height) | ✅ | ✅ |
| ↳ [Nested Grids](https://www.1771technologies.com/docs/row-detail#nested-grids) | ✅ | ✅ |
| ↳ [Custom Detail Content](https://www.1771technologies.com/docs/row-detail) | ✅ | ✅ |
</details>
<details>
<summary><b>🔄 Pivoting</b> </summary>
<br>
| Feature | Core | PRO |
| -------------------------------------------------------------------------------------- | :--: | :-: |
| [Row & Column Pivots](https://www.1771technologies.com/docs/pivoting-columns-and-rows) | — | ✅ |
| [Pivot Measures](https://www.1771technologies.com/docs/pivoting-measures) | — | ✅ |
| [Pivot Sorting](https://www.1771technologies.com/docs/pivoting-sorting) | — | ✅ |
| [Pivot Filtering](https://www.1771technologies.com/docs/pivoting-filtering) | — | ✅ |
| [Grand Totals](https://www.1771technologies.com/docs/pivoting-grand-totals) | — | ✅ |
</details>
<details>
<summary><b>🌲 Tree Data</b> </summary>
<br>
| Feature | Core | PRO |
| ----------------------------------------------------------------------------------------- | :--: | :-: |
| [Custom Object Mappings](https://www.1771technologies.com/docs/tree-source-data) | — | ✅ |
| [JSON Object Editing](https://www.1771technologies.com/docs/tree-source-data-editing) | — | ✅ |
| [Dynamic Tree Creation](https://www.1771technologies.com/docs/tree-source-data#root-rows) | — | ✅ |
</details>
<details>
<summary><b>🌐 Server Data Loading</b> </summary>
<br>
| Feature | Core | PRO |
| --------------------------------------------------------------------------------------------------------------------------------- | :--: | :-: |
| **Basic Server Operations** | — | ✅ |
| ↳ [Server Row Sorting](https://www.1771technologies.com/docs/server-data-loading-row-sorting) | — | ✅ |
| ↳ [Server Row Filtering](https://www.1771technologies.com/docs/server-data-loading-row-filtering) | — | ✅ |
| ↳ [Server Row Pinning](https://www.1771technologies.com/docs/server-data-loading-row-pinning) | — | ✅ |
| ↳ [Server Row Grouping](https://www.1771technologies.com/docs/server-data-loading-row-grouping-and-aggregation) | — | ✅ |
| [Server Tree Data](https://www.1771technologies.com/docs/server-data-loading-unbalanced-rows) | — | ✅ |
| [Server Cell Editing](https://www.1771technologies.com/docs/server-data-loading-cell-editing) | — | ✅ |
| [Data Updates](https://www.1771technologies.com/docs/server-data-loading-row-updating) | — | ✅ |
| [Optimistic Data Loading](https://www.1771technologies.com/docs/server-data-loading-optimistic-loading) | — | ✅ |
| [Paginated Row Data](https://www.1771technologies.com/docs/paginated-rs-rows) | — | ✅ |
| [Infinite Row Data](https://www.1771technologies.com/docs/infinite-rs-rows) | — | ✅ |
| [Server Data Interface](https://www.1771technologies.com/docs/server-data-loading-interface) | — | ✅ |
</details>
<details>
<summary><b>🧩 Prebuilt Components</b> </summary>
<br>
| Feature | Core | PRO |
| -------------------------------------------------------------------------------------------------------- | :--: | :-: |
| [Pill Manager](https://www.1771technologies.com/docs/component-pill-manager) | — | ✅ |
| [Column Manager](https://www.1771technologies.com/docs/component-column-manager) | — | ✅ |
| [Tree View](https://www.1771technologies.com/docs/component-tree-view) | — | ✅ |
| [Dialog & Popovers](https://www.1771technologies.com/docs/component-dialog) | — | ✅ |
| [Menus & Context Menus](https://www.1771technologies.com/docs/component-menu-button) | — | ✅ |
| **Other Prebuilt Components** | - | ✅ |
| ↳ [Smart Select](https://www.1771technologies.com/docs/component-smart-select) | — | ✅ |
| ↳ [Grid Overlays](https://www.1771technologies.com/docs/component-grid-overlays) | ✅ | ✅ |
| ↳ [Viewport Shadows](https://www.1771technologies.com/docs/component-viewport-shadows) | ✅ | ✅ |
| ↳ [Select All](https://www.1771technologies.com/docs/component-select-all) | — | ✅ |
| ↳ [Row Group Cell](https://www.1771technologies.com/docs/component-row-group-cell) | — | ✅ |
</details>
<details>
<summary><b>📤 Import & Export</b> </summary>
<br>
| Feature | Core | PRO |
| ------------------------------------------------------------------------------------------ | :--: | :-: |
| **Data Export** | ✅ | ✅ |
| ↳ [Excel Export](https://www.1771technologies.com/docs/export-excel) | ✅ | ✅ |
| ↳ [CSV Export](https://www.1771technologies.com/docs/export-csv) | ✅ | ✅ |
| ↳ [Parquet Export](https://www.1771technologies.com/docs/export-parquet) | ✅ | ✅ |
| ↳ [Arrow Export](https://www.1771technologies.com/docs/export-arrow) | ✅ | ✅ |
| [Clipboard Operations](https://www.1771technologies.com/docs/export-clipboard) | — | ✅ |
</details>
<details>
<summary><b>⌨️ Keyboard & Accessibility</b></summary>
<br>
| Feature | Core | PRO |
| -------------------------------------------------------------------- | :--: | :-: |
| [Keyboard](https://www.1771technologies.com/docs/keyboard) | ✅ | ✅ |
| [Accessibility](https://www.1771technologies.com/docs/accessibility) | ✅ | ✅ |
| [RTL Support](https://www.1771technologies.com/docs/rtl-support) | ✅ | ✅ |
</details>
## Key Design Principles
- **Performance-First:** LyteNyte Grid is engineered with speed as a fundamental
priority, ensuring responsive performance even when handling large datasets.
- **Modern Architecture:** Leveraging cutting-edge web technologies, LyteNyte
Grid utilizes native browser scroll functionality to keep the main
thread unencumbered as users navigate through their data.
- **React-Aligned Philosophy:** Adhering to React's core principles, LyteNyte Grid
implements one-way data binding and declarative rendering to
maintain predictable state management.
## Installation
LyteNyte Grid can be installed via NPM:
**PRO:**
```sh
npm install --save @1771technologies/lytenyte-pro
```
> [!NOTE]
> You can install and use LyteNyte Grid PRO
> without license but a watermark will be displayed.
**Core:**
```sh
npm install --save @1771technologies/lytenyte-core
```
## Quick Start
- Begin with our comprehensive [getting started guide](https://www.1771technologies.com/docs/intro-getting-started).
- Explore our flexible [pricing options](https://www.1771technologies.com/pricing) to find the ideal fit for your project.
- Follow our step-by-step [installation guide](https://www.1771technologies.com/docs/intro-installation) to seamlessly integrate LyteNyte Grid into your application.
## Licensing
LyteNyte Grid is available in two editions, Core and PRO, and is offered under the following three license plans:
1. **Core License Plan:** An [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
license for the Core edition, which is free and open-source. Ideal for individual developers and community use.
2. **Developer PRO License Plan:** A [commercial license](https://www.1771technologies.com/eula) for the PRO edition, designed for
individuals and teams with up to 50 developers. Unlocks the full potential of LyteNyte
Grid with advanced features unavailable in the Core edition.
3. **Organization PRO License Plan:** A [commercial license](https://www.1771technologies.com/eula) for the PRO edition,
tailored for teams with 50+ developers. Includes all PRO features along
with an enhanced support agreement and negotiated pricing terms.
All **PRO licenses** are **perpetual** and include **12 months** of software updates,
feature upgrades, and dedicated technical support during your active license term.
## Support
Our team actively maintains and supports both the Core and PRO editions of LyteNyte Grid.
Please refer to our [support guide](https://www.1771technologies.com/support) for detailed
information on available support channels and response options.
## Contributing
Please review our [contributing guide](https://github.com/1771-Technologies/lytenyte/blob/main/CONTRIBUTING.md) to learn about our development
process, bug reporting procedures, and codebase maintenance practices.
## Changelog
Our [changelog](https://www.1771technologies.com/docs/changelog/latest) is regularly updated
with detailed notes on new features, improvements, and bug fixes in each release.
LyteNyte Grid follows [semantic versioning](https://semver.org/) to ensure clear and predictable upgrade paths.
## Security
For information on reporting security vulnerabilities,
please consult our [security policy](https://github.com/1771-Technologies/lytenyte/blob/main/SECURITY.md).