@vaadin/combo-box 24.1.13 → 24.1.15
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-mixin.js +28 -8
- 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": "24.1.
|
|
3
|
+
"version": "24.1.15",
|
|
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/a11y-base": "~24.1.
|
|
42
|
-
"@vaadin/component-base": "~24.1.
|
|
43
|
-
"@vaadin/field-base": "~24.1.
|
|
44
|
-
"@vaadin/input-container": "~24.1.
|
|
45
|
-
"@vaadin/item": "~24.1.
|
|
46
|
-
"@vaadin/lit-renderer": "~24.1.
|
|
47
|
-
"@vaadin/overlay": "~24.1.
|
|
48
|
-
"@vaadin/vaadin-lumo-styles": "~24.1.
|
|
49
|
-
"@vaadin/vaadin-material-styles": "~24.1.
|
|
50
|
-
"@vaadin/vaadin-themable-mixin": "~24.1.
|
|
41
|
+
"@vaadin/a11y-base": "~24.1.15",
|
|
42
|
+
"@vaadin/component-base": "~24.1.15",
|
|
43
|
+
"@vaadin/field-base": "~24.1.15",
|
|
44
|
+
"@vaadin/input-container": "~24.1.15",
|
|
45
|
+
"@vaadin/item": "~24.1.15",
|
|
46
|
+
"@vaadin/lit-renderer": "~24.1.15",
|
|
47
|
+
"@vaadin/overlay": "~24.1.15",
|
|
48
|
+
"@vaadin/vaadin-lumo-styles": "~24.1.15",
|
|
49
|
+
"@vaadin/vaadin-material-styles": "~24.1.15",
|
|
50
|
+
"@vaadin/vaadin-themable-mixin": "~24.1.15"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@esm-bundle/chai": "^4.3.4",
|
|
54
54
|
"@vaadin/testing-helpers": "^0.4.2",
|
|
55
|
-
"@vaadin/text-field": "~24.1.
|
|
55
|
+
"@vaadin/text-field": "~24.1.15",
|
|
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": "9cf98ac30128388bee2710410afe01a6b725b0aa"
|
|
64
64
|
}
|
|
@@ -229,6 +229,14 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
229
229
|
observer: '_toggleElementChanged',
|
|
230
230
|
},
|
|
231
231
|
|
|
232
|
+
/**
|
|
233
|
+
* Set of items to be rendered in the dropdown.
|
|
234
|
+
* @protected
|
|
235
|
+
*/
|
|
236
|
+
_dropdownItems: {
|
|
237
|
+
type: Array,
|
|
238
|
+
},
|
|
239
|
+
|
|
232
240
|
/** @private */
|
|
233
241
|
_closeOnBlurIsPrevented: Boolean,
|
|
234
242
|
|
|
@@ -246,8 +254,8 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
246
254
|
static get observers() {
|
|
247
255
|
return [
|
|
248
256
|
'_selectedItemChanged(selectedItem, itemValuePath, itemLabelPath)',
|
|
249
|
-
'_openedOrItemsChanged(opened,
|
|
250
|
-
'_updateScroller(_scroller,
|
|
257
|
+
'_openedOrItemsChanged(opened, _dropdownItems, loading)',
|
|
258
|
+
'_updateScroller(_scroller, _dropdownItems, opened, loading, selectedItem, itemIdPath, _focusedIndex, renderer, theme)',
|
|
251
259
|
];
|
|
252
260
|
}
|
|
253
261
|
|
|
@@ -489,7 +497,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
489
497
|
this.dispatchEvent(new CustomEvent('vaadin-combo-box-dropdown-opened', { bubbles: true, composed: true }));
|
|
490
498
|
|
|
491
499
|
this._onOpened();
|
|
492
|
-
} else if (wasOpened && this.
|
|
500
|
+
} else if (wasOpened && this._dropdownItems && this._dropdownItems.length) {
|
|
493
501
|
this.close();
|
|
494
502
|
|
|
495
503
|
this.dispatchEvent(new CustomEvent('vaadin-combo-box-dropdown-closed', { bubbles: true, composed: true }));
|
|
@@ -679,7 +687,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
679
687
|
/** @private */
|
|
680
688
|
_onArrowDown() {
|
|
681
689
|
if (this.opened) {
|
|
682
|
-
const items = this.
|
|
690
|
+
const items = this._dropdownItems;
|
|
683
691
|
if (items) {
|
|
684
692
|
this._focusedIndex = Math.min(items.length - 1, this._focusedIndex + 1);
|
|
685
693
|
this._prefillFocusedItemLabel();
|
|
@@ -695,7 +703,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
695
703
|
if (this._focusedIndex > -1) {
|
|
696
704
|
this._focusedIndex = Math.max(0, this._focusedIndex - 1);
|
|
697
705
|
} else {
|
|
698
|
-
const items = this.
|
|
706
|
+
const items = this._dropdownItems;
|
|
699
707
|
if (items) {
|
|
700
708
|
this._focusedIndex = items.length - 1;
|
|
701
709
|
}
|
|
@@ -710,7 +718,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
710
718
|
/** @private */
|
|
711
719
|
_prefillFocusedItemLabel() {
|
|
712
720
|
if (this._focusedIndex > -1) {
|
|
713
|
-
const focusedItem = this.
|
|
721
|
+
const focusedItem = this._dropdownItems[this._focusedIndex];
|
|
714
722
|
this._inputElementValue = this._getItemLabel(focusedItem);
|
|
715
723
|
this._markAllSelectionRange();
|
|
716
724
|
}
|
|
@@ -883,7 +891,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
883
891
|
/** @private */
|
|
884
892
|
_commitValue() {
|
|
885
893
|
if (this._focusedIndex > -1) {
|
|
886
|
-
const focusedItem = this.
|
|
894
|
+
const focusedItem = this._dropdownItems[this._focusedIndex];
|
|
887
895
|
if (this.selectedItem !== focusedItem) {
|
|
888
896
|
this.selectedItem = focusedItem;
|
|
889
897
|
}
|
|
@@ -898,7 +906,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
898
906
|
}
|
|
899
907
|
} else {
|
|
900
908
|
// Try to find an item which label matches the input value.
|
|
901
|
-
const items = [this.selectedItem, ...(this.
|
|
909
|
+
const items = [this.selectedItem, ...(this._dropdownItems || [])];
|
|
902
910
|
const itemMatchingInputValue = items[this.__getItemIndexByLabel(items, this._inputElementValue)];
|
|
903
911
|
|
|
904
912
|
if (
|
|
@@ -1107,6 +1115,8 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
1107
1115
|
|
|
1108
1116
|
/** @private */
|
|
1109
1117
|
_filteredItemsChanged(filteredItems, oldFilteredItems) {
|
|
1118
|
+
this._setDropdownItems(filteredItems);
|
|
1119
|
+
|
|
1110
1120
|
// Store the currently focused item if any. The focused index preserves
|
|
1111
1121
|
// in the case when more filtered items are loading but it is reset
|
|
1112
1122
|
// when the user types in a filter query.
|
|
@@ -1167,6 +1177,16 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
1167
1177
|
}
|
|
1168
1178
|
}
|
|
1169
1179
|
|
|
1180
|
+
/**
|
|
1181
|
+
* Provide items to be rendered in the dropdown.
|
|
1182
|
+
* Override this method to show custom items.
|
|
1183
|
+
*
|
|
1184
|
+
* @protected
|
|
1185
|
+
*/
|
|
1186
|
+
_setDropdownItems(items) {
|
|
1187
|
+
this._dropdownItems = items;
|
|
1188
|
+
}
|
|
1189
|
+
|
|
1170
1190
|
/** @private */
|
|
1171
1191
|
_getItemElements() {
|
|
1172
1192
|
return Array.from(this._scroller.querySelectorAll(`${this._tagNamePrefix}-item`));
|
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": "24.1.
|
|
4
|
+
"version": "24.1.15",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -460,7 +460,7 @@
|
|
|
460
460
|
},
|
|
461
461
|
{
|
|
462
462
|
"name": "vaadin-combo-box",
|
|
463
|
-
"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/24.1.
|
|
463
|
+
"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/24.1.15/#/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/24.1.15/#/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/24.1.15/#/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```js\ncomboBox.dataProvider = async (params, callback) => {\n const API = 'https://demo.vaadin.com/demo-data/1.0/filtered-countries';\n const { filter, page, pageSize } = params;\n const index = page * pageSize;\n\n const res = await fetch(`${API}?index=${index}&count=${pageSize}&filter=${filter}`);\n if (res.ok) {\n const { result, size } = await res.json();\n callback(result, size);\n }\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/24.1.15/#/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/24.1.15/#/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/24.1.15/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.1.15/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.1.15/#/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/styling-components) documentation.",
|
|
464
464
|
"attributes": [
|
|
465
465
|
{
|
|
466
466
|
"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": "24.1.
|
|
4
|
+
"version": "24.1.15",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -247,7 +247,7 @@
|
|
|
247
247
|
},
|
|
248
248
|
{
|
|
249
249
|
"name": "vaadin-combo-box",
|
|
250
|
-
"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/24.1.
|
|
250
|
+
"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/24.1.15/#/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/24.1.15/#/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/24.1.15/#/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```js\ncomboBox.dataProvider = async (params, callback) => {\n const API = 'https://demo.vaadin.com/demo-data/1.0/filtered-countries';\n const { filter, page, pageSize } = params;\n const index = page * pageSize;\n\n const res = await fetch(`${API}?index=${index}&count=${pageSize}&filter=${filter}`);\n if (res.ok) {\n const { result, size } = await res.json();\n callback(result, size);\n }\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/24.1.15/#/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/24.1.15/#/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/24.1.15/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.1.15/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.1.15/#/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/styling-components) documentation.",
|
|
251
251
|
"extension": true,
|
|
252
252
|
"attributes": [
|
|
253
253
|
{
|