@vaadin/combo-box 23.3.0-alpha1 → 23.3.0-alpha2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +13 -13
- package/src/vaadin-combo-box-scroller.js +20 -9
- package/src/vaadin-combo-box.js +1 -0
- package/web-types.json +2 -10
- package/web-types.lit.json +2 -16
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/combo-box",
|
|
3
|
-
"version": "23.3.0-
|
|
3
|
+
"version": "23.3.0-alpha2",
|
|
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": "23.3.0-
|
|
42
|
-
"@vaadin/field-base": "23.3.0-
|
|
43
|
-
"@vaadin/input-container": "23.3.0-
|
|
44
|
-
"@vaadin/item": "23.3.0-
|
|
45
|
-
"@vaadin/lit-renderer": "23.3.0-
|
|
46
|
-
"@vaadin/vaadin-lumo-styles": "23.3.0-
|
|
47
|
-
"@vaadin/vaadin-material-styles": "23.3.0-
|
|
48
|
-
"@vaadin/vaadin-overlay": "23.3.0-
|
|
49
|
-
"@vaadin/vaadin-themable-mixin": "23.3.0-
|
|
41
|
+
"@vaadin/component-base": "23.3.0-alpha2",
|
|
42
|
+
"@vaadin/field-base": "23.3.0-alpha2",
|
|
43
|
+
"@vaadin/input-container": "23.3.0-alpha2",
|
|
44
|
+
"@vaadin/item": "23.3.0-alpha2",
|
|
45
|
+
"@vaadin/lit-renderer": "23.3.0-alpha2",
|
|
46
|
+
"@vaadin/vaadin-lumo-styles": "23.3.0-alpha2",
|
|
47
|
+
"@vaadin/vaadin-material-styles": "23.3.0-alpha2",
|
|
48
|
+
"@vaadin/vaadin-overlay": "23.3.0-alpha2",
|
|
49
|
+
"@vaadin/vaadin-themable-mixin": "23.3.0-alpha2"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@esm-bundle/chai": "^4.3.4",
|
|
53
|
-
"@vaadin/polymer-legacy-adapter": "23.3.0-
|
|
53
|
+
"@vaadin/polymer-legacy-adapter": "23.3.0-alpha2",
|
|
54
54
|
"@vaadin/testing-helpers": "^0.3.2",
|
|
55
|
-
"@vaadin/text-field": "23.3.0-
|
|
55
|
+
"@vaadin/text-field": "23.3.0-alpha2",
|
|
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": "ae61027c62ffa7f7d70cfc50e43f333addfc74b6"
|
|
64
64
|
}
|
|
@@ -247,7 +247,7 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
247
247
|
|
|
248
248
|
/** @private */
|
|
249
249
|
__loadingChanged() {
|
|
250
|
-
|
|
250
|
+
this.requestContentUpdate();
|
|
251
251
|
}
|
|
252
252
|
|
|
253
253
|
/** @private */
|
|
@@ -357,16 +357,27 @@ export class ComboBoxScroller extends PolymerElement {
|
|
|
357
357
|
/**
|
|
358
358
|
* Dispatches an `index-requested` event for the given index to notify
|
|
359
359
|
* the data provider that it should start loading the page containing the requested index.
|
|
360
|
+
*
|
|
361
|
+
* The event is dispatched asynchronously to prevent an immediate page request and therefore
|
|
362
|
+
* a possible infinite recursion in case the data provider implements page request cancelation logic
|
|
363
|
+
* by invoking data provider page callbacks with an empty array.
|
|
364
|
+
* The infinite recursion may occur otherwise since invoking a data provider page callback with an empty array
|
|
365
|
+
* triggers a synchronous scroller update and, if the callback corresponds to the currently visible page,
|
|
366
|
+
* the scroller will synchronously request the page again which may lead to looping in the end.
|
|
367
|
+
* That was the case for the Flow counterpart:
|
|
368
|
+
* https://github.com/vaadin/flow-components/issues/3553#issuecomment-1239344828
|
|
360
369
|
*/
|
|
361
370
|
__requestItemByIndex(index) {
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
371
|
+
requestAnimationFrame(() => {
|
|
372
|
+
this.dispatchEvent(
|
|
373
|
+
new CustomEvent('index-requested', {
|
|
374
|
+
detail: {
|
|
375
|
+
index,
|
|
376
|
+
currentScrollerPos: this._oldScrollerPosition,
|
|
377
|
+
},
|
|
378
|
+
}),
|
|
379
|
+
);
|
|
380
|
+
});
|
|
370
381
|
}
|
|
371
382
|
|
|
372
383
|
/** @private */
|
package/src/vaadin-combo-box.js
CHANGED
|
@@ -251,6 +251,7 @@ class ComboBox extends ComboBoxDataProviderMixin(
|
|
|
251
251
|
|
|
252
252
|
this._tooltipController = new TooltipController(this);
|
|
253
253
|
this.addController(this._tooltipController);
|
|
254
|
+
this._tooltipController.setPosition('top');
|
|
254
255
|
this._tooltipController.setShouldShow((target) => !target.opened);
|
|
255
256
|
|
|
256
257
|
this._positionTarget = this.shadowRoot.querySelector('[part="input-field"]');
|
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.3.0-
|
|
4
|
+
"version": "23.3.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -385,10 +385,6 @@
|
|
|
385
385
|
"name": "filter-changed",
|
|
386
386
|
"description": "Fired when the `filter` property changes."
|
|
387
387
|
},
|
|
388
|
-
{
|
|
389
|
-
"name": "selectedItem-changed",
|
|
390
|
-
"description": "Fired when the `selectedItem` property changes."
|
|
391
|
-
},
|
|
392
388
|
{
|
|
393
389
|
"name": "invalid-changed",
|
|
394
390
|
"description": "Fired when the `invalid` property changes."
|
|
@@ -398,7 +394,7 @@
|
|
|
398
394
|
},
|
|
399
395
|
{
|
|
400
396
|
"name": "vaadin-combo-box",
|
|
401
|
-
"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.3.0-
|
|
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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.3.0-alpha2/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.3.0-alpha2/#/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.",
|
|
402
398
|
"attributes": [
|
|
403
399
|
{
|
|
404
400
|
"name": "disabled",
|
|
@@ -1072,10 +1068,6 @@
|
|
|
1072
1068
|
{
|
|
1073
1069
|
"name": "filter-changed",
|
|
1074
1070
|
"description": "Fired when the `filter` property changes."
|
|
1075
|
-
},
|
|
1076
|
-
{
|
|
1077
|
-
"name": "selectedItem-changed",
|
|
1078
|
-
"description": "Fired when the `selectedItem` property changes."
|
|
1079
1071
|
}
|
|
1080
1072
|
]
|
|
1081
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.3.0-
|
|
4
|
+
"version": "23.3.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -215,13 +215,6 @@
|
|
|
215
215
|
"kind": "expression"
|
|
216
216
|
}
|
|
217
217
|
},
|
|
218
|
-
{
|
|
219
|
-
"name": "@selectedItem-changed",
|
|
220
|
-
"description": "Fired when the `selectedItem` property changes.",
|
|
221
|
-
"value": {
|
|
222
|
-
"kind": "expression"
|
|
223
|
-
}
|
|
224
|
-
},
|
|
225
218
|
{
|
|
226
219
|
"name": "@invalid-changed",
|
|
227
220
|
"description": "Fired when the `invalid` property changes.",
|
|
@@ -233,7 +226,7 @@
|
|
|
233
226
|
},
|
|
234
227
|
{
|
|
235
228
|
"name": "vaadin-combo-box",
|
|
236
|
-
"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.3.0-
|
|
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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/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.3.0-alpha2/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.3.0-alpha2/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.3.0-alpha2/#/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.",
|
|
237
230
|
"extension": true,
|
|
238
231
|
"attributes": [
|
|
239
232
|
{
|
|
@@ -536,13 +529,6 @@
|
|
|
536
529
|
"value": {
|
|
537
530
|
"kind": "expression"
|
|
538
531
|
}
|
|
539
|
-
},
|
|
540
|
-
{
|
|
541
|
-
"name": "@selectedItem-changed",
|
|
542
|
-
"description": "Fired when the `selectedItem` property changes.",
|
|
543
|
-
"value": {
|
|
544
|
-
"kind": "expression"
|
|
545
|
-
}
|
|
546
532
|
}
|
|
547
533
|
]
|
|
548
534
|
}
|