@vaadin/combo-box 24.3.0-alpha4 → 24.3.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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/combo-box",
|
|
3
|
-
"version": "24.3.0-
|
|
3
|
+
"version": "24.3.0-alpha6",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -38,27 +38,27 @@
|
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
40
40
|
"@polymer/polymer": "^3.0.0",
|
|
41
|
-
"@vaadin/a11y-base": "24.3.0-
|
|
42
|
-
"@vaadin/component-base": "24.3.0-
|
|
43
|
-
"@vaadin/field-base": "24.3.0-
|
|
44
|
-
"@vaadin/input-container": "24.3.0-
|
|
45
|
-
"@vaadin/item": "24.3.0-
|
|
46
|
-
"@vaadin/lit-renderer": "24.3.0-
|
|
47
|
-
"@vaadin/overlay": "24.3.0-
|
|
48
|
-
"@vaadin/vaadin-lumo-styles": "24.3.0-
|
|
49
|
-
"@vaadin/vaadin-material-styles": "24.3.0-
|
|
50
|
-
"@vaadin/vaadin-themable-mixin": "24.3.0-
|
|
41
|
+
"@vaadin/a11y-base": "24.3.0-alpha6",
|
|
42
|
+
"@vaadin/component-base": "24.3.0-alpha6",
|
|
43
|
+
"@vaadin/field-base": "24.3.0-alpha6",
|
|
44
|
+
"@vaadin/input-container": "24.3.0-alpha6",
|
|
45
|
+
"@vaadin/item": "24.3.0-alpha6",
|
|
46
|
+
"@vaadin/lit-renderer": "24.3.0-alpha6",
|
|
47
|
+
"@vaadin/overlay": "24.3.0-alpha6",
|
|
48
|
+
"@vaadin/vaadin-lumo-styles": "24.3.0-alpha6",
|
|
49
|
+
"@vaadin/vaadin-material-styles": "24.3.0-alpha6",
|
|
50
|
+
"@vaadin/vaadin-themable-mixin": "24.3.0-alpha6"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@esm-bundle/chai": "^4.3.4",
|
|
54
|
-
"@vaadin/testing-helpers": "^0.
|
|
55
|
-
"@vaadin/text-field": "24.3.0-
|
|
56
|
-
"lit": "^
|
|
54
|
+
"@vaadin/testing-helpers": "^0.6.0",
|
|
55
|
+
"@vaadin/text-field": "24.3.0-alpha6",
|
|
56
|
+
"lit": "^3.0.0",
|
|
57
57
|
"sinon": "^13.0.2"
|
|
58
58
|
},
|
|
59
59
|
"web-types": [
|
|
60
60
|
"web-types.json",
|
|
61
61
|
"web-types.lit.json"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "2721ab38ba3bc7d38dc1241016915354617ff659"
|
|
64
64
|
}
|
|
@@ -234,6 +234,14 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
234
234
|
observer: '_toggleElementChanged',
|
|
235
235
|
},
|
|
236
236
|
|
|
237
|
+
/**
|
|
238
|
+
* Set of items to be rendered in the dropdown.
|
|
239
|
+
* @protected
|
|
240
|
+
*/
|
|
241
|
+
_dropdownItems: {
|
|
242
|
+
type: Array,
|
|
243
|
+
},
|
|
244
|
+
|
|
237
245
|
/** @private */
|
|
238
246
|
_closeOnBlurIsPrevented: Boolean,
|
|
239
247
|
|
|
@@ -251,8 +259,8 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
251
259
|
static get observers() {
|
|
252
260
|
return [
|
|
253
261
|
'_selectedItemChanged(selectedItem, itemValuePath, itemLabelPath)',
|
|
254
|
-
'_openedOrItemsChanged(opened,
|
|
255
|
-
'_updateScroller(_scroller,
|
|
262
|
+
'_openedOrItemsChanged(opened, _dropdownItems, loading)',
|
|
263
|
+
'_updateScroller(_scroller, _dropdownItems, opened, loading, selectedItem, itemIdPath, _focusedIndex, renderer, theme)',
|
|
256
264
|
];
|
|
257
265
|
}
|
|
258
266
|
|
|
@@ -491,7 +499,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
491
499
|
this.dispatchEvent(new CustomEvent('vaadin-combo-box-dropdown-opened', { bubbles: true, composed: true }));
|
|
492
500
|
|
|
493
501
|
this._onOpened();
|
|
494
|
-
} else if (wasOpened && this.
|
|
502
|
+
} else if (wasOpened && this._dropdownItems && this._dropdownItems.length) {
|
|
495
503
|
this.close();
|
|
496
504
|
|
|
497
505
|
this.dispatchEvent(new CustomEvent('vaadin-combo-box-dropdown-closed', { bubbles: true, composed: true }));
|
|
@@ -681,7 +689,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
681
689
|
/** @private */
|
|
682
690
|
_onArrowDown() {
|
|
683
691
|
if (this.opened) {
|
|
684
|
-
const items = this.
|
|
692
|
+
const items = this._dropdownItems;
|
|
685
693
|
if (items) {
|
|
686
694
|
this._focusedIndex = Math.min(items.length - 1, this._focusedIndex + 1);
|
|
687
695
|
this._prefillFocusedItemLabel();
|
|
@@ -697,7 +705,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
697
705
|
if (this._focusedIndex > -1) {
|
|
698
706
|
this._focusedIndex = Math.max(0, this._focusedIndex - 1);
|
|
699
707
|
} else {
|
|
700
|
-
const items = this.
|
|
708
|
+
const items = this._dropdownItems;
|
|
701
709
|
if (items) {
|
|
702
710
|
this._focusedIndex = items.length - 1;
|
|
703
711
|
}
|
|
@@ -712,7 +720,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
712
720
|
/** @private */
|
|
713
721
|
_prefillFocusedItemLabel() {
|
|
714
722
|
if (this._focusedIndex > -1) {
|
|
715
|
-
const focusedItem = this.
|
|
723
|
+
const focusedItem = this._dropdownItems[this._focusedIndex];
|
|
716
724
|
this._inputElementValue = this._getItemLabel(focusedItem);
|
|
717
725
|
this._markAllSelectionRange();
|
|
718
726
|
}
|
|
@@ -885,7 +893,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
885
893
|
/** @private */
|
|
886
894
|
_commitValue() {
|
|
887
895
|
if (this._focusedIndex > -1) {
|
|
888
|
-
const focusedItem = this.
|
|
896
|
+
const focusedItem = this._dropdownItems[this._focusedIndex];
|
|
889
897
|
if (this.selectedItem !== focusedItem) {
|
|
890
898
|
this.selectedItem = focusedItem;
|
|
891
899
|
}
|
|
@@ -900,7 +908,7 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
900
908
|
}
|
|
901
909
|
} else {
|
|
902
910
|
// Try to find an item which label matches the input value.
|
|
903
|
-
const items = [...(this.
|
|
911
|
+
const items = [...(this._dropdownItems || []), this.selectedItem];
|
|
904
912
|
const itemMatchingInputValue = items[this.__getItemIndexByLabel(items, this._inputElementValue)];
|
|
905
913
|
|
|
906
914
|
if (
|
|
@@ -1115,6 +1123,8 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
1115
1123
|
|
|
1116
1124
|
/** @private */
|
|
1117
1125
|
_filteredItemsChanged(filteredItems, oldFilteredItems) {
|
|
1126
|
+
this._setDropdownItems(filteredItems);
|
|
1127
|
+
|
|
1118
1128
|
// Store the currently focused item if any. The focused index preserves
|
|
1119
1129
|
// in the case when more filtered items are loading but it is reset
|
|
1120
1130
|
// when the user types in a filter query.
|
|
@@ -1175,6 +1185,16 @@ export const ComboBoxMixin = (subclass) =>
|
|
|
1175
1185
|
}
|
|
1176
1186
|
}
|
|
1177
1187
|
|
|
1188
|
+
/**
|
|
1189
|
+
* Provide items to be rendered in the dropdown.
|
|
1190
|
+
* Override this method to show custom items.
|
|
1191
|
+
*
|
|
1192
|
+
* @protected
|
|
1193
|
+
*/
|
|
1194
|
+
_setDropdownItems(items) {
|
|
1195
|
+
this._dropdownItems = items;
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1178
1198
|
/** @private */
|
|
1179
1199
|
_getItemElements() {
|
|
1180
1200
|
return Array.from(this._scroller.querySelectorAll(`${this._tagNamePrefix}-item`));
|
|
@@ -9,11 +9,13 @@ const comboBoxItem = css`
|
|
|
9
9
|
transition: background-color 100ms;
|
|
10
10
|
overflow: hidden;
|
|
11
11
|
--_lumo-item-selected-icon-display: block;
|
|
12
|
+
--_focus-ring-color: var(--vaadin-focus-ring-color, var(--lumo-primary-color-50pct));
|
|
13
|
+
--_focus-ring-width: var(--vaadin-focus-ring-width, 2px);
|
|
12
14
|
}
|
|
13
15
|
|
|
14
16
|
@media (any-hover: hover) {
|
|
15
17
|
:host([focused]:not([disabled])) {
|
|
16
|
-
box-shadow: inset 0 0 0
|
|
18
|
+
box-shadow: inset 0 0 0 var(--_focus-ring-width) var(--_focus-ring-color);
|
|
17
19
|
}
|
|
18
20
|
}
|
|
19
21
|
`;
|
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.3.0-
|
|
4
|
+
"version": "24.3.0-alpha6",
|
|
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.3.0-
|
|
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.3.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/24.3.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/24.3.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```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.3.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/24.3.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/24.3.0-alpha6/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.3.0-alpha6/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.3.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/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.3.0-
|
|
4
|
+
"version": "24.3.0-alpha6",
|
|
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.3.0-
|
|
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.3.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/24.3.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/24.3.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```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.3.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/24.3.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/24.3.0-alpha6/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.3.0-alpha6/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.3.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/styling/styling-components) documentation.",
|
|
251
251
|
"extension": true,
|
|
252
252
|
"attributes": [
|
|
253
253
|
{
|