@vaadin/grid-pro 25.1.0-beta1 → 25.1.0-beta3
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/custom-elements.json +11 -60
- package/package.json +15 -15
- package/src/vaadin-grid-pro-edit-column-mixin.js +0 -2
- package/web-types.json +90 -34
- package/web-types.lit.json +2 -2
package/custom-elements.json
CHANGED
|
@@ -32,12 +32,6 @@
|
|
|
32
32
|
}
|
|
33
33
|
]
|
|
34
34
|
},
|
|
35
|
-
{
|
|
36
|
-
"kind": "javascript-module",
|
|
37
|
-
"path": "src/vaadin-grid-pro-edit-checkbox.js",
|
|
38
|
-
"declarations": [],
|
|
39
|
-
"exports": []
|
|
40
|
-
},
|
|
41
35
|
{
|
|
42
36
|
"kind": "javascript-module",
|
|
43
37
|
"path": "src/vaadin-grid-pro-edit-column-mixin.js",
|
|
@@ -72,7 +66,7 @@
|
|
|
72
66
|
"name": "editorType",
|
|
73
67
|
"privacy": "public",
|
|
74
68
|
"type": {
|
|
75
|
-
"text": "
|
|
69
|
+
"text": "string"
|
|
76
70
|
},
|
|
77
71
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
78
72
|
"attribute": "editor-type"
|
|
@@ -120,7 +114,7 @@
|
|
|
120
114
|
{
|
|
121
115
|
"name": "editor-type",
|
|
122
116
|
"type": {
|
|
123
|
-
"text": "
|
|
117
|
+
"text": "string"
|
|
124
118
|
},
|
|
125
119
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
126
120
|
"fieldName": "editorType"
|
|
@@ -224,7 +218,7 @@
|
|
|
224
218
|
"name": "editorType",
|
|
225
219
|
"privacy": "public",
|
|
226
220
|
"type": {
|
|
227
|
-
"text": "
|
|
221
|
+
"text": "string"
|
|
228
222
|
},
|
|
229
223
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
230
224
|
"attribute": "editor-type",
|
|
@@ -449,7 +443,7 @@
|
|
|
449
443
|
"name": "textAlign",
|
|
450
444
|
"privacy": "public",
|
|
451
445
|
"type": {
|
|
452
|
-
"text": "
|
|
446
|
+
"text": "string"
|
|
453
447
|
},
|
|
454
448
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
455
449
|
"attribute": "text-align",
|
|
@@ -513,7 +507,7 @@
|
|
|
513
507
|
{
|
|
514
508
|
"name": "editor-type",
|
|
515
509
|
"type": {
|
|
516
|
-
"text": "
|
|
510
|
+
"text": "string"
|
|
517
511
|
},
|
|
518
512
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
519
513
|
"fieldName": "editorType",
|
|
@@ -706,7 +700,7 @@
|
|
|
706
700
|
{
|
|
707
701
|
"name": "text-align",
|
|
708
702
|
"type": {
|
|
709
|
-
"text": "
|
|
703
|
+
"text": "string"
|
|
710
704
|
},
|
|
711
705
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
712
706
|
"fieldName": "textAlign",
|
|
@@ -792,18 +786,6 @@
|
|
|
792
786
|
}
|
|
793
787
|
]
|
|
794
788
|
},
|
|
795
|
-
{
|
|
796
|
-
"kind": "javascript-module",
|
|
797
|
-
"path": "src/vaadin-grid-pro-edit-select.js",
|
|
798
|
-
"declarations": [],
|
|
799
|
-
"exports": []
|
|
800
|
-
},
|
|
801
|
-
{
|
|
802
|
-
"kind": "javascript-module",
|
|
803
|
-
"path": "src/vaadin-grid-pro-edit-text-field.js",
|
|
804
|
-
"declarations": [],
|
|
805
|
-
"exports": []
|
|
806
|
-
},
|
|
807
789
|
{
|
|
808
790
|
"kind": "javascript-module",
|
|
809
791
|
"path": "src/vaadin-grid-pro-inline-editing-mixin.js",
|
|
@@ -1015,7 +997,7 @@
|
|
|
1015
997
|
"name": "columnRendering",
|
|
1016
998
|
"privacy": "public",
|
|
1017
999
|
"type": {
|
|
1018
|
-
"text": "
|
|
1000
|
+
"text": "string"
|
|
1019
1001
|
},
|
|
1020
1002
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
1021
1003
|
"attribute": "column-rendering",
|
|
@@ -1117,7 +1099,7 @@
|
|
|
1117
1099
|
"name": "dropMode",
|
|
1118
1100
|
"privacy": "public",
|
|
1119
1101
|
"type": {
|
|
1120
|
-
"text": "
|
|
1102
|
+
"text": "string"
|
|
1121
1103
|
},
|
|
1122
1104
|
"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.",
|
|
1123
1105
|
"attribute": "drop-mode",
|
|
@@ -1312,6 +1294,7 @@
|
|
|
1312
1294
|
},
|
|
1313
1295
|
"description": "`true` while data is being requested from the data provider.",
|
|
1314
1296
|
"attribute": "loading",
|
|
1297
|
+
"readonly": true,
|
|
1315
1298
|
"inheritedFrom": {
|
|
1316
1299
|
"name": "Grid",
|
|
1317
1300
|
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
@@ -1802,7 +1785,7 @@
|
|
|
1802
1785
|
{
|
|
1803
1786
|
"name": "column-rendering",
|
|
1804
1787
|
"type": {
|
|
1805
|
-
"text": "
|
|
1788
|
+
"text": "string"
|
|
1806
1789
|
},
|
|
1807
1790
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
1808
1791
|
"fieldName": "columnRendering",
|
|
@@ -1862,7 +1845,7 @@
|
|
|
1862
1845
|
{
|
|
1863
1846
|
"name": "drop-mode",
|
|
1864
1847
|
"type": {
|
|
1865
|
-
"text": "
|
|
1848
|
+
"text": "string"
|
|
1866
1849
|
},
|
|
1867
1850
|
"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.",
|
|
1868
1851
|
"fieldName": "dropMode",
|
|
@@ -1895,26 +1878,6 @@
|
|
|
1895
1878
|
"module": "src/vaadin-grid-pro-inline-editing-mixin.js"
|
|
1896
1879
|
}
|
|
1897
1880
|
},
|
|
1898
|
-
{
|
|
1899
|
-
"name": "interacting",
|
|
1900
|
-
"type": {
|
|
1901
|
-
"text": "boolean"
|
|
1902
|
-
},
|
|
1903
|
-
"description": "Indicates whether the grid is currently in interaction mode.\nIn interaction mode the user is currently interacting with a control,\nsuch as an input or a select, within a cell.\nIn interaction mode keyboard navigation between cells is disabled.\nInteraction mode also prevents the focus target cell of that section of\nthe grid from receiving focus, allowing the user to switch focus to\ncontrols in adjacent cells, rather than focussing the outer cell\nitself.",
|
|
1904
|
-
"fieldName": "interacting",
|
|
1905
|
-
"inheritedFrom": {
|
|
1906
|
-
"name": "Grid",
|
|
1907
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1908
|
-
}
|
|
1909
|
-
},
|
|
1910
|
-
{
|
|
1911
|
-
"name": "is-attached",
|
|
1912
|
-
"fieldName": "isAttached",
|
|
1913
|
-
"inheritedFrom": {
|
|
1914
|
-
"name": "Grid",
|
|
1915
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1916
|
-
}
|
|
1917
|
-
},
|
|
1918
1881
|
{
|
|
1919
1882
|
"name": "is-item-selectable",
|
|
1920
1883
|
"type": {
|
|
@@ -2058,18 +2021,6 @@
|
|
|
2058
2021
|
"name": "Grid",
|
|
2059
2022
|
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2060
2023
|
}
|
|
2061
|
-
},
|
|
2062
|
-
{
|
|
2063
|
-
"name": "tabindex",
|
|
2064
|
-
"type": {
|
|
2065
|
-
"text": "number"
|
|
2066
|
-
},
|
|
2067
|
-
"description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
|
|
2068
|
-
"fieldName": "tabindex",
|
|
2069
|
-
"inheritedFrom": {
|
|
2070
|
-
"name": "Grid",
|
|
2071
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2072
|
-
}
|
|
2073
2024
|
}
|
|
2074
2025
|
]
|
|
2075
2026
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/grid-pro",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-beta3",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -37,23 +37,23 @@
|
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
40
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
41
|
-
"@vaadin/checkbox": "25.1.0-
|
|
42
|
-
"@vaadin/component-base": "25.1.0-
|
|
43
|
-
"@vaadin/grid": "25.1.0-
|
|
44
|
-
"@vaadin/lit-renderer": "25.1.0-
|
|
45
|
-
"@vaadin/select": "25.1.0-
|
|
46
|
-
"@vaadin/text-field": "25.1.0-
|
|
47
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
40
|
+
"@vaadin/a11y-base": "25.1.0-beta3",
|
|
41
|
+
"@vaadin/checkbox": "25.1.0-beta3",
|
|
42
|
+
"@vaadin/component-base": "25.1.0-beta3",
|
|
43
|
+
"@vaadin/grid": "25.1.0-beta3",
|
|
44
|
+
"@vaadin/lit-renderer": "25.1.0-beta3",
|
|
45
|
+
"@vaadin/select": "25.1.0-beta3",
|
|
46
|
+
"@vaadin/text-field": "25.1.0-beta3",
|
|
47
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-beta3",
|
|
48
48
|
"lit": "^3.0.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@vaadin/aura": "25.1.0-
|
|
52
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
53
|
-
"@vaadin/test-runner-commands": "25.1.0-
|
|
51
|
+
"@vaadin/aura": "25.1.0-beta3",
|
|
52
|
+
"@vaadin/chai-plugins": "25.1.0-beta3",
|
|
53
|
+
"@vaadin/test-runner-commands": "25.1.0-beta3",
|
|
54
54
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
55
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
56
|
-
"sinon": "^21.0.
|
|
55
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-beta3",
|
|
56
|
+
"sinon": "^21.0.2"
|
|
57
57
|
},
|
|
58
58
|
"cvdlName": "vaadin-grid-pro",
|
|
59
59
|
"customElements": "custom-elements.json",
|
|
@@ -61,5 +61,5 @@
|
|
|
61
61
|
"web-types.json",
|
|
62
62
|
"web-types.lit.json"
|
|
63
63
|
],
|
|
64
|
-
"gitHead": "
|
|
64
|
+
"gitHead": "4251850231a42298fda23b83928da588831cdb5d"
|
|
65
65
|
}
|
|
@@ -57,7 +57,6 @@ export const GridProEditColumnMixin = (superClass) =>
|
|
|
57
57
|
*
|
|
58
58
|
* Editor type is set to `custom` when `editModeRenderer` is set.
|
|
59
59
|
* @attr {text|checkbox|select|custom} editor-type
|
|
60
|
-
* @type {!GridProEditorType}
|
|
61
60
|
*/
|
|
62
61
|
editorType: {
|
|
63
62
|
type: String,
|
|
@@ -68,7 +67,6 @@ export const GridProEditColumnMixin = (superClass) =>
|
|
|
68
67
|
/**
|
|
69
68
|
* Path of the property used for the value of the editor component.
|
|
70
69
|
* @attr {string} editor-value-path
|
|
71
|
-
* @type {string}
|
|
72
70
|
*/
|
|
73
71
|
editorValuePath: {
|
|
74
72
|
type: String,
|
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": "25.1.0-
|
|
4
|
+
"version": "25.1.0-beta3",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -15,7 +15,9 @@
|
|
|
15
15
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
16
16
|
"value": {
|
|
17
17
|
"type": [
|
|
18
|
-
"boolean"
|
|
18
|
+
"boolean",
|
|
19
|
+
"null",
|
|
20
|
+
"undefined"
|
|
19
21
|
]
|
|
20
22
|
}
|
|
21
23
|
},
|
|
@@ -24,7 +26,9 @@
|
|
|
24
26
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
25
27
|
"value": {
|
|
26
28
|
"type": [
|
|
27
|
-
"
|
|
29
|
+
"string",
|
|
30
|
+
"null",
|
|
31
|
+
"undefined"
|
|
28
32
|
]
|
|
29
33
|
}
|
|
30
34
|
},
|
|
@@ -33,7 +37,9 @@
|
|
|
33
37
|
"description": "Path of the property used for the value of the editor component.",
|
|
34
38
|
"value": {
|
|
35
39
|
"type": [
|
|
36
|
-
"string"
|
|
40
|
+
"string",
|
|
41
|
+
"null",
|
|
42
|
+
"undefined"
|
|
37
43
|
]
|
|
38
44
|
}
|
|
39
45
|
},
|
|
@@ -42,7 +48,9 @@
|
|
|
42
48
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
43
49
|
"value": {
|
|
44
50
|
"type": [
|
|
45
|
-
"number"
|
|
51
|
+
"number",
|
|
52
|
+
"null",
|
|
53
|
+
"undefined"
|
|
46
54
|
]
|
|
47
55
|
}
|
|
48
56
|
},
|
|
@@ -62,7 +70,9 @@
|
|
|
62
70
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
63
71
|
"value": {
|
|
64
72
|
"type": [
|
|
65
|
-
"boolean"
|
|
73
|
+
"boolean",
|
|
74
|
+
"null",
|
|
75
|
+
"undefined"
|
|
66
76
|
]
|
|
67
77
|
}
|
|
68
78
|
},
|
|
@@ -71,7 +81,9 @@
|
|
|
71
81
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
72
82
|
"value": {
|
|
73
83
|
"type": [
|
|
74
|
-
"boolean"
|
|
84
|
+
"boolean",
|
|
85
|
+
"null",
|
|
86
|
+
"undefined"
|
|
75
87
|
]
|
|
76
88
|
}
|
|
77
89
|
},
|
|
@@ -135,7 +147,9 @@
|
|
|
135
147
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
136
148
|
"value": {
|
|
137
149
|
"type": [
|
|
138
|
-
"boolean"
|
|
150
|
+
"boolean",
|
|
151
|
+
"null",
|
|
152
|
+
"undefined"
|
|
139
153
|
]
|
|
140
154
|
}
|
|
141
155
|
},
|
|
@@ -144,7 +158,7 @@
|
|
|
144
158
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
145
159
|
"value": {
|
|
146
160
|
"type": [
|
|
147
|
-
"
|
|
161
|
+
"string",
|
|
148
162
|
"null",
|
|
149
163
|
"undefined"
|
|
150
164
|
]
|
|
@@ -180,7 +194,9 @@
|
|
|
180
194
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
181
195
|
"value": {
|
|
182
196
|
"type": [
|
|
183
|
-
"boolean"
|
|
197
|
+
"boolean",
|
|
198
|
+
"null",
|
|
199
|
+
"undefined"
|
|
184
200
|
]
|
|
185
201
|
}
|
|
186
202
|
},
|
|
@@ -209,7 +225,9 @@
|
|
|
209
225
|
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
210
226
|
"value": {
|
|
211
227
|
"type": [
|
|
212
|
-
"
|
|
228
|
+
"string",
|
|
229
|
+
"null",
|
|
230
|
+
"undefined"
|
|
213
231
|
]
|
|
214
232
|
}
|
|
215
233
|
},
|
|
@@ -218,7 +236,9 @@
|
|
|
218
236
|
"description": "Path of the property used for the value of the editor component.",
|
|
219
237
|
"value": {
|
|
220
238
|
"type": [
|
|
221
|
-
"string"
|
|
239
|
+
"string",
|
|
240
|
+
"null",
|
|
241
|
+
"undefined"
|
|
222
242
|
]
|
|
223
243
|
}
|
|
224
244
|
},
|
|
@@ -227,7 +247,9 @@
|
|
|
227
247
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
228
248
|
"value": {
|
|
229
249
|
"type": [
|
|
230
|
-
"number"
|
|
250
|
+
"number",
|
|
251
|
+
"null",
|
|
252
|
+
"undefined"
|
|
231
253
|
]
|
|
232
254
|
}
|
|
233
255
|
},
|
|
@@ -258,7 +280,9 @@
|
|
|
258
280
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
259
281
|
"value": {
|
|
260
282
|
"type": [
|
|
261
|
-
"boolean"
|
|
283
|
+
"boolean",
|
|
284
|
+
"null",
|
|
285
|
+
"undefined"
|
|
262
286
|
]
|
|
263
287
|
}
|
|
264
288
|
},
|
|
@@ -267,7 +291,9 @@
|
|
|
267
291
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
268
292
|
"value": {
|
|
269
293
|
"type": [
|
|
270
|
-
"boolean"
|
|
294
|
+
"boolean",
|
|
295
|
+
"null",
|
|
296
|
+
"undefined"
|
|
271
297
|
]
|
|
272
298
|
}
|
|
273
299
|
},
|
|
@@ -364,7 +390,9 @@
|
|
|
364
390
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
365
391
|
"value": {
|
|
366
392
|
"type": [
|
|
367
|
-
"boolean"
|
|
393
|
+
"boolean",
|
|
394
|
+
"null",
|
|
395
|
+
"undefined"
|
|
368
396
|
]
|
|
369
397
|
}
|
|
370
398
|
},
|
|
@@ -373,7 +401,7 @@
|
|
|
373
401
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
374
402
|
"value": {
|
|
375
403
|
"type": [
|
|
376
|
-
"
|
|
404
|
+
"string",
|
|
377
405
|
"null",
|
|
378
406
|
"undefined"
|
|
379
407
|
]
|
|
@@ -401,7 +429,7 @@
|
|
|
401
429
|
},
|
|
402
430
|
{
|
|
403
431
|
"name": "vaadin-grid-pro",
|
|
404
|
-
"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/25.1.0-
|
|
432
|
+
"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/25.1.0-beta3/#/elements/vaadin-grid) documentation for details.\n\n```html\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/25.1.0-beta3/#/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/25.1.0-beta3/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-select).",
|
|
405
433
|
"attributes": [
|
|
406
434
|
{
|
|
407
435
|
"name": "accessible-name",
|
|
@@ -419,7 +447,9 @@
|
|
|
419
447
|
"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.",
|
|
420
448
|
"value": {
|
|
421
449
|
"type": [
|
|
422
|
-
"boolean"
|
|
450
|
+
"boolean",
|
|
451
|
+
"null",
|
|
452
|
+
"undefined"
|
|
423
453
|
]
|
|
424
454
|
}
|
|
425
455
|
},
|
|
@@ -428,7 +458,9 @@
|
|
|
428
458
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
429
459
|
"value": {
|
|
430
460
|
"type": [
|
|
431
|
-
"
|
|
461
|
+
"string",
|
|
462
|
+
"null",
|
|
463
|
+
"undefined"
|
|
432
464
|
]
|
|
433
465
|
}
|
|
434
466
|
},
|
|
@@ -437,7 +469,9 @@
|
|
|
437
469
|
"description": "Set to true to allow column reordering.",
|
|
438
470
|
"value": {
|
|
439
471
|
"type": [
|
|
440
|
-
"boolean"
|
|
472
|
+
"boolean",
|
|
473
|
+
"null",
|
|
474
|
+
"undefined"
|
|
441
475
|
]
|
|
442
476
|
}
|
|
443
477
|
},
|
|
@@ -446,7 +480,7 @@
|
|
|
446
480
|
"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.",
|
|
447
481
|
"value": {
|
|
448
482
|
"type": [
|
|
449
|
-
"
|
|
483
|
+
"string",
|
|
450
484
|
"null",
|
|
451
485
|
"undefined"
|
|
452
486
|
]
|
|
@@ -501,7 +535,9 @@
|
|
|
501
535
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
502
536
|
"value": {
|
|
503
537
|
"type": [
|
|
504
|
-
"boolean"
|
|
538
|
+
"boolean",
|
|
539
|
+
"null",
|
|
540
|
+
"undefined"
|
|
505
541
|
]
|
|
506
542
|
}
|
|
507
543
|
},
|
|
@@ -510,7 +546,9 @@
|
|
|
510
546
|
"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.",
|
|
511
547
|
"value": {
|
|
512
548
|
"type": [
|
|
513
|
-
"boolean"
|
|
549
|
+
"boolean",
|
|
550
|
+
"null",
|
|
551
|
+
"undefined"
|
|
514
552
|
]
|
|
515
553
|
}
|
|
516
554
|
},
|
|
@@ -530,7 +568,9 @@
|
|
|
530
568
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
531
569
|
"value": {
|
|
532
570
|
"type": [
|
|
533
|
-
"number"
|
|
571
|
+
"number",
|
|
572
|
+
"null",
|
|
573
|
+
"undefined"
|
|
534
574
|
]
|
|
535
575
|
}
|
|
536
576
|
},
|
|
@@ -561,7 +601,9 @@
|
|
|
561
601
|
"description": "The number of root-level items in the grid.",
|
|
562
602
|
"value": {
|
|
563
603
|
"type": [
|
|
564
|
-
"number"
|
|
604
|
+
"number",
|
|
605
|
+
"null",
|
|
606
|
+
"undefined"
|
|
565
607
|
]
|
|
566
608
|
}
|
|
567
609
|
},
|
|
@@ -604,7 +646,9 @@
|
|
|
604
646
|
"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.",
|
|
605
647
|
"value": {
|
|
606
648
|
"type": [
|
|
607
|
-
"boolean"
|
|
649
|
+
"boolean",
|
|
650
|
+
"null",
|
|
651
|
+
"undefined"
|
|
608
652
|
]
|
|
609
653
|
}
|
|
610
654
|
},
|
|
@@ -624,7 +668,9 @@
|
|
|
624
668
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
625
669
|
"value": {
|
|
626
670
|
"type": [
|
|
627
|
-
"
|
|
671
|
+
"string",
|
|
672
|
+
"null",
|
|
673
|
+
"undefined"
|
|
628
674
|
]
|
|
629
675
|
}
|
|
630
676
|
},
|
|
@@ -633,7 +679,9 @@
|
|
|
633
679
|
"description": "Set to true to allow column reordering.",
|
|
634
680
|
"value": {
|
|
635
681
|
"type": [
|
|
636
|
-
"boolean"
|
|
682
|
+
"boolean",
|
|
683
|
+
"null",
|
|
684
|
+
"undefined"
|
|
637
685
|
]
|
|
638
686
|
}
|
|
639
687
|
},
|
|
@@ -684,7 +732,7 @@
|
|
|
684
732
|
"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.",
|
|
685
733
|
"value": {
|
|
686
734
|
"type": [
|
|
687
|
-
"
|
|
735
|
+
"string",
|
|
688
736
|
"null",
|
|
689
737
|
"undefined"
|
|
690
738
|
]
|
|
@@ -769,7 +817,9 @@
|
|
|
769
817
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
770
818
|
"value": {
|
|
771
819
|
"type": [
|
|
772
|
-
"boolean"
|
|
820
|
+
"boolean",
|
|
821
|
+
"null",
|
|
822
|
+
"undefined"
|
|
773
823
|
]
|
|
774
824
|
}
|
|
775
825
|
},
|
|
@@ -778,7 +828,9 @@
|
|
|
778
828
|
"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.",
|
|
779
829
|
"value": {
|
|
780
830
|
"type": [
|
|
781
|
-
"boolean"
|
|
831
|
+
"boolean",
|
|
832
|
+
"null",
|
|
833
|
+
"undefined"
|
|
782
834
|
]
|
|
783
835
|
}
|
|
784
836
|
},
|
|
@@ -798,7 +850,9 @@
|
|
|
798
850
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
799
851
|
"value": {
|
|
800
852
|
"type": [
|
|
801
|
-
"number"
|
|
853
|
+
"number",
|
|
854
|
+
"null",
|
|
855
|
+
"undefined"
|
|
802
856
|
]
|
|
803
857
|
}
|
|
804
858
|
},
|
|
@@ -849,7 +903,9 @@
|
|
|
849
903
|
"description": "The number of root-level items in the grid.",
|
|
850
904
|
"value": {
|
|
851
905
|
"type": [
|
|
852
|
-
"number"
|
|
906
|
+
"number",
|
|
907
|
+
"null",
|
|
908
|
+
"undefined"
|
|
853
909
|
]
|
|
854
910
|
}
|
|
855
911
|
}
|
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": "25.1.0-
|
|
4
|
+
"version": "25.1.0-beta3",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -177,7 +177,7 @@
|
|
|
177
177
|
},
|
|
178
178
|
{
|
|
179
179
|
"name": "vaadin-grid-pro",
|
|
180
|
-
"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/25.1.0-
|
|
180
|
+
"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/25.1.0-beta3/#/elements/vaadin-grid) documentation for details.\n\n```html\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/25.1.0-beta3/#/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/25.1.0-beta3/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-select).",
|
|
181
181
|
"extension": true,
|
|
182
182
|
"attributes": [
|
|
183
183
|
{
|