@vaadin/combo-box 23.2.0 → 23.2.2
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 +13 -13
- package/src/vaadin-combo-box-scroller.js +25 -11
- package/web-types.json +26 -2
- package/web-types.lit.json +44 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/combo-box",
|
|
3
|
-
"version": "23.2.
|
|
3
|
+
"version": "23.2.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -38,21 +38,21 @@
|
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
40
40
|
"@polymer/polymer": "^3.0.0",
|
|
41
|
-
"@vaadin/component-base": "
|
|
42
|
-
"@vaadin/field-base": "
|
|
43
|
-
"@vaadin/input-container": "
|
|
44
|
-
"@vaadin/item": "
|
|
45
|
-
"@vaadin/lit-renderer": "
|
|
46
|
-
"@vaadin/vaadin-lumo-styles": "
|
|
47
|
-
"@vaadin/vaadin-material-styles": "
|
|
48
|
-
"@vaadin/vaadin-overlay": "
|
|
49
|
-
"@vaadin/vaadin-themable-mixin": "
|
|
41
|
+
"@vaadin/component-base": "~23.2.2",
|
|
42
|
+
"@vaadin/field-base": "~23.2.2",
|
|
43
|
+
"@vaadin/input-container": "~23.2.2",
|
|
44
|
+
"@vaadin/item": "~23.2.2",
|
|
45
|
+
"@vaadin/lit-renderer": "~23.2.2",
|
|
46
|
+
"@vaadin/vaadin-lumo-styles": "~23.2.2",
|
|
47
|
+
"@vaadin/vaadin-material-styles": "~23.2.2",
|
|
48
|
+
"@vaadin/vaadin-overlay": "~23.2.2",
|
|
49
|
+
"@vaadin/vaadin-themable-mixin": "~23.2.2"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@esm-bundle/chai": "^4.3.4",
|
|
53
|
-
"@vaadin/polymer-legacy-adapter": "
|
|
53
|
+
"@vaadin/polymer-legacy-adapter": "~23.2.2",
|
|
54
54
|
"@vaadin/testing-helpers": "^0.3.2",
|
|
55
|
-
"@vaadin/text-field": "
|
|
55
|
+
"@vaadin/text-field": "~23.2.2",
|
|
56
56
|
"lit": "^2.0.0",
|
|
57
57
|
"sinon": "^13.0.2"
|
|
58
58
|
},
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"web-types.json",
|
|
61
61
|
"web-types.lit.json"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "a98818979098f4542ce557a58858fb6dad910a25"
|
|
64
64
|
}
|
|
@@ -250,7 +250,7 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
250
250
|
/** @private */
|
|
251
251
|
__loadingChanged() {
|
|
252
252
|
if (this.__virtualizer) {
|
|
253
|
-
|
|
253
|
+
this.requestContentUpdate();
|
|
254
254
|
}
|
|
255
255
|
}
|
|
256
256
|
|
|
@@ -304,7 +304,7 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
304
304
|
|
|
305
305
|
el.setProperties({
|
|
306
306
|
item,
|
|
307
|
-
index
|
|
307
|
+
index,
|
|
308
308
|
label: this.getItemLabel(item),
|
|
309
309
|
selected: this.__isItemSelected(item, this.selectedItem, this.itemIdPath),
|
|
310
310
|
renderer: this.renderer,
|
|
@@ -321,6 +321,10 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
321
321
|
} else {
|
|
322
322
|
el.removeAttribute('theme');
|
|
323
323
|
}
|
|
324
|
+
|
|
325
|
+
if (item instanceof ComboBoxPlaceholder) {
|
|
326
|
+
this.__requestItemByIndex(index);
|
|
327
|
+
}
|
|
324
328
|
}
|
|
325
329
|
|
|
326
330
|
/** @private */
|
|
@@ -361,19 +365,29 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
361
365
|
}
|
|
362
366
|
|
|
363
367
|
/**
|
|
364
|
-
*
|
|
365
|
-
* the
|
|
368
|
+
* Dispatches an `index-requested` event for the given index to notify
|
|
369
|
+
* the data provider that it should start loading the page containing the requested index.
|
|
366
370
|
*
|
|
367
|
-
*
|
|
371
|
+
* The event is dispatched asynchronously to prevent an immediate page request and therefore
|
|
372
|
+
* a possible infinite recursion in case the data provider implements page request cancelation logic
|
|
373
|
+
* by invoking data provider page callbacks with an empty array.
|
|
374
|
+
* The infinite recursion may occur otherwise since invoking a data provider page callback with an empty array
|
|
375
|
+
* triggers a synchronous scroller update and, if the callback corresponds to the currently visible page,
|
|
376
|
+
* the scroller will synchronously request the page again which may lead to looping in the end.
|
|
377
|
+
* That was the case for the Flow counterpart:
|
|
378
|
+
* https://github.com/vaadin/flow-components/issues/3553#issuecomment-1239344828
|
|
368
379
|
*/
|
|
369
|
-
__requestItemByIndex(
|
|
370
|
-
|
|
380
|
+
__requestItemByIndex(index) {
|
|
381
|
+
requestAnimationFrame(() => {
|
|
371
382
|
this.dispatchEvent(
|
|
372
|
-
new CustomEvent('index-requested', {
|
|
383
|
+
new CustomEvent('index-requested', {
|
|
384
|
+
detail: {
|
|
385
|
+
index,
|
|
386
|
+
currentScrollerPos: this._oldScrollerPosition,
|
|
387
|
+
},
|
|
388
|
+
}),
|
|
373
389
|
);
|
|
374
|
-
}
|
|
375
|
-
|
|
376
|
-
return index;
|
|
390
|
+
});
|
|
377
391
|
}
|
|
378
392
|
|
|
379
393
|
/** @private */
|
package/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/combo-box",
|
|
4
|
-
"version": "23.2.
|
|
4
|
+
"version": "23.2.2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -376,13 +376,25 @@
|
|
|
376
376
|
{
|
|
377
377
|
"name": "validated",
|
|
378
378
|
"description": "Fired whenever the field is validated."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "opened-changed",
|
|
382
|
+
"description": "Fired when the `opened` property changes."
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "filter-changed",
|
|
386
|
+
"description": "Fired when the `filter` property changes."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "invalid-changed",
|
|
390
|
+
"description": "Fired when the `invalid` property changes."
|
|
379
391
|
}
|
|
380
392
|
]
|
|
381
393
|
}
|
|
382
394
|
},
|
|
383
395
|
{
|
|
384
396
|
"name": "vaadin-combo-box",
|
|
385
|
-
"description": "`<vaadin-combo-box>` is a web component for choosing a value from a filterable list of options\npresented in a dropdown overlay. The options can be provided as a list of strings or objects\nby setting [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.
|
|
397
|
+
"description": "`<vaadin-combo-box>` is a web component for choosing a value from a filterable list of options\npresented in a dropdown overlay. The options can be provided as a list of strings or objects\nby setting [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-items) property on the element.\n\n```html\n<vaadin-combo-box id=\"combo-box\"></vaadin-combo-box>\n```\n```js\ndocument.querySelector('#combo-box').items = ['apple', 'orange', 'banana'];\n```\n\nWhen the selected `value` is changed, a `value-changed` event is triggered.\n\n### Item rendering\n\nTo customize the content of the `<vaadin-combo-box-item>` elements placed in the dropdown, use\n[`renderer`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-renderer) property which accepts a function.\nThe renderer function is called with `root`, `comboBox`, and `model` as arguments.\n\nGenerate DOM content by using `model` object properties if needed, and append it to the `root`\nelement. The `comboBox` reference is provided to access the combo-box element state. Do not\nset combo-box properties in a `renderer` function.\n\n```js\nconst comboBox = document.querySelector('#combo-box');\ncomboBox.items = [{'label': 'Hydrogen', 'value': 'H'}];\ncomboBox.renderer = (root, comboBox, model) => {\n const item = model.item;\n root.innerHTML = `${model.index}: ${item.label} <b>${item.value}</b>`;\n};\n```\n\nRenderer is called on the opening of the combo-box and each time the related model is updated.\nBefore creating new content, it is recommended to check if there is already an existing DOM\nelement in `root` from a previous renderer call for reusing it. Even though combo-box uses\ninfinite scrolling, reducing DOM operations might improve performance.\n\nThe following properties are available in the `model` argument:\n\nProperty | Type | Description\n-----------|------------------|-------------\n`index` | Number | Index of the item in the `items` array\n`item` | String or Object | The item reference\n`selected` | Boolean | True when item is selected\n`focused` | Boolean | True when item is focused\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively use the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-dataProvider) function property.\nThe `<vaadin-combo-box>` calls this function lazily, only when it needs more data\nto be displayed.\n\n__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\ncomboBox.dataProvider = function(params, callback) {\n var url = 'https://api.example/data' +\n '?page=' + params.page + // the requested page index\n '&per_page=' + params.pageSize; // number of items on the page\n var xhr = new XMLHttpRequest();\n xhr.onload = function() {\n var response = JSON.parse(xhr.responseText);\n callback(\n response.employees, // requested page of items\n response.totalSize // total number of items\n );\n };\n xhr.open('GET', url, true);\n xhr.send();\n};\n```\n\n### Styling\n\nThe following custom properties are available for styling:\n\nCustom property | Description | Default\n----------------------------------------|----------------------------|---------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n`--vaadin-combo-box-overlay-width` | Width of the overlay | `auto`\n`--vaadin-combo-box-overlay-max-height` | Max height of the overlay | `65vh`\n\n`<vaadin-combo-box>` provides the same set of shadow DOM parts and state attributes as `<vaadin-text-field>`.\nSee [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-text-field) for the styling documentation.\n\nIn addition to `<vaadin-text-field>` parts, the following parts are available for theming:\n\nPart name | Description\n----------------|----------------\n`toggle-button` | The toggle button\n\nIn addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:\n\nAttribute | Description | Part name\n----------|-------------|------------\n`opened` | Set when the combo box dropdown is open | :host\n`loading` | Set when new items are expected | :host\n\nIf you want to replace the default `<input>` and its container with a custom implementation to get full control\nover the input field, consider using the [`<vaadin-combo-box-light>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box-light) element.\n\n### Internal components\n\nIn addition to `<vaadin-combo-box>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-combo-box-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-input-container) - an internal element wrapping the input.\n\nNote: the `theme` attribute value set on `<vaadin-combo-box>` is\npropagated to the internal components listed above.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
386
398
|
"attributes": [
|
|
387
399
|
{
|
|
388
400
|
"name": "disabled",
|
|
@@ -1044,6 +1056,18 @@
|
|
|
1044
1056
|
{
|
|
1045
1057
|
"name": "value-changed",
|
|
1046
1058
|
"description": "Fired when the value changes."
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "invalid-changed",
|
|
1062
|
+
"description": "Fired when the `invalid` property changes."
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "opened-changed",
|
|
1066
|
+
"description": "Fired when the `opened` property changes."
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "filter-changed",
|
|
1070
|
+
"description": "Fired when the `filter` property changes."
|
|
1047
1071
|
}
|
|
1048
1072
|
]
|
|
1049
1073
|
}
|
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/combo-box",
|
|
4
|
-
"version": "23.2.
|
|
4
|
+
"version": "23.2.2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -200,12 +200,33 @@
|
|
|
200
200
|
"value": {
|
|
201
201
|
"kind": "expression"
|
|
202
202
|
}
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "@opened-changed",
|
|
206
|
+
"description": "Fired when the `opened` property changes.",
|
|
207
|
+
"value": {
|
|
208
|
+
"kind": "expression"
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "@filter-changed",
|
|
213
|
+
"description": "Fired when the `filter` property changes.",
|
|
214
|
+
"value": {
|
|
215
|
+
"kind": "expression"
|
|
216
|
+
}
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "@invalid-changed",
|
|
220
|
+
"description": "Fired when the `invalid` property changes.",
|
|
221
|
+
"value": {
|
|
222
|
+
"kind": "expression"
|
|
223
|
+
}
|
|
203
224
|
}
|
|
204
225
|
]
|
|
205
226
|
},
|
|
206
227
|
{
|
|
207
228
|
"name": "vaadin-combo-box",
|
|
208
|
-
"description": "`<vaadin-combo-box>` is a web component for choosing a value from a filterable list of options\npresented in a dropdown overlay. The options can be provided as a list of strings or objects\nby setting [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.
|
|
229
|
+
"description": "`<vaadin-combo-box>` is a web component for choosing a value from a filterable list of options\npresented in a dropdown overlay. The options can be provided as a list of strings or objects\nby setting [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-items) property on the element.\n\n```html\n<vaadin-combo-box id=\"combo-box\"></vaadin-combo-box>\n```\n```js\ndocument.querySelector('#combo-box').items = ['apple', 'orange', 'banana'];\n```\n\nWhen the selected `value` is changed, a `value-changed` event is triggered.\n\n### Item rendering\n\nTo customize the content of the `<vaadin-combo-box-item>` elements placed in the dropdown, use\n[`renderer`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-renderer) property which accepts a function.\nThe renderer function is called with `root`, `comboBox`, and `model` as arguments.\n\nGenerate DOM content by using `model` object properties if needed, and append it to the `root`\nelement. The `comboBox` reference is provided to access the combo-box element state. Do not\nset combo-box properties in a `renderer` function.\n\n```js\nconst comboBox = document.querySelector('#combo-box');\ncomboBox.items = [{'label': 'Hydrogen', 'value': 'H'}];\ncomboBox.renderer = (root, comboBox, model) => {\n const item = model.item;\n root.innerHTML = `${model.index}: ${item.label} <b>${item.value}</b>`;\n};\n```\n\nRenderer is called on the opening of the combo-box and each time the related model is updated.\nBefore creating new content, it is recommended to check if there is already an existing DOM\nelement in `root` from a previous renderer call for reusing it. Even though combo-box uses\ninfinite scrolling, reducing DOM operations might improve performance.\n\nThe following properties are available in the `model` argument:\n\nProperty | Type | Description\n-----------|------------------|-------------\n`index` | Number | Index of the item in the `items` array\n`item` | String or Object | The item reference\n`selected` | Boolean | True when item is selected\n`focused` | Boolean | True when item is focused\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively use the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box#property-dataProvider) function property.\nThe `<vaadin-combo-box>` calls this function lazily, only when it needs more data\nto be displayed.\n\n__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\ncomboBox.dataProvider = function(params, callback) {\n var url = 'https://api.example/data' +\n '?page=' + params.page + // the requested page index\n '&per_page=' + params.pageSize; // number of items on the page\n var xhr = new XMLHttpRequest();\n xhr.onload = function() {\n var response = JSON.parse(xhr.responseText);\n callback(\n response.employees, // requested page of items\n response.totalSize // total number of items\n );\n };\n xhr.open('GET', url, true);\n xhr.send();\n};\n```\n\n### Styling\n\nThe following custom properties are available for styling:\n\nCustom property | Description | Default\n----------------------------------------|----------------------------|---------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n`--vaadin-combo-box-overlay-width` | Width of the overlay | `auto`\n`--vaadin-combo-box-overlay-max-height` | Max height of the overlay | `65vh`\n\n`<vaadin-combo-box>` provides the same set of shadow DOM parts and state attributes as `<vaadin-text-field>`.\nSee [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-text-field) for the styling documentation.\n\nIn addition to `<vaadin-text-field>` parts, the following parts are available for theming:\n\nPart name | Description\n----------------|----------------\n`toggle-button` | The toggle button\n\nIn addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:\n\nAttribute | Description | Part name\n----------|-------------|------------\n`opened` | Set when the combo box dropdown is open | :host\n`loading` | Set when new items are expected | :host\n\nIf you want to replace the default `<input>` and its container with a custom implementation to get full control\nover the input field, consider using the [`<vaadin-combo-box-light>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-combo-box-light) element.\n\n### Internal components\n\nIn addition to `<vaadin-combo-box>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-combo-box-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.2.2/#/elements/vaadin-input-container) - an internal element wrapping the input.\n\nNote: the `theme` attribute value set on `<vaadin-combo-box>` is\npropagated to the internal components listed above.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
209
230
|
"extension": true,
|
|
210
231
|
"attributes": [
|
|
211
232
|
{
|
|
@@ -487,6 +508,27 @@
|
|
|
487
508
|
"value": {
|
|
488
509
|
"kind": "expression"
|
|
489
510
|
}
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "@invalid-changed",
|
|
514
|
+
"description": "Fired when the `invalid` property changes.",
|
|
515
|
+
"value": {
|
|
516
|
+
"kind": "expression"
|
|
517
|
+
}
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "@opened-changed",
|
|
521
|
+
"description": "Fired when the `opened` property changes.",
|
|
522
|
+
"value": {
|
|
523
|
+
"kind": "expression"
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"name": "@filter-changed",
|
|
528
|
+
"description": "Fired when the `filter` property changes.",
|
|
529
|
+
"value": {
|
|
530
|
+
"kind": "expression"
|
|
531
|
+
}
|
|
490
532
|
}
|
|
491
533
|
]
|
|
492
534
|
}
|