@vaadin/grid-pro 24.0.0-alpha7 → 24.0.0-alpha9
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/package.json +14 -14
- package/src/lit/column-renderer-directives.d.ts +1 -1
- package/src/lit/column-renderer-directives.js +1 -1
- package/src/vaadin-grid-pro-edit-checkbox.js +1 -1
- package/src/vaadin-grid-pro-edit-column.d.ts +1 -1
- package/src/vaadin-grid-pro-edit-column.js +1 -1
- package/src/vaadin-grid-pro-edit-select.js +2 -2
- package/src/vaadin-grid-pro-edit-text-field.js +1 -1
- package/src/vaadin-grid-pro-inline-editing-mixin.d.ts +1 -1
- package/src/vaadin-grid-pro-inline-editing-mixin.js +2 -2
- package/src/vaadin-grid-pro.d.ts +1 -1
- package/src/vaadin-grid-pro.js +1 -1
- package/web-types.json +384 -2
- package/web-types.lit.json +247 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/grid-pro",
|
|
3
|
-
"version": "24.0.0-
|
|
3
|
+
"version": "24.0.0-alpha9",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -39,21 +39,21 @@
|
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
41
41
|
"@polymer/polymer": "^3.0.0",
|
|
42
|
-
"@vaadin/checkbox": "24.0.0-
|
|
43
|
-
"@vaadin/component-base": "24.0.0-
|
|
44
|
-
"@vaadin/grid": "24.0.0-
|
|
45
|
-
"@vaadin/item": "24.0.0-
|
|
46
|
-
"@vaadin/list-box": "24.0.0-
|
|
47
|
-
"@vaadin/lit-renderer": "24.0.0-
|
|
48
|
-
"@vaadin/select": "24.0.0-
|
|
49
|
-
"@vaadin/text-field": "24.0.0-
|
|
50
|
-
"@vaadin/vaadin-lumo-styles": "24.0.0-
|
|
51
|
-
"@vaadin/vaadin-material-styles": "24.0.0-
|
|
52
|
-
"@vaadin/vaadin-themable-mixin": "24.0.0-
|
|
42
|
+
"@vaadin/checkbox": "24.0.0-alpha9",
|
|
43
|
+
"@vaadin/component-base": "24.0.0-alpha9",
|
|
44
|
+
"@vaadin/grid": "24.0.0-alpha9",
|
|
45
|
+
"@vaadin/item": "24.0.0-alpha9",
|
|
46
|
+
"@vaadin/list-box": "24.0.0-alpha9",
|
|
47
|
+
"@vaadin/lit-renderer": "24.0.0-alpha9",
|
|
48
|
+
"@vaadin/select": "24.0.0-alpha9",
|
|
49
|
+
"@vaadin/text-field": "24.0.0-alpha9",
|
|
50
|
+
"@vaadin/vaadin-lumo-styles": "24.0.0-alpha9",
|
|
51
|
+
"@vaadin/vaadin-material-styles": "24.0.0-alpha9",
|
|
52
|
+
"@vaadin/vaadin-themable-mixin": "24.0.0-alpha9"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@esm-bundle/chai": "^4.3.4",
|
|
56
|
-
"@vaadin/polymer-legacy-adapter": "24.0.0-
|
|
56
|
+
"@vaadin/polymer-legacy-adapter": "24.0.0-alpha9",
|
|
57
57
|
"@vaadin/testing-helpers": "^0.3.2",
|
|
58
58
|
"lit": "^2.0.0",
|
|
59
59
|
"sinon": "^13.0.2"
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"web-types.json",
|
|
64
64
|
"web-types.lit.json"
|
|
65
65
|
],
|
|
66
|
-
"gitHead": "
|
|
66
|
+
"gitHead": "cc3f747164041566b300bde4b105d2475649e93f"
|
|
67
67
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @license
|
|
3
|
-
* Copyright (c) 2000 -
|
|
3
|
+
* Copyright (c) 2000 - 2023 Vaadin Ltd.
|
|
4
4
|
*
|
|
5
5
|
* This program is available under Vaadin Commercial License and Service Terms.
|
|
6
6
|
*
|
|
@@ -53,7 +53,7 @@ class GridProEditSelect extends Select {
|
|
|
53
53
|
_onKeyDown(e) {
|
|
54
54
|
super._onKeyDown(e);
|
|
55
55
|
|
|
56
|
-
if (this.options.length === 0 && /^(ArrowDown|Down|ArrowUp|Up|Enter|SpaceBar| )
|
|
56
|
+
if (this.options.length === 0 && /^(ArrowDown|Down|ArrowUp|Up|Enter|SpaceBar| )$/u.test(e.key)) {
|
|
57
57
|
console.warn('Missing "editorOptions" for <vaadin-grid-pro-edit-column> select editor!');
|
|
58
58
|
}
|
|
59
59
|
// Event handled in select, stop here
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @license
|
|
3
|
-
* Copyright (c) 2000 -
|
|
3
|
+
* Copyright (c) 2000 - 2023 Vaadin Ltd.
|
|
4
4
|
*
|
|
5
5
|
* This program is available under Vaadin Commercial License and Service Terms.
|
|
6
6
|
*
|
|
@@ -312,7 +312,7 @@ export const InlineEditingMixin = (superClass) =>
|
|
|
312
312
|
if (edited) {
|
|
313
313
|
// Detect focus moving to e.g. vaadin-select-overlay
|
|
314
314
|
const overlay = Array.from(e.composedPath()).filter(
|
|
315
|
-
(node) => node.nodeType === Node.ELEMENT_NODE && /^vaadin-(?!dialog).*-overlay$/
|
|
315
|
+
(node) => node.nodeType === Node.ELEMENT_NODE && /^vaadin-(?!dialog).*-overlay$/iu.test(node.localName),
|
|
316
316
|
)[0];
|
|
317
317
|
|
|
318
318
|
if (overlay) {
|
package/src/vaadin-grid-pro.d.ts
CHANGED
package/src/vaadin-grid-pro.js
CHANGED
package/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid-pro",
|
|
4
|
-
"version": "24.0.0-
|
|
4
|
+
"version": "24.0.0-alpha9",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -328,8 +328,117 @@
|
|
|
328
328
|
},
|
|
329
329
|
{
|
|
330
330
|
"name": "vaadin-grid-pro",
|
|
331
|
-
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
331
|
+
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-grid) documentation for details.\n\n```\n<vaadin-grid-pro></vaadin-grid-pro>\n```\n\n### Internal components\n\nIn addition to `<vaadin-grid-pro>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-grid-pro-edit-checkbox>` - has the same API as [`<vaadin-checkbox>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-checkbox).\n- `<vaadin-grid-pro-edit-text-field>` - has the same API as [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-select).",
|
|
332
332
|
"attributes": [
|
|
333
|
+
{
|
|
334
|
+
"name": "size",
|
|
335
|
+
"description": "The number of root-level items in the grid.",
|
|
336
|
+
"value": {
|
|
337
|
+
"type": [
|
|
338
|
+
"number"
|
|
339
|
+
]
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "page-size",
|
|
344
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
345
|
+
"value": {
|
|
346
|
+
"type": [
|
|
347
|
+
"number"
|
|
348
|
+
]
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "item-has-children-path",
|
|
353
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
354
|
+
"value": {
|
|
355
|
+
"type": [
|
|
356
|
+
"string",
|
|
357
|
+
"null",
|
|
358
|
+
"undefined"
|
|
359
|
+
]
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "item-id-path",
|
|
364
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
365
|
+
"value": {
|
|
366
|
+
"type": [
|
|
367
|
+
"string",
|
|
368
|
+
"null",
|
|
369
|
+
"undefined"
|
|
370
|
+
]
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"name": "multi-sort",
|
|
375
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
376
|
+
"value": {
|
|
377
|
+
"type": [
|
|
378
|
+
"boolean"
|
|
379
|
+
]
|
|
380
|
+
}
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "multi-sort-priority",
|
|
384
|
+
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
385
|
+
"value": {
|
|
386
|
+
"type": [
|
|
387
|
+
"string",
|
|
388
|
+
"null",
|
|
389
|
+
"undefined"
|
|
390
|
+
]
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "multi-sort-on-shift-click",
|
|
395
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
396
|
+
"value": {
|
|
397
|
+
"type": [
|
|
398
|
+
"boolean"
|
|
399
|
+
]
|
|
400
|
+
}
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
"name": "column-reordering-allowed",
|
|
404
|
+
"description": "Set to true to allow column reordering.",
|
|
405
|
+
"value": {
|
|
406
|
+
"type": [
|
|
407
|
+
"boolean"
|
|
408
|
+
]
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "drop-mode",
|
|
413
|
+
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
414
|
+
"value": {
|
|
415
|
+
"type": [
|
|
416
|
+
"GridDropMode",
|
|
417
|
+
"null",
|
|
418
|
+
"undefined"
|
|
419
|
+
]
|
|
420
|
+
}
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "rows-draggable",
|
|
424
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
425
|
+
"value": {
|
|
426
|
+
"type": [
|
|
427
|
+
"boolean",
|
|
428
|
+
"null",
|
|
429
|
+
"undefined"
|
|
430
|
+
]
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"name": "all-rows-visible",
|
|
435
|
+
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
436
|
+
"value": {
|
|
437
|
+
"type": [
|
|
438
|
+
"boolean"
|
|
439
|
+
]
|
|
440
|
+
}
|
|
441
|
+
},
|
|
333
442
|
{
|
|
334
443
|
"name": "enter-next-row",
|
|
335
444
|
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
@@ -377,6 +486,227 @@
|
|
|
377
486
|
],
|
|
378
487
|
"js": {
|
|
379
488
|
"properties": [
|
|
489
|
+
{
|
|
490
|
+
"name": "activeItem",
|
|
491
|
+
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
492
|
+
"value": {
|
|
493
|
+
"type": [
|
|
494
|
+
"GridItem"
|
|
495
|
+
]
|
|
496
|
+
}
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"name": "items",
|
|
500
|
+
"description": "An array containing the items which will be passed to renderer functions.",
|
|
501
|
+
"value": {
|
|
502
|
+
"type": [
|
|
503
|
+
"Array.<GridItem>",
|
|
504
|
+
"undefined"
|
|
505
|
+
]
|
|
506
|
+
}
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"name": "size",
|
|
510
|
+
"description": "The number of root-level items in the grid.",
|
|
511
|
+
"value": {
|
|
512
|
+
"type": [
|
|
513
|
+
"number"
|
|
514
|
+
]
|
|
515
|
+
}
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
"name": "pageSize",
|
|
519
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
520
|
+
"value": {
|
|
521
|
+
"type": [
|
|
522
|
+
"number"
|
|
523
|
+
]
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"name": "dataProvider",
|
|
528
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
|
|
529
|
+
"value": {
|
|
530
|
+
"type": [
|
|
531
|
+
"GridDataProvider",
|
|
532
|
+
"null",
|
|
533
|
+
"undefined"
|
|
534
|
+
]
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"name": "itemHasChildrenPath",
|
|
539
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
540
|
+
"value": {
|
|
541
|
+
"type": [
|
|
542
|
+
"string",
|
|
543
|
+
"null",
|
|
544
|
+
"undefined"
|
|
545
|
+
]
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "itemIdPath",
|
|
550
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
551
|
+
"value": {
|
|
552
|
+
"type": [
|
|
553
|
+
"string",
|
|
554
|
+
"null",
|
|
555
|
+
"undefined"
|
|
556
|
+
]
|
|
557
|
+
}
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "expandedItems",
|
|
561
|
+
"description": "An array that contains the expanded items.",
|
|
562
|
+
"value": {
|
|
563
|
+
"type": [
|
|
564
|
+
"Array.<GridItem>"
|
|
565
|
+
]
|
|
566
|
+
}
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
"name": "detailsOpenedItems",
|
|
570
|
+
"description": "An array containing references to items with open row details.",
|
|
571
|
+
"value": {
|
|
572
|
+
"type": [
|
|
573
|
+
"Array.<GridItem>"
|
|
574
|
+
]
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "rowDetailsRenderer",
|
|
579
|
+
"description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
|
|
580
|
+
"value": {
|
|
581
|
+
"type": [
|
|
582
|
+
"GridRowDetailsRenderer",
|
|
583
|
+
"null",
|
|
584
|
+
"undefined"
|
|
585
|
+
]
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "selectedItems",
|
|
590
|
+
"description": "An array that contains the selected items.",
|
|
591
|
+
"value": {
|
|
592
|
+
"type": [
|
|
593
|
+
"Array.<GridItem>"
|
|
594
|
+
]
|
|
595
|
+
}
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"name": "multiSort",
|
|
599
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
600
|
+
"value": {
|
|
601
|
+
"type": [
|
|
602
|
+
"boolean"
|
|
603
|
+
]
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "multiSortPriority",
|
|
608
|
+
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
609
|
+
"value": {
|
|
610
|
+
"type": [
|
|
611
|
+
"string",
|
|
612
|
+
"null",
|
|
613
|
+
"undefined"
|
|
614
|
+
]
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "multiSortOnShiftClick",
|
|
619
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
620
|
+
"value": {
|
|
621
|
+
"type": [
|
|
622
|
+
"boolean"
|
|
623
|
+
]
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "columnReorderingAllowed",
|
|
628
|
+
"description": "Set to true to allow column reordering.",
|
|
629
|
+
"value": {
|
|
630
|
+
"type": [
|
|
631
|
+
"boolean"
|
|
632
|
+
]
|
|
633
|
+
}
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "cellClassNameGenerator",
|
|
637
|
+
"description": "A function that allows generating CSS class names for grid cells\nbased on their row and column. The return value should be the generated\nclass name as a string, or multiple class names separated by whitespace\ncharacters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
638
|
+
"value": {
|
|
639
|
+
"type": [
|
|
640
|
+
"GridCellClassNameGenerator",
|
|
641
|
+
"null",
|
|
642
|
+
"undefined"
|
|
643
|
+
]
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"name": "cellPartNameGenerator",
|
|
648
|
+
"description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
649
|
+
"value": {
|
|
650
|
+
"type": [
|
|
651
|
+
"GridCellPartNameGenerator",
|
|
652
|
+
"null",
|
|
653
|
+
"undefined"
|
|
654
|
+
]
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"name": "dropMode",
|
|
659
|
+
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
660
|
+
"value": {
|
|
661
|
+
"type": [
|
|
662
|
+
"GridDropMode",
|
|
663
|
+
"null",
|
|
664
|
+
"undefined"
|
|
665
|
+
]
|
|
666
|
+
}
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "rowsDraggable",
|
|
670
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
671
|
+
"value": {
|
|
672
|
+
"type": [
|
|
673
|
+
"boolean",
|
|
674
|
+
"null",
|
|
675
|
+
"undefined"
|
|
676
|
+
]
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"name": "dragFilter",
|
|
681
|
+
"description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
682
|
+
"value": {
|
|
683
|
+
"type": [
|
|
684
|
+
"GridDragAndDropFilter",
|
|
685
|
+
"null",
|
|
686
|
+
"undefined"
|
|
687
|
+
]
|
|
688
|
+
}
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "dropFilter",
|
|
692
|
+
"description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
693
|
+
"value": {
|
|
694
|
+
"type": [
|
|
695
|
+
"GridDragAndDropFilter",
|
|
696
|
+
"null",
|
|
697
|
+
"undefined"
|
|
698
|
+
]
|
|
699
|
+
}
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"name": "allRowsVisible",
|
|
703
|
+
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
704
|
+
"value": {
|
|
705
|
+
"type": [
|
|
706
|
+
"boolean"
|
|
707
|
+
]
|
|
708
|
+
}
|
|
709
|
+
},
|
|
380
710
|
{
|
|
381
711
|
"name": "enterNextRow",
|
|
382
712
|
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
@@ -412,6 +742,50 @@
|
|
|
412
742
|
}
|
|
413
743
|
],
|
|
414
744
|
"events": [
|
|
745
|
+
{
|
|
746
|
+
"name": "active-item-changed",
|
|
747
|
+
"description": "Fired when the `activeItem` property changes."
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
"name": "cell-activate",
|
|
751
|
+
"description": "Fired when the cell is activated with click or keyboard."
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"name": "column-resize",
|
|
755
|
+
"description": "Fired when a column in the grid is resized by the user."
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
"name": "expanded-items-changed",
|
|
759
|
+
"description": "Fired when the `expandedItems` property changes."
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "loading-changed",
|
|
763
|
+
"description": "Fired when the `loading` property changes."
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "selected-items-changed",
|
|
767
|
+
"description": "Fired when the `selectedItems` property changes."
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
"name": "cell-focus",
|
|
771
|
+
"description": "Fired when a cell is focused with click or keyboard navigation.\n\nUse context property of @see {@link GridCellFocusEvent} to get detail information about the event."
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "column-reorder",
|
|
775
|
+
"description": "Fired when the columns in the grid are reordered."
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
"name": "grid-dragend",
|
|
779
|
+
"description": "Fired when the dragging of the rows ends."
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
"name": "grid-dragstart",
|
|
783
|
+
"description": "Fired when starting to drag grid rows."
|
|
784
|
+
},
|
|
785
|
+
{
|
|
786
|
+
"name": "grid-drop",
|
|
787
|
+
"description": "Fired when a drop occurs on top of the grid."
|
|
788
|
+
},
|
|
415
789
|
{
|
|
416
790
|
"name": "cell-edit-started",
|
|
417
791
|
"description": "Fired when the user starts editing a grid cell."
|
|
@@ -420,6 +794,14 @@
|
|
|
420
794
|
"name": "item-property-changed",
|
|
421
795
|
"description": "Fired before exiting the cell edit mode, if the value has been changed.\nIf the default is prevented, value change would not be applied."
|
|
422
796
|
},
|
|
797
|
+
{
|
|
798
|
+
"name": "size-changed",
|
|
799
|
+
"description": "Fired when the `size` property changes."
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"name": "data-provider-changed",
|
|
803
|
+
"description": "Fired when the `dataProvider` property changes."
|
|
804
|
+
},
|
|
423
805
|
{
|
|
424
806
|
"name": "enter-next-row-changed",
|
|
425
807
|
"description": "Fired when the `enterNextRow` property changes."
|
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-pro",
|
|
4
|
-
"version": "24.0.0-
|
|
4
|
+
"version": "24.0.0-alpha9",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -149,9 +149,44 @@
|
|
|
149
149
|
},
|
|
150
150
|
{
|
|
151
151
|
"name": "vaadin-grid-pro",
|
|
152
|
-
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
152
|
+
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-grid) documentation for details.\n\n```\n<vaadin-grid-pro></vaadin-grid-pro>\n```\n\n### Internal components\n\nIn addition to `<vaadin-grid-pro>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-grid-pro-edit-checkbox>` - has the same API as [`<vaadin-checkbox>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-checkbox).\n- `<vaadin-grid-pro-edit-text-field>` - has the same API as [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-select).",
|
|
153
153
|
"extension": true,
|
|
154
154
|
"attributes": [
|
|
155
|
+
{
|
|
156
|
+
"name": "?multiSort",
|
|
157
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
158
|
+
"value": {
|
|
159
|
+
"kind": "expression"
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "?multiSortOnShiftClick",
|
|
164
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
165
|
+
"value": {
|
|
166
|
+
"kind": "expression"
|
|
167
|
+
}
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "?columnReorderingAllowed",
|
|
171
|
+
"description": "Set to true to allow column reordering.",
|
|
172
|
+
"value": {
|
|
173
|
+
"kind": "expression"
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "?rowsDraggable",
|
|
178
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
179
|
+
"value": {
|
|
180
|
+
"kind": "expression"
|
|
181
|
+
}
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "?allRowsVisible",
|
|
185
|
+
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
186
|
+
"value": {
|
|
187
|
+
"kind": "expression"
|
|
188
|
+
}
|
|
189
|
+
},
|
|
155
190
|
{
|
|
156
191
|
"name": "?enterNextRow",
|
|
157
192
|
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
@@ -173,6 +208,202 @@
|
|
|
173
208
|
"kind": "expression"
|
|
174
209
|
}
|
|
175
210
|
},
|
|
211
|
+
{
|
|
212
|
+
"name": ".activeItem",
|
|
213
|
+
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
214
|
+
"value": {
|
|
215
|
+
"kind": "expression"
|
|
216
|
+
}
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": ".items",
|
|
220
|
+
"description": "An array containing the items which will be passed to renderer functions.",
|
|
221
|
+
"value": {
|
|
222
|
+
"kind": "expression"
|
|
223
|
+
}
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": ".size",
|
|
227
|
+
"description": "The number of root-level items in the grid.",
|
|
228
|
+
"value": {
|
|
229
|
+
"kind": "expression"
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": ".pageSize",
|
|
234
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
235
|
+
"value": {
|
|
236
|
+
"kind": "expression"
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": ".dataProvider",
|
|
241
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
|
|
242
|
+
"value": {
|
|
243
|
+
"kind": "expression"
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": ".itemHasChildrenPath",
|
|
248
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
249
|
+
"value": {
|
|
250
|
+
"kind": "expression"
|
|
251
|
+
}
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"name": ".itemIdPath",
|
|
255
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
256
|
+
"value": {
|
|
257
|
+
"kind": "expression"
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": ".expandedItems",
|
|
262
|
+
"description": "An array that contains the expanded items.",
|
|
263
|
+
"value": {
|
|
264
|
+
"kind": "expression"
|
|
265
|
+
}
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": ".detailsOpenedItems",
|
|
269
|
+
"description": "An array containing references to items with open row details.",
|
|
270
|
+
"value": {
|
|
271
|
+
"kind": "expression"
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": ".rowDetailsRenderer",
|
|
276
|
+
"description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
|
|
277
|
+
"value": {
|
|
278
|
+
"kind": "expression"
|
|
279
|
+
}
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
"name": ".selectedItems",
|
|
283
|
+
"description": "An array that contains the selected items.",
|
|
284
|
+
"value": {
|
|
285
|
+
"kind": "expression"
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": ".multiSortPriority",
|
|
290
|
+
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
291
|
+
"value": {
|
|
292
|
+
"kind": "expression"
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": ".cellClassNameGenerator",
|
|
297
|
+
"description": "A function that allows generating CSS class names for grid cells\nbased on their row and column. The return value should be the generated\nclass name as a string, or multiple class names separated by whitespace\ncharacters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
298
|
+
"value": {
|
|
299
|
+
"kind": "expression"
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": ".cellPartNameGenerator",
|
|
304
|
+
"description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
305
|
+
"value": {
|
|
306
|
+
"kind": "expression"
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"name": ".dropMode",
|
|
311
|
+
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
312
|
+
"value": {
|
|
313
|
+
"kind": "expression"
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"name": ".dragFilter",
|
|
318
|
+
"description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
319
|
+
"value": {
|
|
320
|
+
"kind": "expression"
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": ".dropFilter",
|
|
325
|
+
"description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
326
|
+
"value": {
|
|
327
|
+
"kind": "expression"
|
|
328
|
+
}
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "@active-item-changed",
|
|
332
|
+
"description": "Fired when the `activeItem` property changes.",
|
|
333
|
+
"value": {
|
|
334
|
+
"kind": "expression"
|
|
335
|
+
}
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "@cell-activate",
|
|
339
|
+
"description": "Fired when the cell is activated with click or keyboard.",
|
|
340
|
+
"value": {
|
|
341
|
+
"kind": "expression"
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "@column-resize",
|
|
346
|
+
"description": "Fired when a column in the grid is resized by the user.",
|
|
347
|
+
"value": {
|
|
348
|
+
"kind": "expression"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "@expanded-items-changed",
|
|
353
|
+
"description": "Fired when the `expandedItems` property changes.",
|
|
354
|
+
"value": {
|
|
355
|
+
"kind": "expression"
|
|
356
|
+
}
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "@loading-changed",
|
|
360
|
+
"description": "Fired when the `loading` property changes.",
|
|
361
|
+
"value": {
|
|
362
|
+
"kind": "expression"
|
|
363
|
+
}
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"name": "@selected-items-changed",
|
|
367
|
+
"description": "Fired when the `selectedItems` property changes.",
|
|
368
|
+
"value": {
|
|
369
|
+
"kind": "expression"
|
|
370
|
+
}
|
|
371
|
+
},
|
|
372
|
+
{
|
|
373
|
+
"name": "@cell-focus",
|
|
374
|
+
"description": "Fired when a cell is focused with click or keyboard navigation.\n\nUse context property of @see {@link GridCellFocusEvent} to get detail information about the event.",
|
|
375
|
+
"value": {
|
|
376
|
+
"kind": "expression"
|
|
377
|
+
}
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"name": "@column-reorder",
|
|
381
|
+
"description": "Fired when the columns in the grid are reordered.",
|
|
382
|
+
"value": {
|
|
383
|
+
"kind": "expression"
|
|
384
|
+
}
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "@grid-dragend",
|
|
388
|
+
"description": "Fired when the dragging of the rows ends.",
|
|
389
|
+
"value": {
|
|
390
|
+
"kind": "expression"
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "@grid-dragstart",
|
|
395
|
+
"description": "Fired when starting to drag grid rows.",
|
|
396
|
+
"value": {
|
|
397
|
+
"kind": "expression"
|
|
398
|
+
}
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "@grid-drop",
|
|
402
|
+
"description": "Fired when a drop occurs on top of the grid.",
|
|
403
|
+
"value": {
|
|
404
|
+
"kind": "expression"
|
|
405
|
+
}
|
|
406
|
+
},
|
|
176
407
|
{
|
|
177
408
|
"name": "@cell-edit-started",
|
|
178
409
|
"description": "Fired when the user starts editing a grid cell.",
|
|
@@ -187,6 +418,20 @@
|
|
|
187
418
|
"kind": "expression"
|
|
188
419
|
}
|
|
189
420
|
},
|
|
421
|
+
{
|
|
422
|
+
"name": "@size-changed",
|
|
423
|
+
"description": "Fired when the `size` property changes.",
|
|
424
|
+
"value": {
|
|
425
|
+
"kind": "expression"
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "@data-provider-changed",
|
|
430
|
+
"description": "Fired when the `dataProvider` property changes.",
|
|
431
|
+
"value": {
|
|
432
|
+
"kind": "expression"
|
|
433
|
+
}
|
|
434
|
+
},
|
|
190
435
|
{
|
|
191
436
|
"name": "@enter-next-row-changed",
|
|
192
437
|
"description": "Fired when the `enterNextRow` property changes.",
|