@vaadin/combo-box 23.2.0-alpha5 → 23.2.0-alpha6
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-light.js +39 -6
- package/src/vaadin-combo-box-mixin.js +22 -9
- package/web-types.json +2 -2
- package/web-types.lit.json +2 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/combo-box",
|
|
3
|
-
"version": "23.2.0-
|
|
3
|
+
"version": "23.2.0-alpha6",
|
|
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.2.0-
|
|
42
|
-
"@vaadin/field-base": "23.2.0-
|
|
43
|
-
"@vaadin/input-container": "23.2.0-
|
|
44
|
-
"@vaadin/item": "23.2.0-
|
|
45
|
-
"@vaadin/lit-renderer": "23.2.0-
|
|
46
|
-
"@vaadin/vaadin-lumo-styles": "23.2.0-
|
|
47
|
-
"@vaadin/vaadin-material-styles": "23.2.0-
|
|
48
|
-
"@vaadin/vaadin-overlay": "23.2.0-
|
|
49
|
-
"@vaadin/vaadin-themable-mixin": "23.2.0-
|
|
41
|
+
"@vaadin/component-base": "23.2.0-alpha6",
|
|
42
|
+
"@vaadin/field-base": "23.2.0-alpha6",
|
|
43
|
+
"@vaadin/input-container": "23.2.0-alpha6",
|
|
44
|
+
"@vaadin/item": "23.2.0-alpha6",
|
|
45
|
+
"@vaadin/lit-renderer": "23.2.0-alpha6",
|
|
46
|
+
"@vaadin/vaadin-lumo-styles": "23.2.0-alpha6",
|
|
47
|
+
"@vaadin/vaadin-material-styles": "23.2.0-alpha6",
|
|
48
|
+
"@vaadin/vaadin-overlay": "23.2.0-alpha6",
|
|
49
|
+
"@vaadin/vaadin-themable-mixin": "23.2.0-alpha6"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@esm-bundle/chai": "^4.3.4",
|
|
53
|
-
"@vaadin/polymer-legacy-adapter": "23.2.0-
|
|
53
|
+
"@vaadin/polymer-legacy-adapter": "23.2.0-alpha6",
|
|
54
54
|
"@vaadin/testing-helpers": "^0.3.2",
|
|
55
|
-
"@vaadin/text-field": "23.2.0-
|
|
55
|
+
"@vaadin/text-field": "23.2.0-alpha6",
|
|
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": "61f1fb56953434e97d34a8819640064301dd3d8a"
|
|
64
64
|
}
|
|
@@ -7,6 +7,7 @@ import './vaadin-combo-box-item.js';
|
|
|
7
7
|
import './vaadin-combo-box-overlay.js';
|
|
8
8
|
import './vaadin-combo-box-scroller.js';
|
|
9
9
|
import { dashToCamelCase } from '@polymer/polymer/lib/utils/case-map.js';
|
|
10
|
+
import { afterNextRender } from '@polymer/polymer/lib/utils/render-status.js';
|
|
10
11
|
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
|
|
11
12
|
import { ValidateMixin } from '@vaadin/field-base/src/validate-mixin.js';
|
|
12
13
|
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
|
|
@@ -119,14 +120,14 @@ class ComboBoxLight extends ComboBoxDataProviderMixin(ComboBoxMixin(ValidateMixi
|
|
|
119
120
|
/** @protected */
|
|
120
121
|
ready() {
|
|
121
122
|
super.ready();
|
|
123
|
+
|
|
122
124
|
this._toggleElement = this.querySelector('.toggle-button');
|
|
123
|
-
}
|
|
124
125
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
126
|
+
// Wait until the slotted input DOM is ready
|
|
127
|
+
afterNextRender(this, () => {
|
|
128
|
+
this._setInputElement(this.querySelector('vaadin-text-field,.input'));
|
|
129
|
+
this._revertInputValue();
|
|
130
|
+
});
|
|
130
131
|
}
|
|
131
132
|
|
|
132
133
|
/**
|
|
@@ -148,6 +149,38 @@ class ComboBoxLight extends ComboBoxDataProviderMixin(ComboBoxMixin(ValidateMixi
|
|
|
148
149
|
return dashToCamelCase(this.attrForValue);
|
|
149
150
|
}
|
|
150
151
|
|
|
152
|
+
/**
|
|
153
|
+
* @protected
|
|
154
|
+
* @override
|
|
155
|
+
* @return {HTMLInputElement | undefined}
|
|
156
|
+
*/
|
|
157
|
+
get _nativeInput() {
|
|
158
|
+
const input = this.inputElement;
|
|
159
|
+
|
|
160
|
+
if (input) {
|
|
161
|
+
// Support `<input class="input">`
|
|
162
|
+
if (input instanceof HTMLInputElement) {
|
|
163
|
+
return input;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// Support `<input>` in light DOM (e.g. `vaadin-text-field`)
|
|
167
|
+
const slottedInput = input.querySelector('input');
|
|
168
|
+
if (slottedInput) {
|
|
169
|
+
return slottedInput;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
if (input.shadowRoot) {
|
|
173
|
+
// Support `<input>` in Shadow DOM (e.g. `mwc-textfield`)
|
|
174
|
+
const shadowInput = input.shadowRoot.querySelector('input');
|
|
175
|
+
if (shadowInput) {
|
|
176
|
+
return shadowInput;
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
return undefined;
|
|
182
|
+
}
|
|
183
|
+
|
|
151
184
|
/** @protected */
|
|
152
185
|
_isClearButton(event) {
|
|
153
186
|
return (
|
|
@@ -280,14 +280,26 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
282
|
|
|
283
|
+
/**
|
|
284
|
+
* Get a reference to the native `<input>` element.
|
|
285
|
+
* Override to provide a custom input.
|
|
286
|
+
* @protected
|
|
287
|
+
* @return {HTMLInputElement | undefined}
|
|
288
|
+
*/
|
|
289
|
+
get _nativeInput() {
|
|
290
|
+
return this.inputElement;
|
|
291
|
+
}
|
|
292
|
+
|
|
283
293
|
/**
|
|
284
294
|
* Override method inherited from `InputMixin`
|
|
285
295
|
* to customize the input element.
|
|
286
296
|
* @protected
|
|
287
297
|
* @override
|
|
288
298
|
*/
|
|
289
|
-
_inputElementChanged(
|
|
290
|
-
super._inputElementChanged(
|
|
299
|
+
_inputElementChanged(inputElement) {
|
|
300
|
+
super._inputElementChanged(inputElement);
|
|
301
|
+
|
|
302
|
+
const input = this._nativeInput;
|
|
291
303
|
|
|
292
304
|
if (input) {
|
|
293
305
|
input.autocomplete = 'off';
|
|
@@ -472,11 +484,6 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
472
484
|
}
|
|
473
485
|
}
|
|
474
486
|
|
|
475
|
-
/** @protected */
|
|
476
|
-
_isOverlayHidden(items, loading) {
|
|
477
|
-
return !loading && !(items && items.length);
|
|
478
|
-
}
|
|
479
|
-
|
|
480
487
|
/** @private */
|
|
481
488
|
_openedOrItemsChanged(opened, items, loading) {
|
|
482
489
|
// Close the overlay if there are no items to display.
|
|
@@ -512,7 +519,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
512
519
|
|
|
513
520
|
/** @private */
|
|
514
521
|
_updateActiveDescendant(index) {
|
|
515
|
-
const input = this.
|
|
522
|
+
const input = this._nativeInput;
|
|
516
523
|
if (!input) {
|
|
517
524
|
return;
|
|
518
525
|
}
|
|
@@ -548,7 +555,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
548
555
|
}
|
|
549
556
|
}
|
|
550
557
|
|
|
551
|
-
const input = this.
|
|
558
|
+
const input = this._nativeInput;
|
|
552
559
|
if (input) {
|
|
553
560
|
input.setAttribute('aria-expanded', !!opened);
|
|
554
561
|
|
|
@@ -1257,6 +1264,12 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
1257
1264
|
|
|
1258
1265
|
/** @private */
|
|
1259
1266
|
_onFocusout(event) {
|
|
1267
|
+
// VoiceOver on iOS fires `focusout` event when moving focus to the item in the dropdown.
|
|
1268
|
+
// Do not focus the input in this case, because it would break announcement for the item.
|
|
1269
|
+
if (event.relatedTarget && event.relatedTarget.localName === `${this._tagNamePrefix}-item`) {
|
|
1270
|
+
return;
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1260
1273
|
// Fixes the problem with `focusout` happening when clicking on the scroll bar on Edge
|
|
1261
1274
|
if (event.relatedTarget === this.$.overlay) {
|
|
1262
1275
|
event.composedPath()[0].focus();
|
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.0-
|
|
4
|
+
"version": "23.2.0-alpha6",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -382,7 +382,7 @@
|
|
|
382
382
|
},
|
|
383
383
|
{
|
|
384
384
|
"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.0-
|
|
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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha6/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha6/#/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/ds/customization/styling-components) documentation.",
|
|
386
386
|
"attributes": [
|
|
387
387
|
{
|
|
388
388
|
"name": "disabled",
|
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.0-
|
|
4
|
+
"version": "23.2.0-alpha6",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -205,7 +205,7 @@
|
|
|
205
205
|
},
|
|
206
206
|
{
|
|
207
207
|
"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.0-
|
|
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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/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.0-alpha6/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha6/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha6/#/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/ds/customization/styling-components) documentation.",
|
|
209
209
|
"extension": true,
|
|
210
210
|
"attributes": [
|
|
211
211
|
{
|