@revolist/vue3-datagrid 4.11.16 → 4.11.18

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 CHANGED
@@ -1,20 +1,21 @@
1
- ### 🚨 Repository Notice 🚨
1
+ ### 🚨 Repository Notice
2
2
 
3
- This repo is read-only and will be **deprecated** in v5+ in favor of monorepos. Post issues [here](https://github.com/revolist/revogrid). Happy coding! 🖥️💻
3
+ Post new issues [here](https://github.com/revolist/revogrid). Happy coding! 💻
4
4
 
5
5
  ---
6
6
 
7
7
  <p align="center">
8
8
  <a href="https://rv-grid.com">
9
- <img src="./assets/logo.svg" alt="RevoGrid" height="150" />
9
+ <img src="./assets/logo.svg" alt="RevoGrid Data Grid" height="150" />
10
10
  </a>
11
11
  </p>
12
12
 
13
13
  <p align="center">
14
14
  <a href="https://www.npmjs.com/package/@revolist/revogrid"><img src="https://img.shields.io/npm/v/@revolist/revogrid" alt="Latest Version on NPM"/></a>
15
15
  <a href="https://github.com/revolist/revogrid/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@revolist/revogrid" alt="Software License"/></a>
16
- <img src="https://badgen.net/bundlephobia/dependency-count/@revolist/revogrid@latest" alt="Tree shaking"/>
17
- <img src="https://badgen.net/bundlephobia/tree-shaking/@revolist/revogrid@latest" alt="Tree shaking"/>
16
+ <img src="https://badgen.net/bundlephobia/dependency-count/@revolist/revogrid" alt="Dependency count"/>
17
+ <img src="https://badgen.net/bundlephobia/tree-shaking/@revolist/revogrid" alt="Tree shaking"/>
18
+ <img src="https://img.shields.io/bundlephobia/min/@revolist/revogrid" alt="Bundle size"/>
18
19
  <img src="https://sonarcloud.io/api/project_badges/measure?project=revolist_revogrid&metric=alert_status" alt="Sonar Quality Gate"/>
19
20
  </p>
20
21
 
@@ -44,81 +45,83 @@ Support Millions of cells and thousands of columns easy and efficiently for fast
44
45
 
45
46
  - **High Performance**: Handles millions of cells in the viewport with a powerful core built by default.
46
47
 
47
- - **Accessibility**: Follows WAI-ARIA best practices.
48
+ - **[Accessibility](https://rv-grid.com/guide/wcag)**: Follows WAI-ARIA best practices.
48
49
 
49
- - **Keyboard Support**:
50
+ - **[Keyboard Support](https://rv-grid.com/guide/defs#Keyboard)**:
50
51
  - Excel-like focus for efficient navigation and editing.
51
52
  - Seamless copy/paste from Excel, Google Sheets, or any other sheet format.
52
53
 
53
54
 
54
55
  - **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.
55
56
 
56
- - **Intelligent Virtual DOM**: Smart row recombination to minimize redraws.
57
+ - **[Intelligent Virtual DOM](https://rv-grid.com/guide/overview#VNode-Reactive-DOM)**: Smart row recombination to minimize redraws.
57
58
 
58
- - **Virtual Scroll**: Handles large datasets with infinite scroll.
59
+ - **[Virtual Scroll](https://rv-grid.com/guide/viewports)**: Handles large datasets with infinite scroll.
59
60
 
60
- - **Formula Support**: Evaluate formulas in cell data.
61
+ - **[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).
61
62
 
62
- - **Drag and Drop**: Drag and drop in rows and columns.
63
+ - **[Sorting](https://rv-grid.com/guide/sorting)**: Multiple options, customizable per column, with advanced event handling.
63
64
 
64
- - **Sorting**: Multiple options, customizable per column, with advanced event handling.
65
-
66
- - **Filtering**:
65
+ - **[Filtering](https://rv-grid.com/guide/filters)**:
67
66
  - Predefined system filters.
67
+ - Multi column filters.
68
+ - Conditional filters.
68
69
  - Preserve existing collections.
69
70
  - Custom filters to extend system filters with your own set.
70
71
 
71
- - **Export**: Export data to file.
72
+ - **[Export](https://rv-grid.com/guide/export.plugin)**: Export data to file.
72
73
 
73
- - **Custom Sizes**: Define custom sizes for columns and rows. Automatic sizing based on content.
74
+ - **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.
74
75
 
75
- - **Column Resizing**: Adjust column widths.
76
+ - **[Column Resizing](https://rv-grid.com/guide/column/resize)**: Adjust column widths.
76
77
 
77
78
  - **Pinned/Sticky/Freezed Elements**:
78
- - Columns (define left or right).
79
- - Rows (define top or bottom).
79
+ - [Columns](https://rv-grid.com/guide/column/pin) (define left or right).
80
+ - [Rows](https://rv-grid.com/guide/row/pin) (define top or bottom).
80
81
 
81
82
  - **Grouping**:
82
- - Column grouping (nested headers).
83
- - Row grouping (nested rows).
84
-
85
- - **Cell Editing**: In-place editing of cell data.
86
-
87
- - **Cell Merging**: Merge cells to form groups.
88
-
89
- - **Customizations**:
90
- - Column header template.
91
- - Row header template.
92
- - Cell template (create your own cell views).
93
- - Cell editor (use predefined or apply your own custom editors and cell types).
94
- - Cell properties (define custom properties for rendered cells).
83
+ - [Column grouping](https://rv-grid.com/guide/column/grouping) (nested headers).
84
+ - [Row grouping](https://rv-grid.com/guide/row/grouping) (nested rows).
95
85
 
96
86
  - **Column Types**: [More details](https://rv-grid.com/guide/column/#Column-Formats)
97
- - Text/String (default).
98
- - Number.
99
- - Select.
100
- - Date.
87
+ - [Text/String](https://rv-grid.com/guide/column/types#String) (default).
88
+ - [Number](https://rv-grid.com/guide/column/types#Number).
89
+ - [Select/Dropdown](https://rv-grid.com/guide/column/types#Select-Dropdown).
90
+ - [Date](https://rv-grid.com/guide/column/types#Date).
101
91
  - Custom (create extended styles using any template).
102
92
 
103
93
  - **Range Operations**:
104
- - Selection.
105
- - Editing.
94
+ - [Selection](https://rv-grid.com/guide/defs#Range).
95
+ - [Editing](https://rv-grid.com/guide/defs#Range-Autofill).
106
96
 
107
- - **Theme Packages**:
97
+ - **[Theme Packages](https://rv-grid.com/guide/theme)**:
108
98
  - Excel-like (default).
109
99
  - Material (compact, dark, or light).
110
100
 
111
- - **Extensibility**: Modern VNode features and tsx support for easy extension.
101
+ - **[Extensibility](https://rv-grid.com/guide/jsx.template)**: Modern VNode features and tsx support for easy extension.
112
102
 
113
- - **Trimmed Rows**: Hide rows on demand.
103
+ - **[Trimmed Rows](https://rv-grid.com/guide/row/#Trimmed-Rows)**: Hide rows on demand.
114
104
 
115
- - **Plugin System**: Create custom plugins or extend existing ones easily.
105
+ - **[Plugin System](https://rv-grid.com/guide/plugin/)**: Create custom plugins or extend existing ones easily.
116
106
 
117
- - **Additional Customizations and Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/).
107
+ - **[Formula Support](https://rv-grid.com/guide/cell/formula)**: Evaluate formulas in cell data.
118
108
 
119
- <br>
109
+ - **[Master Detail/Subtables/Forms](https://rv-grid.com/guide/row/master.pro)**: Expand rows to reveal child data.
110
+ - **[Cell/Column/Row Span/Merge](https://rv-grid.com/guide/cell/merge)**: Merge cells to form groups.
120
111
 
112
+ - **Customizations**:
113
+ - [Column header template](https://rv-grid.com/guide/column/header.template).
114
+ - [Row header template](https://rv-grid.com/guide/row/headers).
115
+ - [Cell properties](https://rv-grid.com/guide/cell/) (define custom properties for rendered cells).
121
116
 
117
+ - [Cell template](https://rv-grid.com/guide/vue3/renderer) (create your own cell views).
118
+ - [Cell editor](https://rv-grid.com/guide/vue3/editor) (use predefined or apply your own custom editors and cell types).
119
+
120
+
121
+ - **Rich API & Additional Improvements**: Explore hundreds of other small customizations and improvements in [RevoGrid](https://rv-grid.com/).
122
+
123
+ > [!TIP]
124
+ > For Vue 2, use [this repo](https://github.com/revolist/vue-datagrid)
122
125
 
123
126
  ### Usage Vue 3
124
127
 
@@ -281,11 +284,11 @@ export default defineComponent({
281
284
 
282
285
  - Redesigned type support:
283
286
  - Removed deprecated namespaces:
284
- - **Before**: `RevoGrid.ColumnDataSchemaRegular`
285
- - **Now**: `ColumnDataSchemaRegular`;
287
+ - **Before**: `RevoGrid.ColumnRegular`
288
+ - **Now**: `ColumnRegular`;
286
289
  - Improved type import:
287
290
  - **Before**: `import { RevoGrid } from '@revolist/revogrid/dist/types/interfaces'`
288
- - **Now**: `import { ColumnDataSchemaRegular } from '@revolist/revogrid'`.
291
+ - **Now**: `import { ColumnRegular } from '@revolist/revogrid'`.
289
292
  - Changed viewport type names everywhere. For example, before: `rowDefinitions: [{ type: "row", index: 0, size: 145 }]`, after: `rowDefinitions: [{ type: "rgRow", index: 0, size: 145 }]`.
290
293
  - Updated [event](https://rv-grid.com/guide/api/revoGrid.html#Events) naming convention. Review your [event](https://rv-grid.com/guide/api/revoGrid.html#Events) usage. [Event names](https://rv-grid.com/guide/api/revoGrid.html#Events) are all lowercase now and are aligned with modern event naming conventions. For example, `afterEdit` -> `afteredit`.
291
294
  - Multiple event breaking changes introduced: beforerowrender now returns `BeforeRowRenderEvent`. Check all events for details.
@@ -307,33 +310,28 @@ export default defineComponent({
307
310
 
308
311
  ## Our Sponsors
309
312
 
310
- We would like to extend our heartfelt gratitude to our sponsors for their generous support. Their contributions help us maintain and develop RevoGrid, ensuring continuous improvements and updates.
313
+ We would like to extend our heartfelt gratitude to our sponsors for their generous support. Their contributions help us maintain and develop RevoGrid.
311
314
 
312
315
  [![Altruistiq](https://cdn.prod.website-files.com/62cd69e08130a1a33f5ef900/6310b4d500e971695db5e9c3_615b5db69ce8931a276e5ed2_Social_Icons_AQ_3_32x32.png)](https://altruistiq.com)
313
316
 
314
317
 
315
318
  ### Become a Sponsor
316
319
 
317
- If you or your company would like to support the ongoing development of RevoGrid, please consider becoming a sponsor or use or [Pro version](https://rv-grid.com/pro/). Your support will help us continue to improve the project and provide the best possible tool for the community.
318
-
319
- [![Sponsor Us](https://img.shields.io/badge/Sponsor%20Us-%F0%9F%92%96-brightgreen)](https://opencollective.com/revogrid)
320
+ If you or your company would like to support the ongoing development of RevoGrid, please consider [![Sponsor Us](https://img.shields.io/badge/Sponsor%20Us-%F0%9F%92%96-brightgreen)](https://opencollective.com/revogrid) or use a [Pro version](https://rv-grid.com/pro/). Your support will help us continue to improve the project and provide the best possible tool for the community.
320
321
 
321
322
  Thank you for supporting RevoGrid! 🙏
322
323
 
324
+
323
325
  ## Contributing
324
326
 
325
- We invite you to join our vibrant community and contribute to the growth and success of RevoGrid. By getting involved, you'll have the opportunity to enhance your skills, gain valuable experience, and make a significant impact on an innovative project.
327
+ By getting involved, you'll have the opportunity to enhance your skills, gain valuable experience, and make a significant impact on an innovative project. Your contribution, no matter how big or small, is valuable.
326
328
 
327
329
  ### Why Contribute?
328
330
 
329
- - **Expand Your Knowledge**: Working on RevoGrid allows you to dive deep into modern web technologies, improve your coding skills, and learn best practices in performance optimization, data handling, and component-based architecture.
330
- - **Valuable Experience**: Contributing to an open-source project like RevoGrid provides you with practical experience that can be a great addition to your portfolio. It demonstrates your ability to work collaboratively, solve complex problems, and contribute to a project's success.
331
- - **Professional Growth**: By contributing, you become part of a network of talented developers. This can lead to mentorship opportunities, collaborations, and professional connections that can benefit your career.
332
- - **Make a Difference**: Your contributions can help improve RevoGrid, making it more powerful and user-friendly for developers around the world. Your input can shape the future of the project and drive innovation.
333
-
334
- ### Join Us
331
+ - **Expand Your Knowledge**: Working on complex libraries allows you to dive deep into modern web technologies, improve your coding skills, and learn best practices in performance optimization, data handling, and component-based architecture.
332
+ - **Experience**: Contributing to an open-source project like provides you with practical experience that can be a great addition to your portfolio. It demonstrates your ability to work collaboratively, solve complex problems, and contribute to a project's success.
333
+ - **Professional Growth**: By contributing, you become part of a network of talented developers. This can lead to mentorship opportunities, collaborations, and professional connections that can benefit your career.
335
334
 
336
- Your contribution, no matter how big or small, is valuable. By working on RevoGrid, you'll be part of an exciting project that's making a difference in the world of data grids. Join us today and let's build something amazing together!
337
335
 
338
336
  ## License
339
337
 
package/dist/index.d.ts CHANGED
@@ -16,11 +16,11 @@ declare type CreateVNodeParameters = (Parameters<typeof createVNode>)[0];
16
16
  /**
17
17
  * Data passed to editor
18
18
  */
19
- export declare type EditorType = {
19
+ export declare interface EditorType extends Partial<EditCell> {
20
20
  column: ColumnDataSchemaModel;
21
21
  save: (value: any, preventFocus?: boolean) => void;
22
22
  close: (focusNext?: boolean) => void;
23
- } & Partial<EditCell>;
23
+ }
24
24
 
25
25
  declare interface InputProps<T> {
26
26
  modelValue?: T;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@revolist/vue3-datagrid",
3
- "version": "4.11.16",
3
+ "version": "4.11.18",
4
4
  "description": "Vue 3 DataGrid Spreadsheet component with native Vue 3 cell render support",
5
5
  "main": "./dist/vue3-datagrid.umd.cjs",
6
6
  "module": "./dist/vue3-datagrid.js",
@@ -65,7 +65,7 @@
65
65
  "homepage": "https://github.com/revolist/revogrid#readme",
66
66
  "license": "MIT",
67
67
  "dependencies": {
68
- "@revolist/revogrid": "4.11.16"
68
+ "@revolist/revogrid": "4.11.18"
69
69
  },
70
70
  "devDependencies": {
71
71
  "@stencil/core": "^4.19.2",