combo-boxpackage.web-types.lit.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-webcomponents Show documentation
Show all versions of vaadin-webcomponents Show documentation
Mvnpm composite: Vaadin webcomponents
The newest version!
{
"$schema": "https://json.schemastore.org/web-types",
"name": "@vaadin/combo-box",
"version": "24.5.3",
"description-markup": "markdown",
"framework": "lit",
"framework-config": {
"enable-when": {
"node-packages": [
"lit"
]
}
},
"contributions": {
"html": {
"elements": [
{
"name": "vaadin-combo-box-light",
"description": "`` is a customizable version of the `` providing\nonly the dropdown functionality and leaving the input field definition to the user.\n\nThe element has the same API as ``.\n\nTo create a custom input field, you need to add a child element which has a two-way\ndata-bindable property representing the input value. The property name is expected\nto be `value` by default. For example, you can use `` element:\n\n```html\n\n \n```\n\nIf you are using custom input field that has other property for value,\nset `class=\"input\"` to enable corresponding logic, and use `attr-for-value`\nattribute to specify which property to use:\n\n```html\n\n \n```\n\nYou can also pass custom toggle and clear buttons with corresponding classes:\n\n```html\n\n \n \n \n \n \n```",
"extension": true,
"attributes": [
{
"name": "?invalid",
"description": "Set to true when the field is invalid.",
"value": {
"kind": "expression"
}
},
{
"name": "?required",
"description": "Specifies that the user must fill in a value.",
"value": {
"kind": "expression"
}
},
{
"name": "?disabled",
"description": "If true, the user cannot interact with this element.",
"value": {
"kind": "expression"
}
},
{
"name": "?opened",
"description": "True if the dropdown is open, false otherwise.",
"value": {
"kind": "expression"
}
},
{
"name": "?autoOpenDisabled",
"description": "Set true to prevent the overlay from opening automatically.",
"value": {
"kind": "expression"
}
},
{
"name": "?readonly",
"description": "When present, it specifies that the field is read-only.",
"value": {
"kind": "expression"
}
},
{
"name": "?allowCustomValue",
"description": "If `true`, the user can input a value that is not present in the items list.\n`value` property will be set to the input value in this case.\nAlso, when `value` is set programmatically, the input value will be set\nto reflect that value.",
"value": {
"kind": "expression"
}
},
{
"name": "?loading",
"description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": ".pageSize",
"description": "Number of items fetched at a time from the dataprovider.",
"value": {
"kind": "expression"
}
},
{
"name": ".size",
"description": "Total number of items.",
"value": {
"kind": "expression"
}
},
{
"name": ".dataProvider",
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
"value": {
"kind": "expression"
}
},
{
"name": ".value",
"description": "The value of the field.",
"value": {
"kind": "expression"
}
},
{
"name": ".overlayClass",
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
"value": {
"kind": "expression"
}
},
{
"name": ".renderer",
"description": "Custom function for rendering the content of every item.\nReceives three arguments:\n\n- `root` The `` internal container DOM element.\n- `comboBox` The reference to the `` element.\n- `model` The object with the properties related with the rendered\n item, contains:\n - `model.index` The index of the rendered item.\n - `model.item` The item.",
"value": {
"kind": "expression"
}
},
{
"name": ".items",
"description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.",
"value": {
"kind": "expression"
}
},
{
"name": ".filteredItems",
"description": "A subset of items, filtered based on the user input. Filtered items\ncan be assigned directly to omit the internal filtering functionality.\nThe items can be of either `String` or `Object` type.",
"value": {
"kind": "expression"
}
},
{
"name": ".filter",
"description": "Filtering string the user has typed into the input field.",
"value": {
"kind": "expression"
}
},
{
"name": ".selectedItem",
"description": "The selected item from the `items` array.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemClassNameGenerator",
"description": "A function used to generate CSS class names for dropdown\nitems based on the item. The return value should be the\ngenerated class name as a string, or multiple class names\nseparated by whitespace characters.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemLabelPath",
"description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemValuePath",
"description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemIdPath",
"description": "Path for the id of the item. If `items` is an array of objects,\nthe `itemIdPath` is used to compare and identify the same item\nin `selectedItem` and `filteredItems` (items given by the\n`dataProvider` callback).",
"value": {
"kind": "expression"
}
},
{
"name": ".attrForValue",
"description": "Name of the two-way data-bindable property representing the\nvalue of the custom input field.",
"value": {
"kind": "expression"
}
},
{
"name": "@validated",
"description": "Fired whenever the field is validated.",
"value": {
"kind": "expression"
}
},
{
"name": "@change",
"description": "Fired when value changes.\nTo comply with https://developer.mozilla.org/en-US/docs/Web/Events/change",
"value": {
"kind": "expression"
}
},
{
"name": "@custom-value-set",
"description": "Fired when the user sets a custom value.",
"value": {
"kind": "expression"
}
},
{
"name": "@selected-item-changed",
"description": "Fired when selected item changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@vaadin-combo-box-dropdown-closed",
"description": "Fired after the `vaadin-combo-box-overlay` closes.",
"value": {
"kind": "expression"
}
},
{
"name": "@vaadin-combo-box-dropdown-opened",
"description": "Fired after the `vaadin-combo-box-overlay` opens.",
"value": {
"kind": "expression"
}
},
{
"name": "@value-changed",
"description": "Fired when the value changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@invalid-changed",
"description": "Fired when the `invalid` property changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@opened-changed",
"description": "Fired when the `opened` property changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@filter-changed",
"description": "Fired when the `filter` property changes.",
"value": {
"kind": "expression"
}
}
]
},
{
"name": "vaadin-combo-box",
"description": "`` 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.3/#/elements/vaadin-combo-box#property-items) property on the element.\n\n```html\n` elements placed in the dropdown, use\n[`renderer`](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/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} ${item.value}`;\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.3/#/elements/vaadin-combo-box#property-dataProvider) function property.\nThe `` 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`` provides the same set of shadow DOM parts and state attributes as ``.\nSee [``](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/elements/vaadin-text-field) for the styling documentation.\n\nIn addition to `` parts, the following parts are available for theming:\n\nPart name | Description\n----------------|----------------\n`toggle-button` | The toggle button\n\nIn addition to `` 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 `` and its container with a custom implementation to get full control\nover the input field, consider using the [``](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/elements/vaadin-combo-box-light) element.\n\n### Internal components\n\nIn addition to `` itself, the following internal\ncomponents are themable:\n\n- `` - has the same API as [``](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/elements/vaadin-overlay).\n- `` - has the same API as [``](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/elements/vaadin-item).\n- [``](https://cdn.vaadin.com/vaadin-web-components/24.5.3/#/elements/vaadin-input-container) - an internal element wrapping the input.\n\nNote: the `theme` attribute value set on `` is\npropagated to the internal components listed above.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
"extension": true,
"attributes": [
{
"name": "?disabled",
"description": "If true, the user cannot interact with this element.",
"value": {
"kind": "expression"
}
},
{
"name": "?autofocus",
"description": "Specify that this control should have input focus when the page loads.",
"value": {
"kind": "expression"
}
},
{
"name": "?invalid",
"description": "Set to true when the field is invalid.",
"value": {
"kind": "expression"
}
},
{
"name": "?required",
"description": "Specifies that the user must fill in a value.",
"value": {
"kind": "expression"
}
},
{
"name": "?clearButtonVisible",
"description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.",
"value": {
"kind": "expression"
}
},
{
"name": "?autoselect",
"description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
"value": {
"kind": "expression"
}
},
{
"name": "?readonly",
"description": "When present, it specifies that the field is read-only.",
"value": {
"kind": "expression"
}
},
{
"name": "?opened",
"description": "True if the dropdown is open, false otherwise.",
"value": {
"kind": "expression"
}
},
{
"name": "?autoOpenDisabled",
"description": "Set true to prevent the overlay from opening automatically.",
"value": {
"kind": "expression"
}
},
{
"name": "?allowCustomValue",
"description": "If `true`, the user can input a value that is not present in the items list.\n`value` property will be set to the input value in this case.\nAlso, when `value` is set programmatically, the input value will be set\nto reflect that value.",
"value": {
"kind": "expression"
}
},
{
"name": "?loading",
"description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": ".label",
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
"value": {
"kind": "expression"
}
},
{
"name": ".errorMessage",
"description": "Error to show when the field is invalid.",
"value": {
"kind": "expression"
}
},
{
"name": ".helperText",
"description": "String used for the helper text.",
"value": {
"kind": "expression"
}
},
{
"name": ".accessibleName",
"description": "String used to label the component to screen reader users.",
"value": {
"kind": "expression"
}
},
{
"name": ".accessibleNameRef",
"description": "Id of the element used as label of the component to screen reader users.",
"value": {
"kind": "expression"
}
},
{
"name": ".value",
"description": "The value of the field.",
"value": {
"kind": "expression"
}
},
{
"name": ".allowedCharPattern",
"description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
"value": {
"kind": "expression"
}
},
{
"name": ".name",
"description": "The name of this field.",
"value": {
"kind": "expression"
}
},
{
"name": ".placeholder",
"description": "A hint to the user of what can be entered in the field.",
"value": {
"kind": "expression"
}
},
{
"name": ".title",
"description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
"value": {
"kind": "expression"
}
},
{
"name": ".pattern",
"description": "A regular expression that the value is checked against.\nThe pattern must match the entire value, not just some subset.",
"value": {
"kind": "expression"
}
},
{
"name": ".pageSize",
"description": "Number of items fetched at a time from the dataprovider.",
"value": {
"kind": "expression"
}
},
{
"name": ".size",
"description": "Total number of items.",
"value": {
"kind": "expression"
}
},
{
"name": ".dataProvider",
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
"value": {
"kind": "expression"
}
},
{
"name": ".overlayClass",
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
"value": {
"kind": "expression"
}
},
{
"name": ".renderer",
"description": "Custom function for rendering the content of every item.\nReceives three arguments:\n\n- `root` The `` internal container DOM element.\n- `comboBox` The reference to the `` element.\n- `model` The object with the properties related with the rendered\n item, contains:\n - `model.index` The index of the rendered item.\n - `model.item` The item.",
"value": {
"kind": "expression"
}
},
{
"name": ".items",
"description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.",
"value": {
"kind": "expression"
}
},
{
"name": ".filteredItems",
"description": "A subset of items, filtered based on the user input. Filtered items\ncan be assigned directly to omit the internal filtering functionality.\nThe items can be of either `String` or `Object` type.",
"value": {
"kind": "expression"
}
},
{
"name": ".filter",
"description": "Filtering string the user has typed into the input field.",
"value": {
"kind": "expression"
}
},
{
"name": ".selectedItem",
"description": "The selected item from the `items` array.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemClassNameGenerator",
"description": "A function used to generate CSS class names for dropdown\nitems based on the item. The return value should be the\ngenerated class name as a string, or multiple class names\nseparated by whitespace characters.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemLabelPath",
"description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemValuePath",
"description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
"value": {
"kind": "expression"
}
},
{
"name": ".itemIdPath",
"description": "Path for the id of the item. If `items` is an array of objects,\nthe `itemIdPath` is used to compare and identify the same item\nin `selectedItem` and `filteredItems` (items given by the\n`dataProvider` callback).",
"value": {
"kind": "expression"
}
},
{
"name": "@validated",
"description": "Fired whenever the field is validated.",
"value": {
"kind": "expression"
}
},
{
"name": "@change",
"description": "Fired when value changes.\nTo comply with https://developer.mozilla.org/en-US/docs/Web/Events/change",
"value": {
"kind": "expression"
}
},
{
"name": "@input",
"description": "Fired when the value is changed by the user: on every typing keystroke,\nand the value is cleared using the clear button.",
"value": {
"kind": "expression"
}
},
{
"name": "@custom-value-set",
"description": "Fired when the user sets a custom value.",
"value": {
"kind": "expression"
}
},
{
"name": "@selected-item-changed",
"description": "Fired when selected item changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@vaadin-combo-box-dropdown-closed",
"description": "Fired after the `vaadin-combo-box-overlay` closes.",
"value": {
"kind": "expression"
}
},
{
"name": "@vaadin-combo-box-dropdown-opened",
"description": "Fired after the `vaadin-combo-box-overlay` opens.",
"value": {
"kind": "expression"
}
},
{
"name": "@value-changed",
"description": "Fired when the value changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@invalid-changed",
"description": "Fired when the `invalid` property changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@opened-changed",
"description": "Fired when the `opened` property changes.",
"value": {
"kind": "expression"
}
},
{
"name": "@filter-changed",
"description": "Fired when the `filter` property changes.",
"value": {
"kind": "expression"
}
}
]
}
]
}
}
}