@bryntum/grid-vue 7.1.1 → 7.1.3
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 +130 -22
- package/Version.md +8 -0
- package/package.json +1 -1
- package/src/BryntumGrid.vue +6 -0
- package/src/BryntumGridBase.vue +6 -0
- package/src/BryntumTreeGrid.vue +6 -0
package/README.md
CHANGED
|
@@ -1,51 +1,159 @@
|
|
|
1
|
-
|
|
1
|
+
<br>
|
|
2
|
+
<br>
|
|
2
3
|
|
|
3
|
-
|
|
4
|
-
|
|
4
|
+
<p align="center">
|
|
5
|
+
<a href="https://bryntum.com/" rel="noopener" target="_blank">
|
|
6
|
+
<img width="350" src="https://bryntum.com/resources/bryntum_logo_blue.svg" alt="Bryntum logo">
|
|
7
|
+
</a>
|
|
8
|
+
     
|
|
9
|
+
<img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/vue.svg" alt="Vue" width="100">
|
|
10
|
+
</p>
|
|
5
11
|
|
|
6
|
-
|
|
12
|
+
<br>
|
|
7
13
|
|
|
8
|
-
|
|
9
|
-
You must be logged in to this repository as a licensed or trial user to access it.
|
|
10
|
-
Please check the [Online npm repository guide](https://bryntum.com/products/grid/docs/guide/Grid/npm-repository) for detailed information on the sign-up/login
|
|
11
|
-
process.
|
|
14
|
+
# Vue 2 wrapper for Bryntum Grid
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
This package provides a wrapper that turns Bryntum Grid into a Vue 2 component, exposing configuration options,
|
|
17
|
+
properties, features, and events.
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
command depends on the package manager used by the application.
|
|
19
|
+
## Version Requirement
|
|
17
20
|
|
|
18
|
-
|
|
21
|
+
* Vue: `2.6` or higher
|
|
22
|
+
* TypeScript: `4.2` or higher (optional)
|
|
19
23
|
|
|
20
|
-
|
|
24
|
+
### Vue 3 version compatibility
|
|
21
25
|
|
|
22
|
-
|
|
23
|
-
|
|
26
|
+
For Vue 3+, use [`@bryntum/grid-vue-3`](https://www.npmjs.com/package/@bryntum/grid-vue-3) instead.
|
|
27
|
+
|
|
28
|
+
## Package Contents
|
|
29
|
+
|
|
30
|
+
| Path | Description |
|
|
31
|
+
|----------|---------------------------------------------------|
|
|
32
|
+
| `src/` | Original Vue source files (BryntumGrid etc.) |
|
|
33
|
+
| `*.d.ts` | TypeScript type definitions |
|
|
34
|
+
|
|
35
|
+
**Note:** This is a wrapper package. The core `@bryntum/grid` package must be installed separately.
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
### Vue 2 Wrapper
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm install @bryntum/grid-vue@latest
|
|
24
43
|
```
|
|
25
44
|
|
|
26
|
-
|
|
45
|
+
### Component Package (Required)
|
|
27
46
|
|
|
28
|
-
```
|
|
29
|
-
|
|
47
|
+
```bash
|
|
48
|
+
npm install @bryntum/grid@latest
|
|
30
49
|
```
|
|
31
50
|
|
|
32
|
-
|
|
51
|
+
## Try Bryntum Online Demos
|
|
52
|
+
|
|
53
|
+
* [View Online Vue Demos](https://bryntum.com/products/grid/examples/?framework=vue)
|
|
54
|
+
|
|
55
|
+
## Quick Start
|
|
56
|
+
|
|
57
|
+
Edit the `src/App.vue` file and replace the content with the following:
|
|
58
|
+
|
|
59
|
+
```javascript
|
|
60
|
+
<template>
|
|
61
|
+
<bryntum-grid
|
|
62
|
+
:columns="columns"
|
|
63
|
+
:data="data"
|
|
64
|
+
/>
|
|
65
|
+
</template>
|
|
66
|
+
|
|
67
|
+
<script>
|
|
68
|
+
import { BryntumGrid } from '@bryntum/grid-vue';
|
|
69
|
+
import './app.css';
|
|
70
|
+
|
|
71
|
+
export default {
|
|
72
|
+
components : {
|
|
73
|
+
BryntumGrid
|
|
74
|
+
},
|
|
75
|
+
data() {
|
|
76
|
+
return {
|
|
77
|
+
columns : [
|
|
78
|
+
{ field : 'name', text : 'Name', flex : 1 },
|
|
79
|
+
{ field : 'role', text : 'Role', width : 150 }
|
|
80
|
+
],
|
|
81
|
+
data : [
|
|
82
|
+
{ name : 'John Doe', role : 'Developer' },
|
|
83
|
+
{ name : 'Jane Smith', role : 'Designer' }
|
|
84
|
+
]
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
</script>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Lastly, add some styling to your `src/main.js` or CSS file:
|
|
92
|
+
|
|
93
|
+
```css
|
|
94
|
+
/* FontAwesome is used for icons */
|
|
95
|
+
@import '@bryntum/grid/fontawesome/css/fontawesome.css';
|
|
96
|
+
@import '@bryntum/grid/fontawesome/css/solid.css';
|
|
97
|
+
/* Structural CSS */
|
|
98
|
+
@import "@bryntum/grid/grid.css";
|
|
99
|
+
/* Bryntum theme of your choice */
|
|
100
|
+
@import "@bryntum/grid/svalbard-light.css";
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Integration Guide
|
|
33
104
|
|
|
34
105
|
For details on installing and using this package, see the
|
|
35
106
|
[Vue Integration Guide](https://bryntum.com/products/grid/docs/guide/Grid/integration/vue/guide).
|
|
36
107
|
|
|
37
|
-
|
|
108
|
+
## Wrappers
|
|
109
|
+
|
|
110
|
+
Vue wrappers encapsulate Bryntum components as native Vue components, exposing all configuration options,
|
|
111
|
+
properties, features, and events through Vue-familiar patterns like props, events, and slots.
|
|
112
|
+
|
|
113
|
+
Visit [Wrappers documentation](https://bryntum.com/products/grid/docs/guide/Grid/integration/vue/guide#wrappers) for the complete list of available
|
|
114
|
+
wrapper components.
|
|
115
|
+
|
|
116
|
+
## Features
|
|
117
|
+
|
|
118
|
+
Features are optional modules that extend Bryntum Grid functionality. Each feature is suffixed with `Feature` and
|
|
119
|
+
can be enabled and configured through standard Vue props.
|
|
120
|
+
|
|
121
|
+
Visit [Features documentation](https://bryntum.com/products/grid/docs/guide/Grid/integration/vue/guide#features) for the complete list of available
|
|
122
|
+
features and their configuration options.
|
|
123
|
+
|
|
124
|
+
## Explore All Bryntum Products
|
|
125
|
+
|
|
126
|
+
* [Bryntum Grid](https://bryntum.com/products/grid/) - High-performance data grid
|
|
127
|
+
* [Bryntum Scheduler](https://bryntum.com/products/scheduler/) - Resource scheduling component
|
|
128
|
+
* [Bryntum Scheduler Pro](https://bryntum.com/products/schedulerpro/) - Advanced scheduling with dependencies
|
|
129
|
+
* [Bryntum Gantt](https://bryntum.com/products/gantt/) - Project planning and management
|
|
130
|
+
* [Bryntum Calendar](https://bryntum.com/products/calendar/) - Full-featured calendar component
|
|
131
|
+
* [Bryntum TaskBoard](https://bryntum.com/products/taskboard/) - Kanban-style task management
|
|
132
|
+
|
|
133
|
+
Explore our comprehensive collection of demos:
|
|
134
|
+
|
|
135
|
+
| Product | <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/js.svg" alt="JavaScript" width="30"><br>JavaScript | <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/react.svg" alt="React" width="30"><br>React | <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/vue.svg" alt="Vue" width="30"><br>Vue | <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/angular.svg" alt="Angular" width="30"><br>Angular |
|
|
136
|
+
|-------------------|:------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:----------------------------------------------------------------------:|:------------------------------------------------------------------------------:|
|
|
137
|
+
| **Grid** | [Grid JavaScript demos](https://bryntum.com/products/grid/examples/?framework=javascript) | [Grid React demos](https://bryntum.com/products/grid/examples/?framework=react) | [Grid Vue demos](https://bryntum.com/products/grid/examples/?framework=vue) | [Grid Angular demos](https://bryntum.com/products/grid/examples/?framework=angular) |
|
|
138
|
+
| **Scheduler** | [Scheduler JavaScript demos](https://bryntum.com/products/scheduler/examples/?framework=javascript) | [Scheduler React demos](https://bryntum.com/products/scheduler/examples/?framework=react) | [Scheduler Vue demos](https://bryntum.com/products/scheduler/examples/?framework=vue) | [Scheduler Angular demos](https://bryntum.com/products/scheduler/examples/?framework=angular) |
|
|
139
|
+
| **Scheduler Pro** | [Scheduler Pro JavaScript demos](https://bryntum.com/products/schedulerpro/examples/?framework=javascript) | [Scheduler Pro React demos](https://bryntum.com/products/schedulerpro/examples/?framework=react) | [Scheduler Pro Vue demos](https://bryntum.com/products/schedulerpro/examples/?framework=vue) | [Scheduler Pro Angular demos](https://bryntum.com/products/schedulerpro/examples/?framework=angular) |
|
|
140
|
+
| **Gantt** | [Gantt JavaScript demos](https://bryntum.com/products/gantt/examples/?framework=javascript) | [Gantt React demos](https://bryntum.com/products/gantt/examples/?framework=react) | [Gantt Vue demos](https://bryntum.com/products/gantt/examples/?framework=vue) | [Gantt Angular demos](https://bryntum.com/products/gantt/examples/?framework=angular) |
|
|
141
|
+
| **Calendar** | [Calendar JavaScript demos](https://bryntum.com/products/calendar/examples/?framework=javascript) | [Calendar React demos](https://bryntum.com/products/calendar/examples/?framework=react) | [Calendar Vue demos](https://bryntum.com/products/calendar/examples/?framework=vue) | [Calendar Angular demos](https://bryntum.com/products/calendar/examples/?framework=angular) |
|
|
142
|
+
| **TaskBoard** | [TaskBoard JavaScript demos](https://bryntum.com/products/taskboard/examples/?framework=javascript) | [TaskBoard React demos](https://bryntum.com/products/taskboard/examples/?framework=react) | [TaskBoard Vue demos](https://bryntum.com/products/taskboard/examples/?framework=vue) | [TaskBoard Angular demos](https://bryntum.com/products/taskboard/examples/?framework=angular) |
|
|
143
|
+
|
|
144
|
+
## Online references
|
|
38
145
|
|
|
39
|
-
* [Bryntum npm repository guide](https://bryntum.com/products/grid/docs/guide/Grid/npm-repository)
|
|
40
146
|
* [Bryntum Grid documentation](https://bryntum.com/products/grid/docs/)
|
|
41
147
|
* [Bryntum Grid examples](https://bryntum.com/products/grid/examples/)
|
|
148
|
+
|
|
42
149
|
* [Bryntum Support Forum](https://forum.bryntum.com/)
|
|
43
150
|
* [Contact us](https://bryntum.com/contact/)
|
|
44
151
|
|
|
45
|
-
|
|
152
|
+
## License and copyright
|
|
46
153
|
|
|
47
154
|
This wrapper depends on Bryntum Grid, which is commercial software and requires a paid license.
|
|
48
155
|
Please visit the [Bryntum Grid End User License](https://bryntum.com/products/grid/license/) for the full text of the license.
|
|
49
156
|
|
|
50
157
|
Copyright © 2009-2026, Bryntum
|
|
51
158
|
All rights reserved.
|
|
159
|
+
|
package/Version.md
ADDED
package/package.json
CHANGED
package/src/BryntumGrid.vue
CHANGED
|
@@ -178,6 +178,7 @@ export default {
|
|
|
178
178
|
onBeforeCellEditStart : { type : Function },
|
|
179
179
|
onBeforeCellRangeDelete : { type : Function },
|
|
180
180
|
onBeforeCellRangeEdit : { type : Function },
|
|
181
|
+
onBeforeColumnCollapseToggle : { type : Function },
|
|
181
182
|
onBeforeColumnDragStart : { type : Function },
|
|
182
183
|
onBeforeColumnDropFinalize : { type : Function },
|
|
183
184
|
onBeforeColumnResize : { type : Function },
|
|
@@ -218,6 +219,7 @@ export default {
|
|
|
218
219
|
onCellMouseOver : { type : Function },
|
|
219
220
|
onCollapse : { type : Function },
|
|
220
221
|
onCollapseNode : { type : Function },
|
|
222
|
+
onColumnCollapseToggle : { type : Function },
|
|
221
223
|
onColumnDrag : { type : Function },
|
|
222
224
|
onColumnDragStart : { type : Function },
|
|
223
225
|
onColumnDrop : { type : Function },
|
|
@@ -507,6 +509,7 @@ export default {
|
|
|
507
509
|
'onBeforeCellEditStart',
|
|
508
510
|
'onBeforeCellRangeDelete',
|
|
509
511
|
'onBeforeCellRangeEdit',
|
|
512
|
+
'onBeforeColumnCollapseToggle',
|
|
510
513
|
'onBeforeColumnDragStart',
|
|
511
514
|
'onBeforeColumnDropFinalize',
|
|
512
515
|
'onBeforeColumnResize',
|
|
@@ -547,6 +550,7 @@ export default {
|
|
|
547
550
|
'onCellMouseOver',
|
|
548
551
|
'onCollapse',
|
|
549
552
|
'onCollapseNode',
|
|
553
|
+
'onColumnCollapseToggle',
|
|
550
554
|
'onColumnDrag',
|
|
551
555
|
'onColumnDragStart',
|
|
552
556
|
'onColumnDrop',
|
|
@@ -656,6 +660,7 @@ export default {
|
|
|
656
660
|
'beforeCellEditStart',
|
|
657
661
|
'beforeCellRangeDelete',
|
|
658
662
|
'beforeCellRangeEdit',
|
|
663
|
+
'beforeColumnCollapseToggle',
|
|
659
664
|
'beforeColumnDragStart',
|
|
660
665
|
'beforeColumnDropFinalize',
|
|
661
666
|
'beforeColumnResize',
|
|
@@ -696,6 +701,7 @@ export default {
|
|
|
696
701
|
'cellMouseOver',
|
|
697
702
|
'collapse',
|
|
698
703
|
'collapseNode',
|
|
704
|
+
'columnCollapseToggle',
|
|
699
705
|
'columnDrag',
|
|
700
706
|
'columnDragStart',
|
|
701
707
|
'columnDrop',
|
package/src/BryntumGridBase.vue
CHANGED
|
@@ -177,6 +177,7 @@ export default {
|
|
|
177
177
|
onBeforeCellEditStart : { type : Function },
|
|
178
178
|
onBeforeCellRangeDelete : { type : Function },
|
|
179
179
|
onBeforeCellRangeEdit : { type : Function },
|
|
180
|
+
onBeforeColumnCollapseToggle : { type : Function },
|
|
180
181
|
onBeforeColumnDragStart : { type : Function },
|
|
181
182
|
onBeforeColumnDropFinalize : { type : Function },
|
|
182
183
|
onBeforeColumnResize : { type : Function },
|
|
@@ -217,6 +218,7 @@ export default {
|
|
|
217
218
|
onCellMouseOver : { type : Function },
|
|
218
219
|
onCollapse : { type : Function },
|
|
219
220
|
onCollapseNode : { type : Function },
|
|
221
|
+
onColumnCollapseToggle : { type : Function },
|
|
220
222
|
onColumnDrag : { type : Function },
|
|
221
223
|
onColumnDragStart : { type : Function },
|
|
222
224
|
onColumnDrop : { type : Function },
|
|
@@ -504,6 +506,7 @@ export default {
|
|
|
504
506
|
'onBeforeCellEditStart',
|
|
505
507
|
'onBeforeCellRangeDelete',
|
|
506
508
|
'onBeforeCellRangeEdit',
|
|
509
|
+
'onBeforeColumnCollapseToggle',
|
|
507
510
|
'onBeforeColumnDragStart',
|
|
508
511
|
'onBeforeColumnDropFinalize',
|
|
509
512
|
'onBeforeColumnResize',
|
|
@@ -544,6 +547,7 @@ export default {
|
|
|
544
547
|
'onCellMouseOver',
|
|
545
548
|
'onCollapse',
|
|
546
549
|
'onCollapseNode',
|
|
550
|
+
'onColumnCollapseToggle',
|
|
547
551
|
'onColumnDrag',
|
|
548
552
|
'onColumnDragStart',
|
|
549
553
|
'onColumnDrop',
|
|
@@ -653,6 +657,7 @@ export default {
|
|
|
653
657
|
'beforeCellEditStart',
|
|
654
658
|
'beforeCellRangeDelete',
|
|
655
659
|
'beforeCellRangeEdit',
|
|
660
|
+
'beforeColumnCollapseToggle',
|
|
656
661
|
'beforeColumnDragStart',
|
|
657
662
|
'beforeColumnDropFinalize',
|
|
658
663
|
'beforeColumnResize',
|
|
@@ -693,6 +698,7 @@ export default {
|
|
|
693
698
|
'cellMouseOver',
|
|
694
699
|
'collapse',
|
|
695
700
|
'collapseNode',
|
|
701
|
+
'columnCollapseToggle',
|
|
696
702
|
'columnDrag',
|
|
697
703
|
'columnDragStart',
|
|
698
704
|
'columnDrop',
|
package/src/BryntumTreeGrid.vue
CHANGED
|
@@ -178,6 +178,7 @@ export default {
|
|
|
178
178
|
onBeforeCellEditStart : { type : Function },
|
|
179
179
|
onBeforeCellRangeDelete : { type : Function },
|
|
180
180
|
onBeforeCellRangeEdit : { type : Function },
|
|
181
|
+
onBeforeColumnCollapseToggle : { type : Function },
|
|
181
182
|
onBeforeColumnDragStart : { type : Function },
|
|
182
183
|
onBeforeColumnDropFinalize : { type : Function },
|
|
183
184
|
onBeforeColumnResize : { type : Function },
|
|
@@ -218,6 +219,7 @@ export default {
|
|
|
218
219
|
onCellMouseOver : { type : Function },
|
|
219
220
|
onCollapse : { type : Function },
|
|
220
221
|
onCollapseNode : { type : Function },
|
|
222
|
+
onColumnCollapseToggle : { type : Function },
|
|
221
223
|
onColumnDrag : { type : Function },
|
|
222
224
|
onColumnDragStart : { type : Function },
|
|
223
225
|
onColumnDrop : { type : Function },
|
|
@@ -506,6 +508,7 @@ export default {
|
|
|
506
508
|
'onBeforeCellEditStart',
|
|
507
509
|
'onBeforeCellRangeDelete',
|
|
508
510
|
'onBeforeCellRangeEdit',
|
|
511
|
+
'onBeforeColumnCollapseToggle',
|
|
509
512
|
'onBeforeColumnDragStart',
|
|
510
513
|
'onBeforeColumnDropFinalize',
|
|
511
514
|
'onBeforeColumnResize',
|
|
@@ -546,6 +549,7 @@ export default {
|
|
|
546
549
|
'onCellMouseOver',
|
|
547
550
|
'onCollapse',
|
|
548
551
|
'onCollapseNode',
|
|
552
|
+
'onColumnCollapseToggle',
|
|
549
553
|
'onColumnDrag',
|
|
550
554
|
'onColumnDragStart',
|
|
551
555
|
'onColumnDrop',
|
|
@@ -655,6 +659,7 @@ export default {
|
|
|
655
659
|
'beforeCellEditStart',
|
|
656
660
|
'beforeCellRangeDelete',
|
|
657
661
|
'beforeCellRangeEdit',
|
|
662
|
+
'beforeColumnCollapseToggle',
|
|
658
663
|
'beforeColumnDragStart',
|
|
659
664
|
'beforeColumnDropFinalize',
|
|
660
665
|
'beforeColumnResize',
|
|
@@ -695,6 +700,7 @@ export default {
|
|
|
695
700
|
'cellMouseOver',
|
|
696
701
|
'collapse',
|
|
697
702
|
'collapseNode',
|
|
703
|
+
'columnCollapseToggle',
|
|
698
704
|
'columnDrag',
|
|
699
705
|
'columnDragStart',
|
|
700
706
|
'columnDrop',
|