@vaadin/combo-box 24.5.3 → 24.5.4
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.5.
|
|
3
|
+
"version": "24.5.4",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -40,21 +40,21 @@
|
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
42
42
|
"@polymer/polymer": "^3.0.0",
|
|
43
|
-
"@vaadin/a11y-base": "~24.5.
|
|
44
|
-
"@vaadin/component-base": "~24.5.
|
|
45
|
-
"@vaadin/field-base": "~24.5.
|
|
46
|
-
"@vaadin/input-container": "~24.5.
|
|
47
|
-
"@vaadin/item": "~24.5.
|
|
48
|
-
"@vaadin/lit-renderer": "~24.5.
|
|
49
|
-
"@vaadin/overlay": "~24.5.
|
|
50
|
-
"@vaadin/vaadin-lumo-styles": "~24.5.
|
|
51
|
-
"@vaadin/vaadin-material-styles": "~24.5.
|
|
52
|
-
"@vaadin/vaadin-themable-mixin": "~24.5.
|
|
43
|
+
"@vaadin/a11y-base": "~24.5.4",
|
|
44
|
+
"@vaadin/component-base": "~24.5.4",
|
|
45
|
+
"@vaadin/field-base": "~24.5.4",
|
|
46
|
+
"@vaadin/input-container": "~24.5.4",
|
|
47
|
+
"@vaadin/item": "~24.5.4",
|
|
48
|
+
"@vaadin/lit-renderer": "~24.5.4",
|
|
49
|
+
"@vaadin/overlay": "~24.5.4",
|
|
50
|
+
"@vaadin/vaadin-lumo-styles": "~24.5.4",
|
|
51
|
+
"@vaadin/vaadin-material-styles": "~24.5.4",
|
|
52
|
+
"@vaadin/vaadin-themable-mixin": "~24.5.4"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@vaadin/chai-plugins": "~24.5.
|
|
55
|
+
"@vaadin/chai-plugins": "~24.5.4",
|
|
56
56
|
"@vaadin/testing-helpers": "^1.0.0",
|
|
57
|
-
"@vaadin/text-field": "~24.5.
|
|
57
|
+
"@vaadin/text-field": "~24.5.4",
|
|
58
58
|
"lit": "^3.0.0",
|
|
59
59
|
"sinon": "^18.0.0"
|
|
60
60
|
},
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"web-types.json",
|
|
63
63
|
"web-types.lit.json"
|
|
64
64
|
],
|
|
65
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "0993b6e95bd5826642065356b8f5854a65a6b677"
|
|
66
66
|
}
|
|
@@ -110,7 +110,7 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
110
110
|
this.__dataProviderInitialized = true;
|
|
111
111
|
|
|
112
112
|
if (this.dataProvider) {
|
|
113
|
-
this.
|
|
113
|
+
this.__synchronizeControllerState();
|
|
114
114
|
}
|
|
115
115
|
}
|
|
116
116
|
|
|
@@ -166,7 +166,7 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
166
166
|
const { rootCache } = this.__dataProviderController;
|
|
167
167
|
rootCache.items = [...rootCache.items];
|
|
168
168
|
|
|
169
|
-
this.
|
|
169
|
+
this.__synchronizeControllerState();
|
|
170
170
|
|
|
171
171
|
if (!this.opened && !this._isInputFocused()) {
|
|
172
172
|
this._commitValue();
|
|
@@ -183,7 +183,7 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
183
183
|
|
|
184
184
|
this.__dataProviderController.clearCache();
|
|
185
185
|
|
|
186
|
-
this.
|
|
186
|
+
this.__synchronizeControllerState();
|
|
187
187
|
|
|
188
188
|
if (this._shouldFetchData()) {
|
|
189
189
|
this._forceNextRequest = false;
|
|
@@ -206,7 +206,7 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
206
206
|
// The controller adds new placeholders to the cache through mutation,
|
|
207
207
|
// so we need to create a new array to trigger filteredItems observers.
|
|
208
208
|
rootCache.items = [...rootCache.items];
|
|
209
|
-
this.
|
|
209
|
+
this.__synchronizeControllerState();
|
|
210
210
|
}
|
|
211
211
|
}
|
|
212
212
|
|
|
@@ -224,7 +224,7 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
224
224
|
const { rootCache } = this.__dataProviderController;
|
|
225
225
|
if (rootCache.items !== items) {
|
|
226
226
|
rootCache.items = items;
|
|
227
|
-
this.
|
|
227
|
+
this.__synchronizeControllerState();
|
|
228
228
|
}
|
|
229
229
|
}
|
|
230
230
|
}
|
|
@@ -232,11 +232,11 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
232
232
|
/**
|
|
233
233
|
* Synchronizes the controller's state with the component, which can be
|
|
234
234
|
* out of sync after the controller receives new data from the data provider
|
|
235
|
-
* or if the state in the controller is directly
|
|
235
|
+
* or if the state in the controller is directly manipulated.
|
|
236
236
|
*
|
|
237
|
-
* @
|
|
237
|
+
* @private
|
|
238
238
|
*/
|
|
239
|
-
|
|
239
|
+
__synchronizeControllerState() {
|
|
240
240
|
// When the data provider isn't initialized, it means the content update was requested
|
|
241
241
|
// by an observer before the `ready()` callback. In such cases, some properties
|
|
242
242
|
// in the data provider controller might still be uninitialized, so it's not safe
|
|
@@ -248,8 +248,6 @@ export const ComboBoxDataProviderMixin = (superClass) =>
|
|
|
248
248
|
this.filteredItems = rootCache.items;
|
|
249
249
|
this.loading = this.__dataProviderController.isLoading();
|
|
250
250
|
}
|
|
251
|
-
|
|
252
|
-
super.requestContentUpdate();
|
|
253
251
|
}
|
|
254
252
|
|
|
255
253
|
/** @private */
|
|
@@ -97,7 +97,7 @@ export const ComboBoxItemMixin = (superClass) =>
|
|
|
97
97
|
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
98
98
|
*/
|
|
99
99
|
requestContentUpdate() {
|
|
100
|
-
if (!this.renderer) {
|
|
100
|
+
if (!this.renderer || this.hidden) {
|
|
101
101
|
return;
|
|
102
102
|
}
|
|
103
103
|
|
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.5.
|
|
4
|
+
"version": "24.5.4",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -471,7 +471,7 @@
|
|
|
471
471
|
},
|
|
472
472
|
{
|
|
473
473
|
"name": "vaadin-combo-box",
|
|
474
|
-
"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.5.
|
|
474
|
+
"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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.4/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.4/#/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.",
|
|
475
475
|
"attributes": [
|
|
476
476
|
{
|
|
477
477
|
"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.5.
|
|
4
|
+
"version": "24.5.4",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -254,7 +254,7 @@
|
|
|
254
254
|
},
|
|
255
255
|
{
|
|
256
256
|
"name": "vaadin-combo-box",
|
|
257
|
-
"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.5.
|
|
257
|
+
"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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/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.5.4/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.4/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.4/#/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.",
|
|
258
258
|
"extension": true,
|
|
259
259
|
"attributes": [
|
|
260
260
|
{
|