From 3ef59980eaf58e53554c3d55f9765a409edc9688 Mon Sep 17 00:00:00 2001 From: maks Date: Sun, 26 Jan 2025 00:14:48 +0000 Subject: [PATCH] doc: readme fulfilled with refs --- docs | 2 +- packages/angular | 2 +- packages/react | 2 +- packages/svelte | 2 +- packages/vue2 | 2 +- packages/vue3 | 2 +- readme.md | 82 ++++++++++++++++++++--------------------- readme/features.md | 74 +++++++++++++++++-------------------- readme/framework.md | 5 +++ readme/usage.angular.md | 7 ++++ readme/usage.js.md | 2 +- readme/usage.react.md | 6 +++ readme/usage.svelte.md | 6 +++ readme/usage.vue2.md | 7 +++- readme/usage.vue3.md | 6 +++ 15 files changed, 115 insertions(+), 92 deletions(-) diff --git a/docs b/docs index 0c691c53..d75bc7b7 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit 0c691c53cc9034e9ff8818c018d60d2133d6b69e +Subproject commit d75bc7b77c92dfbb99b804448239c4ad694e55f7 diff --git a/packages/angular b/packages/angular index f1ed514e..9446c8de 160000 --- a/packages/angular +++ b/packages/angular @@ -1 +1 @@ -Subproject commit f1ed514e5e022904189e639ef4b78382ffa4df66 +Subproject commit 9446c8de37dbb8f368a60cbd5b4c80d482a83722 diff --git a/packages/react b/packages/react index f39404aa..f9f89453 160000 --- a/packages/react +++ b/packages/react @@ -1 +1 @@ -Subproject commit f39404aa127080afb201b849f682bc7da2f1b7f9 +Subproject commit f9f89453b5b0e4e39a808a65bc0065b1ba57cb28 diff --git a/packages/svelte b/packages/svelte index af2efb76..94c326e4 160000 --- a/packages/svelte +++ b/packages/svelte @@ -1 +1 @@ -Subproject commit af2efb76ce4bbc341de13d73b50b10265d9c62df +Subproject commit 94c326e44d6e556600071fd0012fb6b9f9e9c69b diff --git a/packages/vue2 b/packages/vue2 index 2035a8c2..2b97d1ed 160000 --- a/packages/vue2 +++ b/packages/vue2 @@ -1 +1 @@ -Subproject commit 2035a8c20da4f52ec655dbf26463c1346512f2ce +Subproject commit 2b97d1eda97cf936c31bc05732424efbe2ea32bb diff --git a/packages/vue3 b/packages/vue3 index 28b1537f..db29a9ac 160000 --- a/packages/vue3 +++ b/packages/vue3 @@ -1 +1 @@ -Subproject commit 28b1537f55031c66c0d27d75b4be3d97daa17f7c +Subproject commit db29a9acd31cc3be3f7d1a5a7461445a02531d56 diff --git a/readme.md b/readme.md index 50c85e54..2888f1d1 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@

- RevoGrid + RevoGrid Data Grid

@@ -39,83 +39,79 @@ Support Millions of cells and thousands of columns easy and efficiently for fast - **High Performance**: Handles millions of cells in the viewport with a powerful core built by default. -- **Accessibility**: Follows WAI-ARIA best practices. +- **[Accessibility](https://rv-grid.com/guide/wcag)**: Follows WAI-ARIA best practices. -- **Keyboard Support**: +- **[Keyboard Support](https://rv-grid.com/guide/defs#Keyboard)**: - Excel-like focus for efficient navigation and editing. - Seamless copy/paste from Excel, Google Sheets, or any other sheet format. - **Lightweight**: Minimal initial bundle size ![Min size](https://badgen.net/bundlephobia/min/@revolist/revogrid@latest). Can be imported with polyfills or as a module for modern browsers. -- **Intelligent Virtual DOM**: Smart row recombination to minimize redraws. +- **[Intelligent Virtual DOM](https://rv-grid.com/guide/overview#VNode-Reactive-DOM)**: Smart row recombination to minimize redraws. -- **Virtual Scroll**: Handles large datasets with infinite scroll. +- **[Virtual Scroll](https://rv-grid.com/guide/viewports)**: Handles large datasets with infinite scroll. -- **Formula Support**: Evaluate formulas in cell data. +- **[Drag and Drop](https://rv-grid.com/guide/row/order)**: Drag and drop in [rows](https://rv-grid.com/guide/row/order) and [columns](https://rv-grid.com/guide/column/order). -- **Master Detail/Subtables/Forms**: Expand rows to reveal child data. +- **[Sorting](https://rv-grid.com/guide/sorting)**: Multiple options, customizable per column, with advanced event handling. -- **Drag and Drop**: Drag and drop in rows and columns. - -- **Sorting**: Multiple options, customizable per column, with advanced event handling. - -- **Filtering**: +- **[Filtering](https://rv-grid.com/guide/filters)**: - Predefined system filters. + - Multi column filters. + - Conditional filters. - Preserve existing collections. - Custom filters to extend system filters with your own set. -- **Export**: Export data to file. +- **[Export](https://rv-grid.com/guide/export.plugin)**: Export data to file. -- **Custom Sizes**: Define custom sizes for columns and rows. Automatic sizing based on content. +- **Custom Sizes**: Define custom sizes for [columns](https://rv-grid.com/guide/column/#Column-Size) and [rows](https://rv-grid.com/guide/row/height). Automatic sizing based on content. -- **Column Resizing**: Adjust column widths. +- **[Column Resizing](https://rv-grid.com/guide/column/resize)**: Adjust column widths. - **Pinned/Sticky/Freezed Elements**: - - Columns (define left or right). - - Rows (define top or bottom). + - [Columns](https://rv-grid.com/guide/column/pin) (define left or right). + - [Rows](https://rv-grid.com/guide/row/pin) (define top or bottom). - **Grouping**: - - Column grouping (nested headers). - - Row grouping (nested rows). - -- **Cell Editing**: In-place editing of cell data. - -- **Cell Merging**: Merge cells to form groups. - -- **Customizations**: - - Column header template. - - Row header template. - - Cell template (create your own cell views). - - Cell editor (use predefined or apply your own custom editors and cell types). - - Cell properties (define custom properties for rendered cells). + - [Column grouping](https://rv-grid.com/guide/column/grouping) (nested headers). + - [Row grouping](https://rv-grid.com/guide/row/grouping) (nested rows). - **Column Types**: [More details](https://rv-grid.com/guide/column/#Column-Formats) - - Text/String (default). - - Number. - - Select. - - Date. + - [Text/String](https://rv-grid.com/guide/column/types#String) (default). + - [Number](https://rv-grid.com/guide/column/types#Number). + - [Select/Dropdown](https://rv-grid.com/guide/column/types#Select-Dropdown). + - [Date](https://rv-grid.com/guide/column/types#Date). - Custom (create extended styles using any template). - **Range Operations**: - - Selection. - - Editing. + - [Selection](https://rv-grid.com/guide/defs#Range). + - [Editing](https://rv-grid.com/guide/defs#Range-Autofill). -- **Theme Packages**: +- **[Theme Packages](https://rv-grid.com/guide/theme)**: - Excel-like (default). - Material (compact, dark, or light). -- **Extensibility**: Modern VNode features and tsx support for easy extension. +- **[Extensibility](https://rv-grid.com/guide/jsx.template)**: Modern VNode features and tsx support for easy extension. -- **Trimmed Rows**: Hide rows on demand. +- **[Trimmed Rows](https://rv-grid.com/guide/row/#Trimmed-Rows)**: Hide rows on demand. -- **Plugin System**: Create custom plugins or extend existing ones easily. +- **[Plugin System](https://rv-grid.com/guide/plugin/)**: Create custom plugins or extend existing ones easily. -- **Additional Customizations and Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). +- **[Formula Support](https://rv-grid.com/guide/cell/formula)**: Evaluate formulas in cell data. -
+- **[Master Detail/Subtables/Forms](https://rv-grid.com/guide/row/master.pro)**: Expand rows to reveal child data. +- **[Cell/Column/Row Span/Merge](https://rv-grid.com/guide/cell/merge)**: Merge cells to form groups. + +- **Customizations**: + - [Column header template](https://rv-grid.com/guide/column/header.template). + - [Row header template](https://rv-grid.com/guide/row/headers). + - [Cell properties](https://rv-grid.com/guide/cell/) (define custom properties for rendered cells). + - [Cell template](https://rv-grid.com/guide/cell/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/cell/editor) (use predefined or apply your own custom editors and cell types). +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/).

Framework Friendly

@@ -172,7 +168,7 @@ RevoGrid functions as a web component. Simply place the component on your page a - [Import the grid into your project](https://rv-grid.com/guide/installation) -### Vanilla JS Grid Usage +### JavaScript Data Grid Usage ```javascript // Select the RevoGrid element from the DOM diff --git a/readme/features.md b/readme/features.md index 7074a646..f2f8e3c2 100644 --- a/readme/features.md +++ b/readme/features.md @@ -2,79 +2,71 @@ - **High Performance**: Handles millions of cells in the viewport with a powerful core built by default. -- **Accessibility**: Follows WAI-ARIA best practices. +- **[Accessibility](https://rv-grid.com/guide/wcag)**: Follows WAI-ARIA best practices. -- **Keyboard Support**: +- **[Keyboard Support](https://rv-grid.com/guide/defs#Keyboard)**: - Excel-like focus for efficient navigation and editing. - Seamless copy/paste from Excel, Google Sheets, or any other sheet format. - **Lightweight**: Minimal initial bundle size ![Min size](https://badgen.net/bundlephobia/min/@revolist/revogrid@latest). Can be imported with polyfills or as a module for modern browsers. -- **Intelligent Virtual DOM**: Smart row recombination to minimize redraws. +- **[Intelligent Virtual DOM](https://rv-grid.com/guide/overview#VNode-Reactive-DOM)**: Smart row recombination to minimize redraws. -- **Virtual Scroll**: Handles large datasets with infinite scroll. +- **[Virtual Scroll](https://rv-grid.com/guide/viewports)**: Handles large datasets with infinite scroll. -- **Formula Support**: Evaluate formulas in cell data. +- **[Drag and Drop](https://rv-grid.com/guide/row/order)**: Drag and drop in [rows](https://rv-grid.com/guide/row/order) and [columns](https://rv-grid.com/guide/column/order). -- **Master Detail/Subtables/Forms**: Expand rows to reveal child data. +- **[Sorting](https://rv-grid.com/guide/sorting)**: Multiple options, customizable per column, with advanced event handling. -- **Drag and Drop**: Drag and drop in rows and columns. - -- **Sorting**: Multiple options, customizable per column, with advanced event handling. - -- **Filtering**: +- **[Filtering](https://rv-grid.com/guide/filters)**: - Predefined system filters. + - Multi column filters. + - Conditional filters. - Preserve existing collections. - Custom filters to extend system filters with your own set. -- **Export**: Export data to file. +- **[Export](https://rv-grid.com/guide/export.plugin)**: Export data to file. -- **Custom Sizes**: Define custom sizes for columns and rows. Automatic sizing based on content. +- **Custom Sizes**: Define custom sizes for [columns](https://rv-grid.com/guide/column/#Column-Size) and [rows](https://rv-grid.com/guide/row/height). Automatic sizing based on content. -- **Column Resizing**: Adjust column widths. +- **[Column Resizing](https://rv-grid.com/guide/column/resize)**: Adjust column widths. - **Pinned/Sticky/Freezed Elements**: - - Columns (define left or right). - - Rows (define top or bottom). + - [Columns](https://rv-grid.com/guide/column/pin) (define left or right). + - [Rows](https://rv-grid.com/guide/row/pin) (define top or bottom). - **Grouping**: - - Column grouping (nested headers). - - Row grouping (nested rows). - -- **Cell Editing**: In-place editing of cell data. - -- **Cell Merging**: Merge cells to form groups. - -- **Customizations**: - - Column header template. - - Row header template. - - Cell template (create your own cell views). - - Cell editor (use predefined or apply your own custom editors and cell types). - - Cell properties (define custom properties for rendered cells). + - [Column grouping](https://rv-grid.com/guide/column/grouping) (nested headers). + - [Row grouping](https://rv-grid.com/guide/row/grouping) (nested rows). - **Column Types**: [More details](https://rv-grid.com/guide/column/#Column-Formats) - - Text/String (default). - - Number. - - Select. - - Date. + - [Text/String](https://rv-grid.com/guide/column/types#String) (default). + - [Number](https://rv-grid.com/guide/column/types#Number). + - [Select/Dropdown](https://rv-grid.com/guide/column/types#Select-Dropdown). + - [Date](https://rv-grid.com/guide/column/types#Date). - Custom (create extended styles using any template). - **Range Operations**: - - Selection. - - Editing. + - [Selection](https://rv-grid.com/guide/defs#Range). + - [Editing](https://rv-grid.com/guide/defs#Range-Autofill). -- **Theme Packages**: +- **[Theme Packages](https://rv-grid.com/guide/theme)**: - Excel-like (default). - Material (compact, dark, or light). -- **Extensibility**: Modern VNode features and tsx support for easy extension. +- **[Extensibility](https://rv-grid.com/guide/jsx.template)**: Modern VNode features and tsx support for easy extension. -- **Trimmed Rows**: Hide rows on demand. +- **[Trimmed Rows](https://rv-grid.com/guide/row/#Trimmed-Rows)**: Hide rows on demand. -- **Plugin System**: Create custom plugins or extend existing ones easily. +- **[Plugin System](https://rv-grid.com/guide/plugin/)**: Create custom plugins or extend existing ones easily. -- **Additional Customizations and Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). +- **[Formula Support](https://rv-grid.com/guide/cell/formula)**: Evaluate formulas in cell data. -
+- **[Master Detail/Subtables/Forms](https://rv-grid.com/guide/row/master.pro)**: Expand rows to reveal child data. +- **[Cell/Column/Row Span/Merge](https://rv-grid.com/guide/cell/merge)**: Merge cells to form groups. +- **Customizations**: + - [Column header template](https://rv-grid.com/guide/column/header.template). + - [Row header template](https://rv-grid.com/guide/row/headers). + - [Cell properties](https://rv-grid.com/guide/cell/) (define custom properties for rendered cells). \ No newline at end of file diff --git a/readme/framework.md b/readme/framework.md index 942a4f77..f34457ca 100644 --- a/readme/framework.md +++ b/readme/framework.md @@ -1,3 +1,8 @@ + - [Cell template](https://rv-grid.com/guide/cell/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/cell/editor) (use predefined or apply your own custom editors and cell types). + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). +

Framework Friendly

diff --git a/readme/usage.angular.md b/readme/usage.angular.md index be6b6888..07464220 100644 --- a/readme/usage.angular.md +++ b/readme/usage.angular.md @@ -1,3 +1,10 @@ + - [Cell template](https://rv-grid.com/guide/angular/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/angular/editor) (use predefined or apply your own custom editors and cell types). + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). + + + ### Usage Angular With NPM: diff --git a/readme/usage.js.md b/readme/usage.js.md index 2f54a911..26e8c062 100644 --- a/readme/usage.js.md +++ b/readme/usage.js.md @@ -1,4 +1,4 @@ -### Vanilla JS Grid Usage +### JavaScript Data Grid Usage ```javascript // Select the RevoGrid element from the DOM diff --git a/readme/usage.react.md b/readme/usage.react.md index 7b41bd58..ee3a66ac 100644 --- a/readme/usage.react.md +++ b/readme/usage.react.md @@ -1,3 +1,9 @@ + - [Cell template](https://rv-grid.com/guide/react/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/react/editor) (use predefined or apply your own custom editors and cell types). + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). + + ### Usage React With NPM: diff --git a/readme/usage.svelte.md b/readme/usage.svelte.md index bcbf6f0f..9126e611 100644 --- a/readme/usage.svelte.md +++ b/readme/usage.svelte.md @@ -1,3 +1,9 @@ + - [Cell template](https://rv-grid.com/guide/cell/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/cell/editor) (use predefined or apply your own custom editors and cell types). + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). + + ### Usage Svelte With NPM: diff --git a/readme/usage.vue2.md b/readme/usage.vue2.md index 6d2ae697..f310e2d5 100644 --- a/readme/usage.vue2.md +++ b/readme/usage.vue2.md @@ -1,9 +1,14 @@ + - [Cell template](https://rv-grid.com/guide/vue2/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/vue2/editor) (use predefined or apply your own custom editors and cell types). + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). + ### Usage Vue 2 With NPM: ```bash -npm i @revolist/vue-datagrid --save; +npm i @revolist/vue2-datagrid --save; ``` With Yarn: diff --git a/readme/usage.vue3.md b/readme/usage.vue3.md index cd763fbd..cd816416 100644 --- a/readme/usage.vue3.md +++ b/readme/usage.vue3.md @@ -1,3 +1,9 @@ + - [Cell template](https://rv-grid.com/guide/vue3/renderer) (create your own cell views). + - [Cell editor](https://rv-grid.com/guide/vue3/editor) (use predefined or apply your own custom editors and cell types). + + +- **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/). + ### Usage Vue 3 With NPM: