Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@vaadin/combo-box
Advanced tools
@vaadin/combo-box - npm Package Compare versions
Comparing version 24.5.0-alpha1 to 24.5.0-alpha10
| { | ||
| "name": "@vaadin/combo-box", | ||
| "version": "24.5.0-alpha1", | ||
| "version": "24.5.0-alpha10", | ||
| "publishConfig": { | ||
@@ -43,19 +43,19 @@ "access": "public" | ||
| "@polymer/polymer": "^3.0.0", | ||
| "@vaadin/a11y-base": "24.5.0-alpha1", | ||
| "@vaadin/component-base": "24.5.0-alpha1", | ||
| "@vaadin/field-base": "24.5.0-alpha1", | ||
| "@vaadin/input-container": "24.5.0-alpha1", | ||
| "@vaadin/item": "24.5.0-alpha1", | ||
| "@vaadin/lit-renderer": "24.5.0-alpha1", | ||
| "@vaadin/overlay": "24.5.0-alpha1", | ||
| "@vaadin/vaadin-lumo-styles": "24.5.0-alpha1", | ||
| "@vaadin/vaadin-material-styles": "24.5.0-alpha1", | ||
| "@vaadin/vaadin-themable-mixin": "24.5.0-alpha1" | ||
| "@vaadin/a11y-base": "24.5.0-alpha10", | ||
| "@vaadin/component-base": "24.5.0-alpha10", | ||
| "@vaadin/field-base": "24.5.0-alpha10", | ||
| "@vaadin/input-container": "24.5.0-alpha10", | ||
| "@vaadin/item": "24.5.0-alpha10", | ||
| "@vaadin/lit-renderer": "24.5.0-alpha10", | ||
| "@vaadin/overlay": "24.5.0-alpha10", | ||
| "@vaadin/vaadin-lumo-styles": "24.5.0-alpha10", | ||
| "@vaadin/vaadin-material-styles": "24.5.0-alpha10", | ||
| "@vaadin/vaadin-themable-mixin": "24.5.0-alpha10" | ||
| }, | ||
| "devDependencies": { | ||
| "@esm-bundle/chai": "^4.3.4", | ||
| "@vaadin/testing-helpers": "^0.6.0", | ||
| "@vaadin/text-field": "24.5.0-alpha1", | ||
| "@vaadin/chai-plugins": "24.5.0-alpha10", | ||
| "@vaadin/testing-helpers": "^1.0.0", | ||
| "@vaadin/text-field": "24.5.0-alpha10", | ||
| "lit": "^3.0.0", | ||
| "sinon": "^13.0.2" | ||
| "sinon": "^18.0.0" | ||
| }, | ||
@@ -66,3 +66,3 @@ "web-types": [ | ||
| ], | ||
| "gitHead": "57806caac5468532a3b4e3dbdda730cd0fca193a" | ||
| "gitHead": "6f9c37308031af872a98017bfab4de89aeacda51" | ||
| } |
@@ -67,3 +67,3 @@ # @vaadin/combo-box | ||
| Read the [contributing guide](https://vaadin.com/docs/latest/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components. | ||
| Read the [contributing guide](https://vaadin.com/docs/latest/contributing) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components. | ||
@@ -70,0 +70,0 @@ ## License |
@@ -6,2 +6,3 @@ /** | ||
| */ | ||
| import { DataProviderController } from '@vaadin/component-base/src/data-provider-controller/data-provider-controller.js'; | ||
| import { ComboBoxPlaceholder } from './vaadin-combo-box-placeholder.js'; | ||
@@ -59,14 +60,8 @@ | ||
| /** @private */ | ||
| _pendingRequests: { | ||
| value: () => { | ||
| return {}; | ||
| }, | ||
| __dataProviderInitialized: { | ||
| type: Boolean, | ||
| value: false, | ||
| }, | ||
| /** @private */ | ||
| __placeHolder: { | ||
| value: new ComboBoxPlaceholder(), | ||
| }, | ||
| /** @private */ | ||
| __previousDataProviderFilter: { | ||
@@ -86,2 +81,19 @@ type: String, | ||
| constructor() { | ||
| super(); | ||
| /** | ||
| * @type {DataProviderController} | ||
| * @private | ||
| */ | ||
| this.__dataProviderController = new DataProviderController(this, { | ||
| placeholder: new ComboBoxPlaceholder(), | ||
| isPlaceholder: (item) => item instanceof ComboBoxPlaceholder, | ||
| dataProviderParams: () => ({ filter: this.filter }), | ||
| }); | ||
| this.__dataProviderController.addEventListener('page-requested', this.__onDataProviderPageRequested.bind(this)); | ||
| this.__dataProviderController.addEventListener('page-loaded', this.__onDataProviderPageLoaded.bind(this)); | ||
| } | ||
| /** @protected */ | ||
@@ -97,8 +109,11 @@ ready() { | ||
| if (index !== undefined) { | ||
| const page = this._getPageForIndex(index); | ||
| if (this._shouldLoadPage(page)) { | ||
| this._loadPage(page); | ||
| } | ||
| this.__dataProviderController.ensureFlatIndexLoaded(index); | ||
| } | ||
| }); | ||
| this.__dataProviderInitialized = true; | ||
| if (this.dataProvider) { | ||
| this.requestContentUpdate(); | ||
| } | ||
| } | ||
@@ -117,3 +132,2 @@ | ||
| this.__keepOverlayOpened = true; | ||
| this._pendingRequests = {}; | ||
| this.size = undefined; | ||
@@ -136,8 +150,11 @@ this.clearCache(); | ||
| _ensureFirstPage(opened) { | ||
| if (!this._shouldFetchData()) { | ||
| if (!this._shouldFetchData() || !opened) { | ||
| return; | ||
| } | ||
| if (opened && this._shouldLoadPage(0)) { | ||
| this._loadPage(0); | ||
| if (this._forceNextRequest || this.size === undefined) { | ||
| this._forceNextRequest = false; | ||
| this.__dataProviderController.loadFirstPage(); | ||
| } else if (this.size > 0) { | ||
| this.__dataProviderController.ensureFlatIndexLoaded(0); | ||
| } | ||
@@ -147,66 +164,20 @@ } | ||
| /** @private */ | ||
| _shouldLoadPage(page) { | ||
| if (this._forceNextRequest) { | ||
| this._forceNextRequest = false; | ||
| return true; | ||
| } | ||
| const loadedItem = this.filteredItems[page * this.pageSize]; | ||
| if (loadedItem !== undefined) { | ||
| return loadedItem instanceof ComboBoxPlaceholder; | ||
| } | ||
| return this.size === undefined; | ||
| __onDataProviderPageRequested() { | ||
| this.loading = true; | ||
| } | ||
| /** @private */ | ||
| _loadPage(page) { | ||
| // Make sure same page isn't requested multiple times. | ||
| if (this._pendingRequests[page] || !this.dataProvider) { | ||
| return; | ||
| } | ||
| __onDataProviderPageLoaded() { | ||
| // The controller adds new items to the cache through mutation, | ||
| // so we need to create a new array to trigger filteredItems observers. | ||
| const { rootCache } = this.__dataProviderController; | ||
| rootCache.items = [...rootCache.items]; | ||
| const params = { | ||
| page, | ||
| pageSize: this.pageSize, | ||
| filter: this.filter, | ||
| }; | ||
| this.requestContentUpdate(); | ||
| const callback = (items, size) => { | ||
| if (this._pendingRequests[page] !== callback) { | ||
| return; | ||
| } | ||
| const filteredItems = this.filteredItems ? [...this.filteredItems] : []; | ||
| filteredItems.splice(params.page * params.pageSize, items.length, ...items); | ||
| this.filteredItems = filteredItems; | ||
| if (!this.opened && !this._isInputFocused()) { | ||
| this._commitValue(); | ||
| } | ||
| if (size !== undefined) { | ||
| this.size = size; | ||
| } | ||
| delete this._pendingRequests[page]; | ||
| if (Object.keys(this._pendingRequests).length === 0) { | ||
| this.loading = false; | ||
| } | ||
| }; | ||
| this._pendingRequests[page] = callback; | ||
| // Set the `loading` flag only after marking the request as pending | ||
| // to prevent the same page from getting requested multiple times | ||
| // as a result of `__loadingChanged` in the scroller which requests | ||
| // a virtualizer update which in turn may trigger a data provider page request. | ||
| this.loading = true; | ||
| this.dataProvider(params, callback); | ||
| if (!this.opened && !this._isInputFocused()) { | ||
| this._commitValue(); | ||
| } | ||
| } | ||
| /** @private */ | ||
| _getPageForIndex(index) { | ||
| return Math.floor(index / this.pageSize); | ||
| } | ||
| /** | ||
@@ -220,12 +191,9 @@ * Clears the cached pages and reloads data from dataprovider when needed. | ||
| this._pendingRequests = {}; | ||
| const filteredItems = []; | ||
| for (let i = 0; i < (this.size || 0); i++) { | ||
| filteredItems.push(this.__placeHolder); | ||
| } | ||
| this.filteredItems = filteredItems; | ||
| this.__dataProviderController.clearCache(); | ||
| this.requestContentUpdate(); | ||
| if (this._shouldFetchData()) { | ||
| this._forceNextRequest = false; | ||
| this._loadPage(0); | ||
| this.__dataProviderController.loadFirstPage(); | ||
| } else { | ||
@@ -236,15 +204,61 @@ this._forceNextRequest = true; | ||
| /** @private */ | ||
| _sizeChanged(size = 0) { | ||
| const filteredItems = (this.filteredItems || []).slice(0, size); | ||
| for (let i = 0; i < size; i++) { | ||
| filteredItems[i] = filteredItems[i] !== undefined ? filteredItems[i] : this.__placeHolder; | ||
| /** | ||
| * When the size change originates externally, synchronizes the new size with | ||
| * the controller and request a content update to re-render the scroller. | ||
| * | ||
| * @private | ||
| */ | ||
| _sizeChanged(size) { | ||
| const { rootCache } = this.__dataProviderController; | ||
| if (rootCache.size !== size) { | ||
| rootCache.size = size; | ||
| // The controller adds new placeholders to the cache through mutation, | ||
| // so we need to create a new array to trigger filteredItems observers. | ||
| rootCache.items = [...rootCache.items]; | ||
| this.requestContentUpdate(); | ||
| } | ||
| this.filteredItems = filteredItems; | ||
| } | ||
| // Cleans up the redundant pending requests for pages > size | ||
| // Refers to https://github.com/vaadin/vaadin-flow-components/issues/229 | ||
| this._flushPendingRequests(size); | ||
| /** | ||
| * When the items change originates externally, synchronizes the new items with | ||
| * the controller and requests a content update to re-render the scroller. | ||
| * | ||
| * @private | ||
| * @override | ||
| */ | ||
| _filteredItemsChanged(items) { | ||
| super._filteredItemsChanged(items); | ||
| if (this.dataProvider && items) { | ||
| const { rootCache } = this.__dataProviderController; | ||
| if (rootCache.items !== items) { | ||
| rootCache.items = items; | ||
| this.requestContentUpdate(); | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * Synchronizes the controller's state with the component, which can be | ||
| * out of sync after the controller receives new data from the data provider | ||
| * or if the state in the controller is directly manupulated. | ||
| * | ||
| * @override | ||
| */ | ||
| requestContentUpdate() { | ||
| // When the data provider isn't initialized, it means the content update was requested | ||
| // by an observer before the `ready()` callback. In such cases, some properties | ||
| // in the data provider controller might still be uninitialized, so it's not safe | ||
| // to use them to update the component's properties yet. Another content update | ||
| // will be requested in the `ready()` callback. | ||
| if (this.__dataProviderInitialized && this.dataProvider) { | ||
| const { rootCache } = this.__dataProviderController; | ||
| this.size = rootCache.size; | ||
| this.filteredItems = rootCache.items; | ||
| this.loading = this.__dataProviderController.isLoading(); | ||
| } | ||
| super.requestContentUpdate(); | ||
| } | ||
| /** @private */ | ||
@@ -256,2 +270,4 @@ _pageSizeChanged(pageSize, oldPageSize) { | ||
| } | ||
| this.__dataProviderController.setPageSize(pageSize); | ||
| this.clearCache(); | ||
@@ -266,2 +282,3 @@ } | ||
| this.__dataProviderController.setDataProvider(dataProvider); | ||
| this.clearCache(); | ||
@@ -293,26 +310,2 @@ } | ||
| } | ||
| /** | ||
| * This method cleans up the page callbacks which refers to the | ||
| * non-existing pages, i.e. which item indexes are greater than the | ||
| * changed size. | ||
| * This case is basically happens when: | ||
| * 1. Users scroll fast to the bottom and combo box generates the | ||
| * redundant page request/callback | ||
| * 2. Server side uses undefined size lazy loading and suddenly reaches | ||
| * the exact size which is on the range edge | ||
| * (for default page size = 50, it will be 100, 200, 300, ...). | ||
| * @param size the new size of items | ||
| * @private | ||
| */ | ||
| _flushPendingRequests(size) { | ||
| if (this._pendingRequests) { | ||
| const lastPage = Math.ceil(size / this.pageSize); | ||
| Object.entries(this._pendingRequests).forEach(([page, callback]) => { | ||
| if (parseInt(page) >= lastPage) { | ||
| callback([], size); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| }; |
@@ -8,3 +8,3 @@ /** | ||
| import { FocusMixin } from '@vaadin/a11y-base/src/focus-mixin.js'; | ||
| import { isElementFocused } from '@vaadin/a11y-base/src/focus-utils.js'; | ||
| import { isElementFocused, isKeyboardActive } from '@vaadin/a11y-base/src/focus-utils.js'; | ||
| import { KeyboardMixin } from '@vaadin/a11y-base/src/keyboard-mixin.js'; | ||
@@ -516,3 +516,3 @@ import { isTouch } from '@vaadin/component-base/src/browser-utils.js'; | ||
| /** @private */ | ||
| // eslint-disable-next-line max-params | ||
| // eslint-disable-next-line @typescript-eslint/max-params | ||
| _updateScroller( | ||
@@ -1363,3 +1363,15 @@ scroller, | ||
| this._closeOrCommit(); | ||
| if (isKeyboardActive()) { | ||
| // Close on Tab key causing blur. With mouse, close on outside click instead. | ||
| this._closeOrCommit(); | ||
| return; | ||
| } | ||
| if (!this.opened) { | ||
| this._commitValue(); | ||
| } else if (!this._overlayOpened) { | ||
| // Combo-box is opened, but overlay is not visible -> custom value was entered. | ||
| // Make sure we close here as there won't be an "outside click" in this case. | ||
| this.close(); | ||
| } | ||
| } | ||
@@ -1366,0 +1378,0 @@ } |
@@ -36,17 +36,6 @@ import '@vaadin/vaadin-lumo-styles/color.js'; | ||
| z-index: 1; | ||
| left: var(--lumo-space-s); | ||
| right: var(--lumo-space-s); | ||
| inset-inline: var(--lumo-space-s); | ||
| top: var(--lumo-space-s); | ||
| margin-left: auto; | ||
| margin-inline-start: auto; | ||
| margin-inline-end: 0; | ||
| margin-inline: auto 0; | ||
| } | ||
| :host([dir='rtl']) [part~='loader'] { | ||
| left: auto; | ||
| margin-left: 0; | ||
| margin-right: auto; | ||
| margin-inline-start: 0; | ||
| margin-inline-end: auto; | ||
| } | ||
| `; | ||
@@ -53,0 +42,0 @@ |
| { | ||
| "$schema": "https://json.schemastore.org/web-types", | ||
| "name": "@vaadin/combo-box", | ||
| "version": "24.5.0-alpha1", | ||
| "version": "24.5.0-alpha10", | ||
| "description-markup": "markdown", | ||
@@ -474,3 +474,3 @@ "contributions": { | ||
| "name": "vaadin-combo-box", | ||
| "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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha1/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha1/#/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.", | ||
| "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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha10/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha10/#/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.", | ||
| "attributes": [ | ||
@@ -477,0 +477,0 @@ { |
| { | ||
| "$schema": "https://json.schemastore.org/web-types", | ||
| "name": "@vaadin/combo-box", | ||
| "version": "24.5.0-alpha1", | ||
| "version": "24.5.0-alpha10", | ||
| "description-markup": "markdown", | ||
@@ -257,3 +257,3 @@ "framework": "lit", | ||
| "name": "vaadin-combo-box", | ||
| "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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/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.0-alpha1/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha1/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha1/#/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.", | ||
| "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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/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.0-alpha10/#/elements/vaadin-overlay).\n- `<vaadin-combo-box-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha10/#/elements/vaadin-item).\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha10/#/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.", | ||
| "extension": true, | ||
@@ -260,0 +260,0 @@ "attributes": [ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.24%
249800
Worsened metrics
- Lines of code
- decreased by-0.1%
6103
Dependency changes
+ Added@vaadin/a11y-base@24.5.0-alpha10(transitive)
+ Added@vaadin/component-base@24.5.0-alpha10(transitive)
+ Added@vaadin/field-base@24.5.0-alpha10(transitive)
+ Added@vaadin/icon@24.5.0-alpha10(transitive)
+ Added@vaadin/input-container@24.5.0-alpha10(transitive)
+ Added@vaadin/item@24.5.0-alpha10(transitive)
+ Added@vaadin/lit-renderer@24.5.0-alpha10(transitive)
+ Added@vaadin/overlay@24.5.0-alpha10(transitive)
+ Added@vaadin/vaadin-lumo-styles@24.5.0-alpha10(transitive)
+ Added@vaadin/vaadin-material-styles@24.5.0-alpha10(transitive)
+ Added@vaadin/vaadin-themable-mixin@24.5.0-alpha10(transitive)
- Removed@vaadin/a11y-base@24.5.0-alpha1(transitive)
- Removed@vaadin/component-base@24.5.0-alpha1(transitive)
- Removed@vaadin/field-base@24.5.0-alpha1(transitive)
- Removed@vaadin/icon@24.5.0-alpha1(transitive)
- Removed@vaadin/input-container@24.5.0-alpha1(transitive)
- Removed@vaadin/item@24.5.0-alpha1(transitive)
- Removed@vaadin/lit-renderer@24.5.0-alpha1(transitive)
- Removed@vaadin/overlay@24.5.0-alpha1(transitive)
- Removed@vaadin/vaadin-lumo-styles@24.5.0-alpha1(transitive)
- Removed@vaadin/vaadin-material-styles@24.5.0-alpha1(transitive)
- Removed@vaadin/vaadin-themable-mixin@24.5.0-alpha1(transitive)
Updated@vaadin/item@24.5.0-alpha10