@vaadin/grid 24.0.0 → 24.1.0-alpha2
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 +2 -2
- package/package.json +10 -10
- package/src/vaadin-grid-column-group.js +5 -7
- package/src/vaadin-grid-data-provider-mixin.d.ts +17 -0
- package/src/vaadin-grid-data-provider-mixin.js +87 -17
- package/src/vaadin-grid-drag-and-drop-mixin.js +6 -6
- package/src/vaadin-grid-dynamic-columns-mixin.js +9 -2
- package/src/vaadin-grid-helpers.js +31 -3
- package/src/vaadin-grid-keyboard-navigation-mixin.js +1 -1
- package/src/vaadin-grid-scroll-mixin.d.ts +3 -6
- package/src/vaadin-grid-scroll-mixin.js +4 -4
- package/src/vaadin-grid-styles.js +5 -2
- package/src/vaadin-grid.d.ts +1 -1
- package/src/vaadin-grid.js +70 -37
- package/web-types.json +4 -4
- package/web-types.lit.json +4 -4
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ A web component for showing tabular data.
|
|
|
29
29
|
</script>
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/
|
|
32
|
+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/grid/screenshot.png" alt="Screenshot of vaadin-grid">](https://vaadin.com/docs/latest/components/grid)
|
|
33
33
|
|
|
34
34
|
## Installation
|
|
35
35
|
|
|
@@ -53,7 +53,7 @@ import '@vaadin/grid/vaadin-grid-tree-column.js';
|
|
|
53
53
|
## Themes
|
|
54
54
|
|
|
55
55
|
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
|
|
56
|
-
The [main entrypoint](https://github.com/vaadin/web-components/blob/
|
|
56
|
+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/grid/vaadin-grid.js) of the package uses the Lumo theme.
|
|
57
57
|
|
|
58
58
|
To use the Material theme, import the components from the `theme/material` folder:
|
|
59
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/grid",
|
|
3
|
-
"version": "24.
|
|
3
|
+
"version": "24.1.0-alpha2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -46,17 +46,17 @@
|
|
|
46
46
|
"dependencies": {
|
|
47
47
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
48
48
|
"@polymer/polymer": "^3.0.0",
|
|
49
|
-
"@vaadin/
|
|
50
|
-
"@vaadin/
|
|
51
|
-
"@vaadin/
|
|
52
|
-
"@vaadin/
|
|
53
|
-
"@vaadin/
|
|
54
|
-
"@vaadin/vaadin-
|
|
55
|
-
"@vaadin/vaadin-
|
|
49
|
+
"@vaadin/a11y-base": "24.1.0-alpha2",
|
|
50
|
+
"@vaadin/checkbox": "24.1.0-alpha2",
|
|
51
|
+
"@vaadin/component-base": "24.1.0-alpha2",
|
|
52
|
+
"@vaadin/lit-renderer": "24.1.0-alpha2",
|
|
53
|
+
"@vaadin/text-field": "24.1.0-alpha2",
|
|
54
|
+
"@vaadin/vaadin-lumo-styles": "24.1.0-alpha2",
|
|
55
|
+
"@vaadin/vaadin-material-styles": "24.1.0-alpha2",
|
|
56
|
+
"@vaadin/vaadin-themable-mixin": "24.1.0-alpha2"
|
|
56
57
|
},
|
|
57
58
|
"devDependencies": {
|
|
58
59
|
"@esm-bundle/chai": "^4.3.4",
|
|
59
|
-
"@vaadin/polymer-legacy-adapter": "~24.0.0",
|
|
60
60
|
"@vaadin/testing-helpers": "^0.4.0",
|
|
61
61
|
"lit": "^2.0.0",
|
|
62
62
|
"sinon": "^13.0.2"
|
|
@@ -65,5 +65,5 @@
|
|
|
65
65
|
"web-types.json",
|
|
66
66
|
"web-types.lit.json"
|
|
67
67
|
],
|
|
68
|
-
"gitHead": "
|
|
68
|
+
"gitHead": "9e3ee2557109030f2aba59e17a84e4e121d699c0"
|
|
69
69
|
}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
|
|
7
7
|
import { PolymerElement } from '@polymer/polymer/polymer-element.js';
|
|
8
|
-
import { animationFrame
|
|
8
|
+
import { animationFrame } from '@vaadin/component-base/src/async.js';
|
|
9
9
|
import { Debouncer } from '@vaadin/component-base/src/debounce.js';
|
|
10
10
|
import { ColumnBaseMixin } from './vaadin-grid-column.js';
|
|
11
11
|
import { updateColumnOrders } from './vaadin-grid-helpers.js';
|
|
@@ -377,12 +377,10 @@ class GridColumnGroup extends ColumnBaseMixin(PolymerElement) {
|
|
|
377
377
|
this._updateVisibleChildColumns(this._childColumns);
|
|
378
378
|
this._preventHiddenSynchronization = false;
|
|
379
379
|
|
|
380
|
-
// Update the column tree
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
}
|
|
385
|
-
});
|
|
380
|
+
// Update the column tree
|
|
381
|
+
if (this._grid && this._grid._debounceUpdateColumnTree) {
|
|
382
|
+
this._grid._debounceUpdateColumnTree();
|
|
383
|
+
}
|
|
386
384
|
}
|
|
387
385
|
});
|
|
388
386
|
this._observer.flush();
|
|
@@ -54,6 +54,8 @@ export declare class ItemCache<TItem> {
|
|
|
54
54
|
ensureSubCacheForScaledIndex(scaledIndex: number): void;
|
|
55
55
|
|
|
56
56
|
getCacheAndIndex(index: number): { cache: ItemCache<TItem>; scaledIndex: number };
|
|
57
|
+
|
|
58
|
+
getFlatIndex(scaledIndex: number): number;
|
|
57
59
|
}
|
|
58
60
|
|
|
59
61
|
export declare function DataProviderMixin<TItem, T extends Constructor<HTMLElement>>(
|
|
@@ -138,4 +140,19 @@ export declare class DataProviderMixinClass<TItem> {
|
|
|
138
140
|
* Clears the cached pages and reloads data from dataprovider when needed.
|
|
139
141
|
*/
|
|
140
142
|
clearCache(): void;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Scroll to a specific row index in the virtual list. Note that the row index is
|
|
146
|
+
* not always the same for any particular item. For example, sorting or filtering
|
|
147
|
+
* items can affect the row index related to an item.
|
|
148
|
+
*
|
|
149
|
+
* The `indexes` parameter can be either a single number or multiple numbers.
|
|
150
|
+
* The grid will first try to scroll to the item at the first index on the top level.
|
|
151
|
+
* In case the item at the first index is expanded, the grid will then try scroll to the
|
|
152
|
+
* item at the second index within the children of the expanded first item, and so on.
|
|
153
|
+
* Each given index points to a child of the item at the previous index.
|
|
154
|
+
*
|
|
155
|
+
* Using `Infinity` as an index will point to the last item on the level.
|
|
156
|
+
*/
|
|
157
|
+
scrollToIndex(...indexes: number[]): void;
|
|
141
158
|
}
|
|
@@ -96,6 +96,21 @@ export const ItemCache = class ItemCache {
|
|
|
96
96
|
}
|
|
97
97
|
return { cache: this, scaledIndex: thisLevelIndex };
|
|
98
98
|
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Gets the scaled index as flattened index on this cache level.
|
|
102
|
+
* In practice, this means that the effective size of any expanded
|
|
103
|
+
* subcaches preceding the index are added to the value.
|
|
104
|
+
* @param {number} scaledIndex
|
|
105
|
+
* @return {number} The flat index on this cache level.
|
|
106
|
+
*/
|
|
107
|
+
getFlatIndex(scaledIndex) {
|
|
108
|
+
const clampedIndex = Math.max(0, Math.min(this.size - 1, scaledIndex));
|
|
109
|
+
|
|
110
|
+
return Object.entries(this.itemCaches).reduce((prev, [index, subCache]) => {
|
|
111
|
+
return clampedIndex > Number(index) ? prev + subCache.effectiveSize : prev;
|
|
112
|
+
}, clampedIndex);
|
|
113
|
+
}
|
|
99
114
|
};
|
|
100
115
|
|
|
101
116
|
/**
|
|
@@ -382,26 +397,33 @@ export const DataProviderMixin = (superClass) =>
|
|
|
382
397
|
cache.size = items.length;
|
|
383
398
|
}
|
|
384
399
|
|
|
385
|
-
const currentItems = Array.from(this.$.items.children).map((row) => row._item);
|
|
386
|
-
|
|
387
400
|
// Populate the cache with new items
|
|
388
401
|
items.forEach((item, itemsIndex) => {
|
|
389
402
|
const itemIndex = page * this.pageSize + itemsIndex;
|
|
390
403
|
cache.items[itemIndex] = item;
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
404
|
+
});
|
|
405
|
+
|
|
406
|
+
// With the new items added, update the cache size and the grid's effective size
|
|
407
|
+
this._cache.updateSize();
|
|
408
|
+
this._effectiveSize = this._cache.effectiveSize;
|
|
409
|
+
|
|
410
|
+
// After updating the cache, check if some of the expanded items should have sub-caches loaded
|
|
411
|
+
this._getVisibleRows().forEach((row) => {
|
|
412
|
+
const { cache, scaledIndex } = this._cache.getCacheAndIndex(row.index);
|
|
413
|
+
const item = cache.items[scaledIndex];
|
|
414
|
+
if (item && this._isExpanded(item)) {
|
|
415
|
+
cache.ensureSubCacheForScaledIndex(scaledIndex);
|
|
394
416
|
}
|
|
395
417
|
});
|
|
396
418
|
|
|
397
419
|
this._hasData = true;
|
|
398
420
|
|
|
421
|
+
// Remove the pending request
|
|
399
422
|
delete cache.pendingRequests[page];
|
|
400
423
|
|
|
424
|
+
// Schedule a debouncer to update the visible rows
|
|
401
425
|
this._debouncerApplyCachedData = Debouncer.debounce(this._debouncerApplyCachedData, timeOut.after(0), () => {
|
|
402
426
|
this._setLoading(false);
|
|
403
|
-
this._cache.updateSize();
|
|
404
|
-
this._effectiveSize = this._cache.effectiveSize;
|
|
405
427
|
|
|
406
428
|
iterateChildren(this.$.items, (row) => {
|
|
407
429
|
if (!row.hidden) {
|
|
@@ -412,13 +434,15 @@ export const DataProviderMixin = (superClass) =>
|
|
|
412
434
|
}
|
|
413
435
|
});
|
|
414
436
|
|
|
415
|
-
this.
|
|
437
|
+
this.__scrollToPendingIndexes();
|
|
416
438
|
});
|
|
417
439
|
|
|
440
|
+
// If the grid is not loading anything, flush the debouncer immediately
|
|
418
441
|
if (!this._cache.isLoading()) {
|
|
419
442
|
this._debouncerApplyCachedData.flush();
|
|
420
443
|
}
|
|
421
444
|
|
|
445
|
+
// Notify that new data has been received
|
|
422
446
|
this.__itemsReceived();
|
|
423
447
|
});
|
|
424
448
|
}
|
|
@@ -517,19 +541,65 @@ export const DataProviderMixin = (superClass) =>
|
|
|
517
541
|
return result;
|
|
518
542
|
}
|
|
519
543
|
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
544
|
+
/**
|
|
545
|
+
* Scroll to a specific row index in the virtual list. Note that the row index is
|
|
546
|
+
* not always the same for any particular item. For example, sorting or filtering
|
|
547
|
+
* items can affect the row index related to an item.
|
|
548
|
+
*
|
|
549
|
+
* The `indexes` parameter can be either a single number or multiple numbers.
|
|
550
|
+
* The grid will first try to scroll to the item at the first index on the top level.
|
|
551
|
+
* In case the item at the first index is expanded, the grid will then try scroll to the
|
|
552
|
+
* item at the second index within the children of the expanded first item, and so on.
|
|
553
|
+
* Each given index points to a child of the item at the previous index.
|
|
554
|
+
*
|
|
555
|
+
* Using `Infinity` as an index will point to the last item on the level.
|
|
556
|
+
*
|
|
557
|
+
* @param indexes {...number} Row indexes to scroll to
|
|
558
|
+
*/
|
|
559
|
+
scrollToIndex(...indexes) {
|
|
560
|
+
// Synchronous data provider may cause changes to the cache on scroll without
|
|
561
|
+
// ending up in a loading state. Try scrolling to the index until the target
|
|
562
|
+
// index stabilizes.
|
|
563
|
+
let targetIndex;
|
|
564
|
+
while (targetIndex !== (targetIndex = this.__getGlobalFlatIndex(indexes))) {
|
|
565
|
+
this._scrollToFlatIndex(targetIndex);
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
if (this._cache.isLoading() || !this.clientHeight) {
|
|
569
|
+
this.__pendingScrollToIndexes = indexes;
|
|
570
|
+
}
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* Recursively returns the globally flat index of the item the given indexes point to.
|
|
575
|
+
* Each index in the array points to a sub-item of the previous index.
|
|
576
|
+
* Using `Infinity` as an index will point to the last item on the level.
|
|
577
|
+
*
|
|
578
|
+
* @param {!Array<number>} indexes
|
|
579
|
+
* @param {!ItemCache} cache
|
|
580
|
+
* @param {number} flatIndex
|
|
581
|
+
* @return {number}
|
|
582
|
+
* @private
|
|
583
|
+
*/
|
|
584
|
+
__getGlobalFlatIndex([levelIndex, ...subIndexes], cache = this._cache, flatIndex = 0) {
|
|
585
|
+
if (levelIndex === Infinity) {
|
|
586
|
+
// Treat Infinity as the last index on the level
|
|
587
|
+
levelIndex = cache.size - 1;
|
|
588
|
+
}
|
|
589
|
+
const flatIndexOnLevel = cache.getFlatIndex(levelIndex);
|
|
590
|
+
const subCache = cache.itemCaches[levelIndex];
|
|
591
|
+
if (subCache && subCache.effectiveSize && subIndexes.length) {
|
|
592
|
+
return this.__getGlobalFlatIndex(subIndexes, subCache, flatIndex + flatIndexOnLevel + 1);
|
|
524
593
|
}
|
|
594
|
+
return flatIndex + flatIndexOnLevel;
|
|
525
595
|
}
|
|
526
596
|
|
|
527
597
|
/** @private */
|
|
528
|
-
|
|
529
|
-
if (this.
|
|
530
|
-
const
|
|
531
|
-
delete this.
|
|
532
|
-
this.scrollToIndex(
|
|
598
|
+
__scrollToPendingIndexes() {
|
|
599
|
+
if (this.__pendingScrollToIndexes && this.$.items.children.length) {
|
|
600
|
+
const indexes = this.__pendingScrollToIndexes;
|
|
601
|
+
delete this.__pendingScrollToIndexes;
|
|
602
|
+
this.scrollToIndex(...indexes);
|
|
533
603
|
}
|
|
534
604
|
}
|
|
535
605
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Copyright (c) 2016 - 2023 Vaadin Ltd.
|
|
4
4
|
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
|
|
5
5
|
*/
|
|
6
|
-
import { iterateChildren,
|
|
6
|
+
import { iterateChildren, updateBooleanRowStates, updateStringRowStates } from './vaadin-grid-helpers.js';
|
|
7
7
|
|
|
8
8
|
const DropMode = {
|
|
9
9
|
BETWEEN: 'between',
|
|
@@ -156,12 +156,12 @@ export const DragAndDropMixin = (superClass) =>
|
|
|
156
156
|
// Set the default transfer data
|
|
157
157
|
e.dataTransfer.setData('text', this.__formatDefaultTransferData(rows));
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
updateBooleanRowStates(row, { dragstart: rows.length > 1 ? `${rows.length}` : '' });
|
|
160
160
|
this.style.setProperty('--_grid-drag-start-x', `${e.clientX - rowRect.left + 20}px`);
|
|
161
161
|
this.style.setProperty('--_grid-drag-start-y', `${e.clientY - rowRect.top + 10}px`);
|
|
162
162
|
|
|
163
163
|
requestAnimationFrame(() => {
|
|
164
|
-
|
|
164
|
+
updateBooleanRowStates(row, { dragstart: false });
|
|
165
165
|
this.style.setProperty('--_grid-drag-start-x', '');
|
|
166
166
|
this.style.setProperty('--_grid-drag-start-y', '');
|
|
167
167
|
});
|
|
@@ -255,7 +255,7 @@ export const DragAndDropMixin = (superClass) =>
|
|
|
255
255
|
} else if (row) {
|
|
256
256
|
this._dragOverItem = row._item;
|
|
257
257
|
if (row.getAttribute('dragover') !== this._dropLocation) {
|
|
258
|
-
|
|
258
|
+
updateStringRowStates(row, { dragover: this._dropLocation });
|
|
259
259
|
}
|
|
260
260
|
} else {
|
|
261
261
|
this._clearDragStyles();
|
|
@@ -310,7 +310,7 @@ export const DragAndDropMixin = (superClass) =>
|
|
|
310
310
|
_clearDragStyles() {
|
|
311
311
|
this.removeAttribute('dragover');
|
|
312
312
|
iterateChildren(this.$.items, (row) => {
|
|
313
|
-
|
|
313
|
+
updateStringRowStates(row, { dragover: null });
|
|
314
314
|
});
|
|
315
315
|
}
|
|
316
316
|
|
|
@@ -398,7 +398,7 @@ export const DragAndDropMixin = (superClass) =>
|
|
|
398
398
|
}
|
|
399
399
|
});
|
|
400
400
|
|
|
401
|
-
|
|
401
|
+
updateBooleanRowStates(row, {
|
|
402
402
|
'drag-disabled': !!dragDisabled,
|
|
403
403
|
'drop-disabled': !!dropDisabled,
|
|
404
404
|
});
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
|
|
7
7
|
import { PolymerElement } from '@polymer/polymer/polymer-element.js';
|
|
8
|
-
import { timeOut } from '@vaadin/component-base/src/async.js';
|
|
8
|
+
import { microTask, timeOut } from '@vaadin/component-base/src/async.js';
|
|
9
9
|
import { Debouncer } from '@vaadin/component-base/src/debounce.js';
|
|
10
10
|
import { updateCellState } from './vaadin-grid-helpers.js';
|
|
11
11
|
|
|
@@ -90,6 +90,13 @@ export const DynamicColumnsMixin = (superClass) =>
|
|
|
90
90
|
return columnTree;
|
|
91
91
|
}
|
|
92
92
|
|
|
93
|
+
/** @protected */
|
|
94
|
+
_debounceUpdateColumnTree() {
|
|
95
|
+
this.__updateColumnTreeDebouncer = Debouncer.debounce(this.__updateColumnTreeDebouncer, microTask, () =>
|
|
96
|
+
this._updateColumnTree(),
|
|
97
|
+
);
|
|
98
|
+
}
|
|
99
|
+
|
|
93
100
|
/** @protected */
|
|
94
101
|
_updateColumnTree() {
|
|
95
102
|
const columnTree = this._getColumnTree();
|
|
@@ -109,7 +116,7 @@ export const DynamicColumnsMixin = (superClass) =>
|
|
|
109
116
|
|
|
110
117
|
this.__removeSorters(this._sorters.filter(filterNotConnected));
|
|
111
118
|
this.__removeFilters(this._filters.filter(filterNotConnected));
|
|
112
|
-
this.
|
|
119
|
+
this._debounceUpdateColumnTree();
|
|
113
120
|
}
|
|
114
121
|
|
|
115
122
|
this._debouncerCheckImports = Debouncer.debounce(
|
|
@@ -86,16 +86,15 @@ export function updateCellsPart(cells, part, value) {
|
|
|
86
86
|
/**
|
|
87
87
|
* @param {!HTMLElement} row
|
|
88
88
|
* @param {Object} states
|
|
89
|
-
* @param {boolean} appendValue
|
|
90
89
|
*/
|
|
91
|
-
export function
|
|
90
|
+
export function updateBooleanRowStates(row, states) {
|
|
92
91
|
const cells = getBodyRowCells(row);
|
|
93
92
|
|
|
94
93
|
Object.entries(states).forEach(([state, value]) => {
|
|
95
94
|
// Row state attribute
|
|
96
95
|
updateState(row, state, value);
|
|
97
96
|
|
|
98
|
-
const rowPart =
|
|
97
|
+
const rowPart = `${state}-row`;
|
|
99
98
|
|
|
100
99
|
// Row part attribute
|
|
101
100
|
updatePart(row, value, rowPart);
|
|
@@ -105,6 +104,35 @@ export function updateRowStates(row, states, appendValue) {
|
|
|
105
104
|
});
|
|
106
105
|
}
|
|
107
106
|
|
|
107
|
+
/**
|
|
108
|
+
* @param {!HTMLElement} row
|
|
109
|
+
* @param {Object} states
|
|
110
|
+
*/
|
|
111
|
+
export function updateStringRowStates(row, states) {
|
|
112
|
+
const cells = getBodyRowCells(row);
|
|
113
|
+
|
|
114
|
+
Object.entries(states).forEach(([state, value]) => {
|
|
115
|
+
const prevValue = row.getAttribute(state);
|
|
116
|
+
|
|
117
|
+
// Row state attribute
|
|
118
|
+
updateState(row, state, value);
|
|
119
|
+
|
|
120
|
+
// remove previous part from row and cells if there was any
|
|
121
|
+
if (prevValue) {
|
|
122
|
+
const prevRowPart = `${state}-${prevValue}-row`;
|
|
123
|
+
updatePart(row, false, prevRowPart);
|
|
124
|
+
updateCellsPart(cells, `${prevRowPart}-cell`, false);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// set new part to rows and cells if there is a value
|
|
128
|
+
if (value) {
|
|
129
|
+
const rowPart = `${state}-${value}-row`;
|
|
130
|
+
updatePart(row, value, rowPart);
|
|
131
|
+
updateCellsPart(cells, `${rowPart}-cell`, value);
|
|
132
|
+
}
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
|
|
108
136
|
/**
|
|
109
137
|
* @param {!HTMLElement} cell
|
|
110
138
|
* @param {string} attribute
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
* Copyright (c) 2016 - 2023 Vaadin Ltd.
|
|
4
4
|
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
|
|
5
5
|
*/
|
|
6
|
+
import { isKeyboardActive } from '@vaadin/a11y-base/src/focus-utils.js';
|
|
6
7
|
import { addValueToAttribute, removeValueFromAttribute } from '@vaadin/component-base/src/dom-utils.js';
|
|
7
|
-
import { isKeyboardActive } from '@vaadin/component-base/src/focus-utils.js';
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* @polymerMixin
|
|
@@ -9,11 +9,8 @@ export declare function ScrollMixin<T extends Constructor<HTMLElement>>(base: T)
|
|
|
9
9
|
|
|
10
10
|
export declare class ScrollMixinClass {
|
|
11
11
|
/**
|
|
12
|
-
* Scroll to a
|
|
13
|
-
*
|
|
14
|
-
* or collapsing hierarchical items can affect the row index related to an item.
|
|
15
|
-
*
|
|
16
|
-
* @param index Row index to scroll to
|
|
12
|
+
* Scroll to a flat index in the grid. The method doesn't take into account
|
|
13
|
+
* the hierarchy of the items.
|
|
17
14
|
*/
|
|
18
|
-
|
|
15
|
+
protected _scrollToFlatIndex(index: number): void;
|
|
19
16
|
}
|
|
@@ -87,13 +87,13 @@ export const ScrollMixin = (superClass) =>
|
|
|
87
87
|
}
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* Scroll to a
|
|
91
|
-
*
|
|
92
|
-
* or collapsing hierarchical items can affect the row index related to an item.
|
|
90
|
+
* Scroll to a flat index in the grid. The method doesn't take into account
|
|
91
|
+
* the hierarchy of the items.
|
|
93
92
|
*
|
|
94
93
|
* @param {number} index Row index to scroll to
|
|
94
|
+
* @protected
|
|
95
95
|
*/
|
|
96
|
-
|
|
96
|
+
_scrollToFlatIndex(index) {
|
|
97
97
|
index = Math.min(this._effectiveSize - 1, Math.max(0, index));
|
|
98
98
|
this.__virtualizer.scrollToIndex(index);
|
|
99
99
|
this.__scrollIntoViewport(index);
|
|
@@ -15,7 +15,8 @@ registerStyles(
|
|
|
15
15
|
}
|
|
16
16
|
|
|
17
17
|
:host {
|
|
18
|
-
display:
|
|
18
|
+
display: flex;
|
|
19
|
+
flex-direction: column;
|
|
19
20
|
animation: 1ms vaadin-grid-appear;
|
|
20
21
|
height: 400px;
|
|
21
22
|
flex: 1 1 auto;
|
|
@@ -32,7 +33,9 @@ registerStyles(
|
|
|
32
33
|
}
|
|
33
34
|
|
|
34
35
|
#scroller {
|
|
35
|
-
display:
|
|
36
|
+
display: flex;
|
|
37
|
+
flex-direction: column;
|
|
38
|
+
min-height: 100%;
|
|
36
39
|
transform: translateY(0);
|
|
37
40
|
width: auto;
|
|
38
41
|
height: auto;
|
package/src/vaadin-grid.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Copyright (c) 2016 - 2023 Vaadin Ltd.
|
|
4
4
|
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
|
|
5
5
|
*/
|
|
6
|
-
import type { DisabledMixinClass } from '@vaadin/
|
|
6
|
+
import type { DisabledMixinClass } from '@vaadin/a11y-base/src/disabled-mixin.js';
|
|
7
7
|
import type { ElementMixinClass } from '@vaadin/component-base/src/element-mixin.js';
|
|
8
8
|
import type { ThemableMixinClass } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
|
|
9
9
|
import type { ThemePropertyMixinClass } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
|
package/src/vaadin-grid.js
CHANGED
|
@@ -7,12 +7,12 @@ import './vaadin-grid-column.js';
|
|
|
7
7
|
import './vaadin-grid-styles.js';
|
|
8
8
|
import { beforeNextRender } from '@polymer/polymer/lib/utils/render-status.js';
|
|
9
9
|
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
|
|
10
|
+
import { TabindexMixin } from '@vaadin/a11y-base/src/tabindex-mixin.js';
|
|
10
11
|
import { microTask } from '@vaadin/component-base/src/async.js';
|
|
11
12
|
import { isAndroid, isChrome, isFirefox, isIOS, isSafari, isTouch } from '@vaadin/component-base/src/browser-utils.js';
|
|
12
13
|
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
|
|
13
14
|
import { Debouncer } from '@vaadin/component-base/src/debounce.js';
|
|
14
15
|
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
|
|
15
|
-
import { TabindexMixin } from '@vaadin/component-base/src/tabindex-mixin.js';
|
|
16
16
|
import { processTemplates } from '@vaadin/component-base/src/templates.js';
|
|
17
17
|
import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
|
|
18
18
|
import { Virtualizer } from '@vaadin/component-base/src/virtualizer.js';
|
|
@@ -27,7 +27,7 @@ import { DragAndDropMixin } from './vaadin-grid-drag-and-drop-mixin.js';
|
|
|
27
27
|
import { DynamicColumnsMixin } from './vaadin-grid-dynamic-columns-mixin.js';
|
|
28
28
|
import { EventContextMixin } from './vaadin-grid-event-context-mixin.js';
|
|
29
29
|
import { FilterMixin } from './vaadin-grid-filter-mixin.js';
|
|
30
|
-
import { getBodyRowCells, iterateChildren,
|
|
30
|
+
import { getBodyRowCells, iterateChildren, updateBooleanRowStates, updateCellsPart } from './vaadin-grid-helpers.js';
|
|
31
31
|
import { KeyboardNavigationMixin } from './vaadin-grid-keyboard-navigation-mixin.js';
|
|
32
32
|
import { RowDetailsMixin } from './vaadin-grid-row-details-mixin.js';
|
|
33
33
|
import { ScrollMixin } from './vaadin-grid-scroll-mixin.js';
|
|
@@ -577,39 +577,10 @@ class Grid extends ElementMixin(
|
|
|
577
577
|
|
|
578
578
|
/** @private */
|
|
579
579
|
__getIntrinsicWidth(col) {
|
|
580
|
-
if (this.__intrinsicWidthCache.has(col)) {
|
|
581
|
-
|
|
580
|
+
if (!this.__intrinsicWidthCache.has(col)) {
|
|
581
|
+
this.__calculateAndCacheIntrinsicWidths([col]);
|
|
582
582
|
}
|
|
583
|
-
|
|
584
|
-
const width = this.__calculateIntrinsicWidth(col);
|
|
585
|
-
this.__intrinsicWidthCache.set(col, width);
|
|
586
|
-
|
|
587
|
-
return width;
|
|
588
|
-
}
|
|
589
|
-
|
|
590
|
-
/** @private */
|
|
591
|
-
__calculateIntrinsicWidth(col) {
|
|
592
|
-
const initialWidth = col.width;
|
|
593
|
-
const initialFlexGrow = col.flexGrow;
|
|
594
|
-
|
|
595
|
-
col.width = 'auto';
|
|
596
|
-
col.flexGrow = 0;
|
|
597
|
-
|
|
598
|
-
// Note: _allCells only contains cells which are currently rendered in DOM
|
|
599
|
-
const width = col._allCells
|
|
600
|
-
.filter((cell) => {
|
|
601
|
-
// Exclude body cells that are out of the visible viewport
|
|
602
|
-
return !this.$.items.contains(cell) || this._isInViewport(cell.parentElement);
|
|
603
|
-
})
|
|
604
|
-
.reduce((width, cell) => {
|
|
605
|
-
// Add 1px buffer to the offset width to avoid too narrow columns (sub-pixel rendering)
|
|
606
|
-
return Math.max(width, cell.offsetWidth + 1);
|
|
607
|
-
}, 0);
|
|
608
|
-
|
|
609
|
-
col.flexGrow = initialFlexGrow;
|
|
610
|
-
col.width = initialWidth;
|
|
611
|
-
|
|
612
|
-
return width;
|
|
583
|
+
return this.__intrinsicWidthCache.get(col);
|
|
613
584
|
}
|
|
614
585
|
|
|
615
586
|
/** @private */
|
|
@@ -667,12 +638,74 @@ class Grid extends ElementMixin(
|
|
|
667
638
|
}
|
|
668
639
|
|
|
669
640
|
this.__intrinsicWidthCache = new Map();
|
|
641
|
+
// Cache the viewport rows to avoid unnecessary reflows while measuring the column widths
|
|
642
|
+
const fvi = this._firstVisibleIndex;
|
|
643
|
+
const lvi = this._lastVisibleIndex;
|
|
644
|
+
this.__viewportRowsCache = this._getVisibleRows().filter((row) => row.index >= fvi && row.index <= lvi);
|
|
645
|
+
|
|
646
|
+
// Pre-cache the intrinsic width of each column
|
|
647
|
+
this.__calculateAndCacheIntrinsicWidths(cols);
|
|
670
648
|
|
|
671
649
|
cols.forEach((col) => {
|
|
672
650
|
col.width = `${this.__getDistributedWidth(col)}px`;
|
|
673
651
|
});
|
|
674
652
|
}
|
|
675
653
|
|
|
654
|
+
/**
|
|
655
|
+
* Toggles the cell content for the given column to use or not use auto width.
|
|
656
|
+
*
|
|
657
|
+
* While content for all the column cells uses auto width (instead of the default 100%),
|
|
658
|
+
* their offsetWidth can be used to calculate the collective intrinsic width of the column.
|
|
659
|
+
*
|
|
660
|
+
* @private
|
|
661
|
+
*/
|
|
662
|
+
__setVisibleCellContentAutoWidth(col, autoWidth) {
|
|
663
|
+
col._allCells
|
|
664
|
+
.filter((cell) => {
|
|
665
|
+
if (this.$.items.contains(cell)) {
|
|
666
|
+
return this.__viewportRowsCache.includes(cell.parentElement);
|
|
667
|
+
}
|
|
668
|
+
return true;
|
|
669
|
+
})
|
|
670
|
+
.forEach((cell) => {
|
|
671
|
+
cell.__measuringAutoWidth = autoWidth;
|
|
672
|
+
cell._content.style.width = autoWidth ? 'auto' : '';
|
|
673
|
+
cell._content.style.position = autoWidth ? 'absolute' : '';
|
|
674
|
+
});
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
/**
|
|
678
|
+
* Returns the maximum intrinsic width of the cell content in the given column.
|
|
679
|
+
* Only cells which are marked for measuring auto width are considered.
|
|
680
|
+
*
|
|
681
|
+
* @private
|
|
682
|
+
*/
|
|
683
|
+
__getAutoWidthCellsMaxWidth(col) {
|
|
684
|
+
// Note: _allCells only contains cells which are currently rendered in DOM
|
|
685
|
+
return col._allCells.reduce((width, cell) => {
|
|
686
|
+
// Add 1px buffer to the offset width to avoid too narrow columns (sub-pixel rendering)
|
|
687
|
+
return cell.__measuringAutoWidth ? Math.max(width, cell._content.offsetWidth + 1) : width;
|
|
688
|
+
}, 0);
|
|
689
|
+
}
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Calculates and caches the intrinsic width of each given column.
|
|
693
|
+
*
|
|
694
|
+
* @private
|
|
695
|
+
*/
|
|
696
|
+
__calculateAndCacheIntrinsicWidths(cols) {
|
|
697
|
+
// Make all the columns use auto width at once before measuring to
|
|
698
|
+
// avoid reflows in between the measurements
|
|
699
|
+
cols.forEach((col) => this.__setVisibleCellContentAutoWidth(col, true));
|
|
700
|
+
// Measure and cache
|
|
701
|
+
cols.forEach((col) => {
|
|
702
|
+
const width = this.__getAutoWidthCellsMaxWidth(col);
|
|
703
|
+
this.__intrinsicWidthCache.set(col, width);
|
|
704
|
+
});
|
|
705
|
+
// Reset the columns to use 100% width
|
|
706
|
+
cols.forEach((col) => this.__setVisibleCellContentAutoWidth(col, false));
|
|
707
|
+
}
|
|
708
|
+
|
|
676
709
|
/**
|
|
677
710
|
* Updates the `width` of all columns which have `autoWidth` set to `true`.
|
|
678
711
|
*/
|
|
@@ -975,7 +1008,7 @@ class Grid extends ElementMixin(
|
|
|
975
1008
|
|
|
976
1009
|
/** @private */
|
|
977
1010
|
_updateRowOrderParts(row, index = row.index) {
|
|
978
|
-
|
|
1011
|
+
updateBooleanRowStates(row, {
|
|
979
1012
|
first: index === 0,
|
|
980
1013
|
last: index === this._effectiveSize - 1,
|
|
981
1014
|
odd: index % 2 !== 0,
|
|
@@ -985,7 +1018,7 @@ class Grid extends ElementMixin(
|
|
|
985
1018
|
|
|
986
1019
|
/** @private */
|
|
987
1020
|
_updateRowStateParts(row, { expanded, selected, detailsOpened }) {
|
|
988
|
-
|
|
1021
|
+
updateBooleanRowStates(row, {
|
|
989
1022
|
expanded,
|
|
990
1023
|
selected,
|
|
991
1024
|
'details-opened': detailsOpened,
|
|
@@ -1114,7 +1147,7 @@ class Grid extends ElementMixin(
|
|
|
1114
1147
|
this.__itemsReceived();
|
|
1115
1148
|
|
|
1116
1149
|
requestAnimationFrame(() => {
|
|
1117
|
-
this.
|
|
1150
|
+
this.__scrollToPendingIndexes();
|
|
1118
1151
|
});
|
|
1119
1152
|
}
|
|
1120
1153
|
}
|
package/web-types.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid",
|
|
4
|
-
"version": "24.
|
|
4
|
+
"version": "24.1.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "vaadin-grid-column",
|
|
11
|
-
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.
|
|
11
|
+
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
14
|
"name": "resizable",
|
|
@@ -765,7 +765,7 @@
|
|
|
765
765
|
},
|
|
766
766
|
{
|
|
767
767
|
"name": "vaadin-grid-selection-column",
|
|
768
|
-
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.
|
|
768
|
+
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-items),\nthe column header gets an additional checkbox that can be used for toggling\nselection for all the items at once.\n\n__The default content can also be overridden__",
|
|
769
769
|
"attributes": [
|
|
770
770
|
{
|
|
771
771
|
"name": "resizable",
|
|
@@ -1758,7 +1758,7 @@
|
|
|
1758
1758
|
},
|
|
1759
1759
|
{
|
|
1760
1760
|
"name": "vaadin-grid",
|
|
1761
|
-
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------------|----------------\n`row` | Row in the internal table\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`last-row` | The last body row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in a row that user started to drag (set for one frame)\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when starting to drag a row. The value is a number when dragging multiple rows | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
1761
|
+
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------------|----------------\n`row` | Row in the internal table\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`last-row` | The last body row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in a row that user started to drag (set for one frame)\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when starting to drag a row. The value is a number when dragging multiple rows | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
1762
1762
|
"attributes": [
|
|
1763
1763
|
{
|
|
1764
1764
|
"name": "size",
|
package/web-types.lit.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid",
|
|
4
|
-
"version": "24.
|
|
4
|
+
"version": "24.1.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"elements": [
|
|
17
17
|
{
|
|
18
18
|
"name": "vaadin-grid-column",
|
|
19
|
-
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.
|
|
19
|
+
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
22
|
{
|
|
@@ -303,7 +303,7 @@
|
|
|
303
303
|
},
|
|
304
304
|
{
|
|
305
305
|
"name": "vaadin-grid-selection-column",
|
|
306
|
-
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.
|
|
306
|
+
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-items),\nthe column header gets an additional checkbox that can be used for toggling\nselection for all the items at once.\n\n__The default content can also be overridden__",
|
|
307
307
|
"extension": true,
|
|
308
308
|
"attributes": [
|
|
309
309
|
{
|
|
@@ -695,7 +695,7 @@
|
|
|
695
695
|
},
|
|
696
696
|
{
|
|
697
697
|
"name": "vaadin-grid",
|
|
698
|
-
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------------|----------------\n`row` | Row in the internal table\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`last-row` | The last body row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in a row that user started to drag (set for one frame)\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when starting to drag a row. The value is a number when dragging multiple rows | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
698
|
+
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.1.0-alpha2/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------------|----------------\n`row` | Row in the internal table\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`last-row` | The last body row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in a row that user started to drag (set for one frame)\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when starting to drag a row. The value is a number when dragging multiple rows | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
699
699
|
"extension": true,
|
|
700
700
|
"attributes": [
|
|
701
701
|
{
|