@vaadin/combo-box 24.9.0-alpha2 → 24.9.0-beta1
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 +15 -15
- package/src/vaadin-combo-box.d.ts +25 -12
- package/src/vaadin-combo-box.js +25 -12
- 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.9.0-
|
|
3
|
+
"version": "24.9.0-beta1",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -38,28 +38,28 @@
|
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
40
40
|
"@polymer/polymer": "^3.0.0",
|
|
41
|
-
"@vaadin/a11y-base": "24.9.0-
|
|
42
|
-
"@vaadin/component-base": "24.9.0-
|
|
43
|
-
"@vaadin/field-base": "24.9.0-
|
|
44
|
-
"@vaadin/input-container": "24.9.0-
|
|
45
|
-
"@vaadin/item": "24.9.0-
|
|
46
|
-
"@vaadin/lit-renderer": "24.9.0-
|
|
47
|
-
"@vaadin/overlay": "24.9.0-
|
|
48
|
-
"@vaadin/vaadin-lumo-styles": "24.9.0-
|
|
49
|
-
"@vaadin/vaadin-material-styles": "24.9.0-
|
|
50
|
-
"@vaadin/vaadin-themable-mixin": "24.9.0-
|
|
41
|
+
"@vaadin/a11y-base": "24.9.0-beta1",
|
|
42
|
+
"@vaadin/component-base": "24.9.0-beta1",
|
|
43
|
+
"@vaadin/field-base": "24.9.0-beta1",
|
|
44
|
+
"@vaadin/input-container": "24.9.0-beta1",
|
|
45
|
+
"@vaadin/item": "24.9.0-beta1",
|
|
46
|
+
"@vaadin/lit-renderer": "24.9.0-beta1",
|
|
47
|
+
"@vaadin/overlay": "24.9.0-beta1",
|
|
48
|
+
"@vaadin/vaadin-lumo-styles": "24.9.0-beta1",
|
|
49
|
+
"@vaadin/vaadin-material-styles": "24.9.0-beta1",
|
|
50
|
+
"@vaadin/vaadin-themable-mixin": "24.9.0-beta1",
|
|
51
51
|
"lit": "^3.0.0"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@vaadin/chai-plugins": "24.9.0-
|
|
55
|
-
"@vaadin/test-runner-commands": "24.9.0-
|
|
54
|
+
"@vaadin/chai-plugins": "24.9.0-beta1",
|
|
55
|
+
"@vaadin/test-runner-commands": "24.9.0-beta1",
|
|
56
56
|
"@vaadin/testing-helpers": "^1.1.0",
|
|
57
|
-
"@vaadin/text-field": "24.9.0-
|
|
57
|
+
"@vaadin/text-field": "24.9.0-beta1",
|
|
58
58
|
"sinon": "^18.0.0"
|
|
59
59
|
},
|
|
60
60
|
"web-types": [
|
|
61
61
|
"web-types.json",
|
|
62
62
|
"web-types.lit.json"
|
|
63
63
|
],
|
|
64
|
-
"gitHead": "
|
|
64
|
+
"gitHead": "5f6e6e33217fef06e5d5cc52baa4d760969ef1e4"
|
|
65
65
|
}
|
|
@@ -174,21 +174,34 @@ export interface ComboBoxEventMap<TItem> extends HTMLElementEventMap {
|
|
|
174
174
|
* `--vaadin-combo-box-overlay-width` | Width of the overlay | `auto`
|
|
175
175
|
* `--vaadin-combo-box-overlay-max-height` | Max height of the overlay | `65vh`
|
|
176
176
|
*
|
|
177
|
-
*
|
|
178
|
-
* See [`<vaadin-text-field>`](#/elements/vaadin-text-field) for the styling documentation.
|
|
177
|
+
* The following shadow DOM parts are available for styling:
|
|
179
178
|
*
|
|
180
|
-
*
|
|
179
|
+
* Part name | Description
|
|
180
|
+
* ---------------------|----------------
|
|
181
|
+
* `label` | The label element
|
|
182
|
+
* `input-field` | The element that wraps prefix, value and buttons
|
|
183
|
+
* `clear-button` | The clear button
|
|
184
|
+
* `error-message` | The error message element
|
|
185
|
+
* `helper-text` | The helper text element wrapper
|
|
186
|
+
* `required-indicator` | The `required` state indicator element
|
|
187
|
+
* `toggle-button` | The toggle button
|
|
181
188
|
*
|
|
182
|
-
*
|
|
183
|
-
* ----------------|----------------
|
|
184
|
-
* `toggle-button` | The toggle button
|
|
189
|
+
* The following state attributes are available for styling:
|
|
185
190
|
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
* `
|
|
191
|
-
* `
|
|
191
|
+
* Attribute | Description
|
|
192
|
+
* ---------------------|---------------------------------
|
|
193
|
+
* `disabled` | Set when the element is disabled
|
|
194
|
+
* `has-value` | Set when the element has a value
|
|
195
|
+
* `has-label` | Set when the element has a label
|
|
196
|
+
* `has-helper` | Set when the element has helper text or slot
|
|
197
|
+
* `has-error-message` | Set when the element has an error message
|
|
198
|
+
* `has-tooltip` | Set when the element has a slotted tooltip
|
|
199
|
+
* `invalid` | Set when the element is invalid
|
|
200
|
+
* `focused` | Set when the element is focused
|
|
201
|
+
* `focus-ring` | Set when the element is keyboard focused
|
|
202
|
+
* `readonly` | Set when the element is readonly
|
|
203
|
+
* `opened` | Set when the overlay is opened
|
|
204
|
+
* `loading` | Set when loading items from the data provider
|
|
192
205
|
*
|
|
193
206
|
* If you want to replace the default `<input>` and its container with a custom implementation to get full control
|
|
194
207
|
* over the input field, consider using the [`<vaadin-combo-box-light>`](#/elements/vaadin-combo-box-light) element.
|
package/src/vaadin-combo-box.js
CHANGED
|
@@ -105,21 +105,34 @@ registerStyles('vaadin-combo-box', inputFieldShared, { moduleId: 'vaadin-combo-b
|
|
|
105
105
|
* `--vaadin-combo-box-overlay-width` | Width of the overlay | `auto`
|
|
106
106
|
* `--vaadin-combo-box-overlay-max-height` | Max height of the overlay | `65vh`
|
|
107
107
|
*
|
|
108
|
-
*
|
|
109
|
-
* See [`<vaadin-text-field>`](#/elements/vaadin-text-field) for the styling documentation.
|
|
108
|
+
* The following shadow DOM parts are available for styling:
|
|
110
109
|
*
|
|
111
|
-
*
|
|
110
|
+
* Part name | Description
|
|
111
|
+
* ---------------------|----------------
|
|
112
|
+
* `label` | The label element
|
|
113
|
+
* `input-field` | The element that wraps prefix, value and buttons
|
|
114
|
+
* `clear-button` | The clear button
|
|
115
|
+
* `error-message` | The error message element
|
|
116
|
+
* `helper-text` | The helper text element wrapper
|
|
117
|
+
* `required-indicator` | The `required` state indicator element
|
|
118
|
+
* `toggle-button` | The toggle button
|
|
112
119
|
*
|
|
113
|
-
*
|
|
114
|
-
* ----------------|----------------
|
|
115
|
-
* `toggle-button` | The toggle button
|
|
120
|
+
* The following state attributes are available for styling:
|
|
116
121
|
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
* `
|
|
122
|
-
* `
|
|
122
|
+
* Attribute | Description
|
|
123
|
+
* ---------------------|---------------------------------
|
|
124
|
+
* `disabled` | Set when the element is disabled
|
|
125
|
+
* `has-value` | Set when the element has a value
|
|
126
|
+
* `has-label` | Set when the element has a label
|
|
127
|
+
* `has-helper` | Set when the element has helper text or slot
|
|
128
|
+
* `has-error-message` | Set when the element has an error message
|
|
129
|
+
* `has-tooltip` | Set when the element has a slotted tooltip
|
|
130
|
+
* `invalid` | Set when the element is invalid
|
|
131
|
+
* `focused` | Set when the element is focused
|
|
132
|
+
* `focus-ring` | Set when the element is keyboard focused
|
|
133
|
+
* `readonly` | Set when the element is readonly
|
|
134
|
+
* `opened` | Set when the overlay is opened
|
|
135
|
+
* `loading` | Set when loading items from the data provider
|
|
123
136
|
*
|
|
124
137
|
* If you want to replace the default `<input>` and its container with a custom implementation to get full control
|
|
125
138
|
* over the input field, consider using the [`<vaadin-combo-box-light>`](#/elements/vaadin-combo-box-light) element.
|
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.9.0-
|
|
4
|
+
"version": "24.9.0-beta1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -493,7 +493,7 @@
|
|
|
493
493
|
},
|
|
494
494
|
{
|
|
495
495
|
"name": "vaadin-combo-box",
|
|
496
|
-
"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.9.0-
|
|
496
|
+
"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.9.0-beta1/#/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.9.0-beta1/#/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.9.0-beta1/#/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\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The label element\n`input-field` | The element that wraps prefix, value and buttons\n`clear-button` | The clear button\n`error-message` | The error message element\n`helper-text` | The helper text element wrapper\n`required-indicator` | The `required` state indicator element\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`has-value` | Set when the element has a value\n`has-label` | Set when the element has a label\n`has-helper` | Set when the element has helper text or slot\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`focus-ring` | Set when the element is keyboard focused\n`readonly` | Set when the element is readonly\n`opened` | Set when the overlay is opened\n`loading` | Set when loading items from the data provider\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.9.0-beta1/#/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.9.0-beta1/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.9.0-beta1/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.9.0-beta1/#/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.",
|
|
497
497
|
"attributes": [
|
|
498
498
|
{
|
|
499
499
|
"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.9.0-
|
|
4
|
+
"version": "24.9.0-beta1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -261,7 +261,7 @@
|
|
|
261
261
|
},
|
|
262
262
|
{
|
|
263
263
|
"name": "vaadin-combo-box",
|
|
264
|
-
"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.9.0-
|
|
264
|
+
"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.9.0-beta1/#/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.9.0-beta1/#/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.9.0-beta1/#/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\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The label element\n`input-field` | The element that wraps prefix, value and buttons\n`clear-button` | The clear button\n`error-message` | The error message element\n`helper-text` | The helper text element wrapper\n`required-indicator` | The `required` state indicator element\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`has-value` | Set when the element has a value\n`has-label` | Set when the element has a label\n`has-helper` | Set when the element has helper text or slot\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`focus-ring` | Set when the element is keyboard focused\n`readonly` | Set when the element is readonly\n`opened` | Set when the overlay is opened\n`loading` | Set when loading items from the data provider\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.9.0-beta1/#/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.9.0-beta1/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.9.0-beta1/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.9.0-beta1/#/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.",
|
|
265
265
|
"extension": true,
|
|
266
266
|
"attributes": [
|
|
267
267
|
{
|