{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "vaadin-combo-box.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-combo-box.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-base-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxBaseMixin", "members": [ { "kind": "field", "name": "autoOpenDisabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "attribute": "auto-open-disabled" }, { "kind": "method", "name": "clear", "description": "Clear the value of the field.", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } }, { "kind": "method", "name": "close", "description": "Closes the dropdown list." }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "attribute": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "kind": "method", "name": "open", "description": "Opens the dropdown list." }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "attribute": "opened" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly" }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the field.", "attribute": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "attributes": [ { "name": "auto-open-disabled", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "fieldName": "autoOpenDisabled" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "name": "opened", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "fieldName": "opened" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly" }, { "name": "value", "type": { "text": "string" }, "description": "The value of the field.", "fieldName": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "mixins": [ { "name": "KeyboardMixin", "package": "@vaadin/a11y-base/src/keyboard-mixin.js" }, { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" }, { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" }, { "name": "FocusMixin", "package": "@vaadin/a11y-base/src/focus-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxBaseMixin", "declaration": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-data-provider-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxDataProviderMixin", "members": [ { "kind": "method", "name": "clearCache", "description": "Clears the cached pages and reloads data from dataprovider when needed." }, { "kind": "field", "name": "dataProvider", "privacy": "public", "type": { "text": "ComboBoxDataProvider | undefined" }, "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.", "attribute": "data-provider" }, { "kind": "field", "name": "pageSize", "privacy": "public", "type": { "text": "number" }, "description": "Number of items fetched at a time from the dataprovider.", "attribute": "page-size" }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "number" }, "description": "Total number of items.", "attribute": "size" } ], "attributes": [ { "name": "data-provider", "type": { "text": "ComboBoxDataProvider | undefined" }, "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.", "fieldName": "dataProvider" }, { "name": "page-size", "type": { "text": "number" }, "description": "Number of items fetched at a time from the dataprovider.", "fieldName": "pageSize" }, { "name": "size", "type": { "text": "number" }, "description": "Total number of items.", "fieldName": "size" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxDataProviderMixin", "declaration": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-focus-index-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxFocusIndexMixin", "members": [], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxFocusIndexMixin", "declaration": { "name": "ComboBoxFocusIndexMixin", "module": "src/vaadin-combo-box-focus-index-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-item-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxItemMixin", "members": [ { "kind": "field", "name": "focused", "privacy": "public", "type": { "text": "boolean" }, "description": "True when item is focused.", "attribute": "focused" }, { "kind": "field", "name": "index", "privacy": "public", "type": { "text": "number" }, "description": "The index of the item.", "attribute": "index" }, { "kind": "field", "name": "item", "privacy": "public", "type": { "text": "object" }, "description": "The item to render.", "attribute": "item" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "The text to render in the item.", "attribute": "label" }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "function" }, "description": "Custom function for rendering the item content.", "attribute": "renderer" }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of the item.\nWhile performing the update, it invokes the renderer passed in the `renderer` property.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested." }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "boolean" }, "description": "True when item is selected.", "attribute": "selected" } ], "attributes": [ { "name": "focused", "type": { "text": "boolean" }, "description": "True when item is focused.", "fieldName": "focused" }, { "name": "hidden" }, { "name": "index", "type": { "text": "number" }, "description": "The index of the item.", "fieldName": "index" }, { "name": "label", "type": { "text": "string" }, "description": "The text to render in the item.", "fieldName": "label" }, { "name": "renderer", "type": { "text": "function" }, "description": "Custom function for rendering the item content.", "fieldName": "renderer" }, { "name": "selected", "type": { "text": "boolean" }, "description": "True when item is selected.", "fieldName": "selected" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxItemMixin", "declaration": { "name": "ComboBoxItemMixin", "module": "src/vaadin-combo-box-item-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-items-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxItemsMixin", "members": [ { "kind": "field", "name": "autoOpenDisabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "attribute": "auto-open-disabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "method", "name": "clear", "description": "Clear the value of the field.", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } }, { "kind": "method", "name": "close", "description": "Closes the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "attribute": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "kind": "field", "name": "filter", "privacy": "public", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "attribute": "filter" }, { "kind": "field", "name": "filteredItems", "privacy": "public", "type": { "text": "!Array | undefined" }, "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.", "attribute": "filtered-items" }, { "kind": "field", "name": "itemLabelGenerator", "privacy": "public", "type": { "text": "object" }, "description": "A function that is used to generate the label for dropdown\nitems based on the item. Receives one argument:\n- `item` The item to generate the label for.", "attribute": "item-label-generator" }, { "kind": "field", "name": "itemLabelPath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-label-path" }, { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "!Array | undefined" }, "description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.", "attribute": "items" }, { "kind": "field", "name": "itemValuePath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-value-path" }, { "kind": "method", "name": "open", "description": "Opens the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "attribute": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the field.", "attribute": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "attributes": [ { "name": "auto-open-disabled", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "fieldName": "autoOpenDisabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "name": "filter", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "fieldName": "filter" }, { "name": "item-label-path", "type": { "text": "string" }, "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.", "fieldName": "itemLabelPath" }, { "name": "item-value-path", "type": { "text": "string" }, "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.", "fieldName": "itemValuePath" }, { "name": "opened", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "fieldName": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "value", "type": { "text": "string" }, "description": "The value of the field.", "fieldName": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "mixins": [ { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxItemsMixin", "declaration": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxMixin", "members": [ { "kind": "field", "name": "allowCustomValue", "privacy": "public", "type": { "text": "boolean" }, "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.", "attribute": "allow-custom-value" }, { "kind": "field", "name": "autoOpenDisabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "attribute": "auto-open-disabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "method", "name": "cancel", "description": "Reverts back to original value." }, { "kind": "method", "name": "checkValidity", "description": "Returns true if the field value satisfies all constraints (if any).", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "method", "name": "clear", "description": "Clear the value of the field.", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } }, { "kind": "method", "name": "close", "description": "Closes the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "attribute": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "kind": "field", "name": "filter", "privacy": "public", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "attribute": "filter", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "filteredItems", "privacy": "public", "type": { "text": "!Array | undefined" }, "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.", "attribute": "filtered-items", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "invalid", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true when the field is invalid.", "attribute": "invalid", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "itemClassNameGenerator", "privacy": "public", "type": { "text": "object" }, "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.", "attribute": "item-class-name-generator" }, { "kind": "field", "name": "itemIdPath", "privacy": "public", "type": { "text": "string" }, "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).", "attribute": "item-id-path" }, { "kind": "field", "name": "itemLabelGenerator", "privacy": "public", "type": { "text": "object" }, "description": "A function that is used to generate the label for dropdown\nitems based on the item. Receives one argument:\n- `item` The item to generate the label for.", "attribute": "item-label-generator", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "itemLabelPath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-label-path", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "!Array | undefined" }, "description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.", "attribute": "items", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "itemValuePath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-value-path", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "loading", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.", "attribute": "loading" }, { "kind": "field", "name": "manualValidation", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to enable manual validation mode. This mode disables automatic\nconstraint validation, allowing you to control the validation process yourself.\nYou can still trigger constraint validation manually with the `validate()` method\nor use `checkValidity()` to assess the component's validity without affecting\nthe invalid state. In manual validation mode, you can also manipulate\nthe `invalid` property directly through your application logic without conflicts\nwith the component's internal validation.", "attribute": "manual-validation", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "method", "name": "open", "description": "Opens the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "attribute": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "ComboBoxRenderer | undefined" }, "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.", "attribute": "renderer" }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of items.\nWhile performing the update, it invokes the renderer (passed in the `renderer` property) once an item.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested." }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Specifies that the user must fill in a value.", "attribute": "required", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "selectedItem", "privacy": "public", "type": { "text": "ComboBoxItem | string | undefined" }, "description": "The selected item from the `items` array.", "attribute": "selected-item" }, { "kind": "method", "name": "validate", "description": "Validates the field and sets the `invalid` property based on the result.\n\nThe method fires a `validated` event with the result of the validation.", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the field.", "attribute": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "vaadin-combo-box-dropdown-closed", "type": { "text": "CustomEvent" } }, { "name": "vaadin-combo-box-dropdown-opened", "type": { "text": "CustomEvent" } }, { "name": "validated", "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } } ], "attributes": [ { "name": "allow-custom-value", "type": { "text": "boolean" }, "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.", "fieldName": "allowCustomValue" }, { "name": "auto-open-disabled", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "fieldName": "autoOpenDisabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "name": "filter", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "fieldName": "filter", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "invalid", "type": { "text": "boolean" }, "description": "Set to true when the field is invalid.", "fieldName": "invalid", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "item-id-path", "type": { "text": "string" }, "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).", "fieldName": "itemIdPath" }, { "name": "item-label-path", "type": { "text": "string" }, "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.", "fieldName": "itemLabelPath", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "item-value-path", "type": { "text": "string" }, "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.", "fieldName": "itemValuePath", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "loading", "type": { "text": "boolean" }, "description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.", "fieldName": "loading" }, { "name": "manual-validation", "type": { "text": "boolean" }, "description": "Set to true to enable manual validation mode. This mode disables automatic\nconstraint validation, allowing you to control the validation process yourself.\nYou can still trigger constraint validation manually with the `validate()` method\nor use `checkValidity()` to assess the component's validity without affecting\nthe invalid state. In manual validation mode, you can also manipulate\nthe `invalid` property directly through your application logic without conflicts\nwith the component's internal validation.", "fieldName": "manualValidation", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "opened", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "fieldName": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "renderer", "type": { "text": "ComboBoxRenderer | undefined" }, "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.", "fieldName": "renderer" }, { "name": "required", "type": { "text": "boolean" }, "description": "Specifies that the user must fill in a value.", "fieldName": "required", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "selected-item", "type": { "text": "ComboBoxItem | string | undefined" }, "description": "The selected item from the `items` array.", "fieldName": "selectedItem" }, { "name": "value", "type": { "text": "string" }, "description": "The value of the field.", "fieldName": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "mixins": [ { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" }, { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxMixin", "declaration": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-overlay-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxOverlayMixin", "members": [ { "kind": "field", "name": "horizontalAlign", "privacy": "public", "type": { "text": "string" }, "description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.", "attribute": "horizontal-align", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "noHorizontalOverlap", "privacy": "public", "type": { "text": "boolean" }, "description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.", "attribute": "no-horizontal-overlap", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "noVerticalOverlap", "privacy": "public", "type": { "text": "boolean" }, "description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.", "attribute": "no-vertical-overlap", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "positionTarget", "privacy": "public", "type": { "text": "object" }, "description": "The element next to which this overlay should be aligned.\nThe position of the overlay relative to the positionTarget can be adjusted\nwith properties `horizontalAlign`, `verticalAlign`, `noHorizontalOverlap`\nand `noVerticalOverlap`.", "attribute": "position-target", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "requiredVerticalSpace", "privacy": "public", "type": { "text": "number" }, "description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.", "attribute": "required-vertical-space", "default": "200", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "verticalAlign", "privacy": "public", "type": { "text": "string" }, "description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.", "attribute": "vertical-align", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } } ], "mixins": [ { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } ], "parameters": [ { "name": "superClass" } ], "attributes": [ { "name": "horizontal-align", "type": { "text": "string" }, "description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.", "fieldName": "horizontalAlign", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "name": "no-horizontal-overlap", "type": { "text": "boolean" }, "description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.", "fieldName": "noHorizontalOverlap", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "name": "no-vertical-overlap", "type": { "text": "boolean" }, "description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.", "fieldName": "noVerticalOverlap", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "name": "required-vertical-space", "type": { "text": "number" }, "description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.", "fieldName": "requiredVerticalSpace", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "name": "vertical-align", "type": { "text": "string" }, "description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.", "fieldName": "verticalAlign", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxOverlayMixin", "declaration": { "name": "ComboBoxOverlayMixin", "module": "src/vaadin-combo-box-overlay-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-placeholder.js", "declarations": [ { "kind": "variable", "name": "ComboBoxPlaceholder", "default": "class ComboBoxPlaceholder { toString() { return ''; } }" } ], "exports": [ { "kind": "js", "name": "ComboBoxPlaceholder", "declaration": { "name": "ComboBoxPlaceholder", "module": "src/vaadin-combo-box-placeholder.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box-scroller-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ComboBoxScrollerMixin", "members": [ { "kind": "field", "name": "focusedIndex", "privacy": "public", "type": { "text": "number" }, "description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.", "attribute": "focused-index" }, { "kind": "field", "name": "getItemLabel", "privacy": "public", "type": { "text": "object" }, "description": "Function used to set a label for every combo-box item.", "attribute": "get-item-label" }, { "kind": "field", "name": "itemClassNameGenerator", "privacy": "public", "type": { "text": "object" }, "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.", "attribute": "item-class-name-generator" }, { "kind": "field", "name": "itemIdPath", "privacy": "public", "type": { "text": "string" }, "description": "Path for the id of the item, used to detect whether the item is selected.", "attribute": "item-id-path" }, { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "array" }, "description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.", "attribute": "items" }, { "kind": "field", "name": "loading", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true while combo-box fetches new page from the data provider.", "attribute": "loading" }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.", "attribute": "opened" }, { "kind": "field", "name": "owner", "privacy": "public", "type": { "text": "object" }, "description": "Reference to the owner (combo-box owner), used by the item elements.", "attribute": "owner" }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "object" }, "description": "Function used to render the content of every combo-box item.", "attribute": "renderer" }, { "kind": "method", "name": "requestContentUpdate", "description": "Updates the virtualizer's size and items." }, { "kind": "method", "name": "scrollIntoView", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Scrolls an item at given index into view and adjusts `scrollTop`\nso that the element gets fully visible on Arrow Down key press." }, { "kind": "field", "name": "selectedItem", "privacy": "public", "type": { "text": "object" }, "description": "The selected item from the `items` array.", "attribute": "selected-item" }, { "kind": "field", "name": "theme", "privacy": "public", "type": { "text": "string" }, "description": "Used to propagate the `theme` attribute from the host element.", "attribute": "theme" } ], "events": [ { "name": "index-requested", "type": { "text": "CustomEvent" } }, { "name": "selection-changed", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "focused-index", "type": { "text": "number" }, "description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.", "fieldName": "focusedIndex" }, { "name": "item-id-path", "type": { "text": "string" }, "description": "Path for the id of the item, used to detect whether the item is selected.", "fieldName": "itemIdPath" }, { "name": "items", "type": { "text": "array" }, "description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.", "fieldName": "items" }, { "name": "loading", "type": { "text": "boolean" }, "description": "Set to true while combo-box fetches new page from the data provider.", "fieldName": "loading" }, { "name": "opened", "type": { "text": "boolean" }, "description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.", "fieldName": "opened" }, { "name": "theme", "type": { "text": "string" }, "description": "Used to propagate the `theme` attribute from the host element.", "fieldName": "theme" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ComboBoxScrollerMixin", "declaration": { "name": "ComboBoxScrollerMixin", "module": "src/vaadin-combo-box-scroller-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-combo-box.js", "declarations": [ { "kind": "class", "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`](#/elements/vaadin-combo-box#property-items) property on the element.\n\n```html\n\n```\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 `` elements placed in the dropdown, use\n[`renderer`](#/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`](#/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\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`field-button` | Set on both clear and toggle 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`overlay` | The overlay container\n`content` | The overlay content\n`loader` | The loading indicator shown while loading items\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\n### Internal components\n\nIn addition to `` itself, the following internal\ncomponents are themable:\n\n- `` - has the same API as [``](#/elements/vaadin-item).\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "name": "ComboBox", "members": [ { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "attribute": "accessible-name", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "accessibleNameRef", "privacy": "public", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "attribute": "accessible-name-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "allowCustomValue", "privacy": "public", "type": { "text": "boolean" }, "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.", "attribute": "allow-custom-value", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "allowedCharPattern", "privacy": "public", "type": { "text": "string" }, "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-]\"`", "attribute": "allowed-char-pattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "autofocus", "privacy": "public", "type": { "text": "boolean" }, "description": "Specify that this control should have input focus when the page loads.", "attribute": "autofocus", "inheritedFrom": { "name": "DelegateFocusMixin", "package": "@vaadin/a11y-base/src/delegate-focus-mixin.js" } }, { "kind": "field", "name": "autoOpenDisabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "attribute": "auto-open-disabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "autoselect", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "attribute": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "method", "name": "cancel", "description": "Reverts back to original value.", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "method", "name": "checkValidity", "description": "Returns true if the field value satisfies all constraints (if any).", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "InputConstraintsMixin", "package": "@vaadin/field-base/src/input-constraints-mixin.js" } }, { "kind": "method", "name": "clear", "description": "Clear the value of the field.", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } }, { "kind": "field", "name": "clearButtonVisible", "privacy": "public", "type": { "text": "boolean" }, "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.", "attribute": "clear-button-visible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "kind": "method", "name": "clearCache", "description": "Clears the cached pages and reloads data from dataprovider when needed.", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "kind": "method", "name": "close", "description": "Closes the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "dataProvider", "privacy": "public", "type": { "text": "ComboBoxDataProvider | undefined" }, "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.", "attribute": "data-provider", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "attribute": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "filter", "privacy": "public", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "attribute": "filter", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "filteredItems", "privacy": "public", "type": { "text": "!Array | undefined" }, "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.", "attribute": "filtered-items", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "helperText", "privacy": "public", "type": { "text": "string" }, "description": "String used for the helper text.", "attribute": "helper-text", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "invalid", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true when the field is invalid.", "attribute": "invalid", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "itemClassNameGenerator", "privacy": "public", "type": { "text": "object" }, "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.", "attribute": "item-class-name-generator", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "itemIdPath", "privacy": "public", "type": { "text": "string" }, "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).", "attribute": "item-id-path", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "itemLabelGenerator", "privacy": "public", "type": { "text": "object" }, "description": "A function that is used to generate the label for dropdown\nitems based on the item. Receives one argument:\n- `item` The item to generate the label for.", "attribute": "item-label-generator", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "itemLabelPath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-label-path", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "!Array | undefined" }, "description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.", "attribute": "items", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "itemValuePath", "privacy": "public", "type": { "text": "string" }, "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.", "attribute": "item-value-path", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.", "attribute": "label", "inheritedFrom": { "name": "LabelMixin", "package": "@vaadin/field-base/src/label-mixin.js" } }, { "kind": "field", "name": "loading", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.", "attribute": "loading", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "manualValidation", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to enable manual validation mode. This mode disables automatic\nconstraint validation, allowing you to control the validation process yourself.\nYou can still trigger constraint validation manually with the `validate()` method\nor use `checkValidity()` to assess the component's validity without affecting\nthe invalid state. In manual validation mode, you can also manipulate\nthe `invalid` property directly through your application logic without conflicts\nwith the component's internal validation.", "attribute": "manual-validation", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "The name of this field.", "attribute": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "method", "name": "open", "description": "Opens the dropdown list.", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "attribute": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "kind": "field", "name": "pageSize", "privacy": "public", "type": { "text": "number" }, "description": "Number of items fetched at a time from the dataprovider.", "attribute": "page-size", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "kind": "field", "name": "pattern", "privacy": "public", "type": { "text": "string" }, "description": "A regular expression that the value is checked against.\nThe pattern must match the entire value, not just some subset.", "attribute": "pattern", "inheritedFrom": { "name": "PatternMixin", "package": "@vaadin/field-base/src/pattern-mixin.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "attribute": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "ComboBoxRenderer | undefined" }, "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.", "attribute": "renderer", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of items.\nWhile performing the update, it invokes the renderer (passed in the `renderer` property) once an item.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Specifies that the user must fill in a value.", "attribute": "required", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "selectedItem", "privacy": "public", "type": { "text": "ComboBoxItem | string | undefined" }, "description": "The selected item from the `items` array.", "attribute": "selected-item", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "number" }, "description": "Total number of items.", "attribute": "size", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "kind": "field", "name": "title", "privacy": "public", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "attribute": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "method", "name": "validate", "description": "Validates the field and sets the `invalid` property based on the result.\n\nThe method fires a `validated` event with the result of the validation.", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the field.", "attribute": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" }, "description": "Fired when the user commits a value change.", "inheritedFrom": { "name": "InputConstraintsMixin", "package": "@vaadin/field-base/src/input-constraints-mixin.js" } }, { "type": { "text": "CustomEvent" }, "description": "Fired when the user sets a custom value.", "name": "custom-value-set" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `filter` property changes.", "name": "filter-changed" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `invalid` property changes.", "name": "invalid-changed" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `opened` property changes.", "name": "opened-changed" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `selectedItem` property changes.", "name": "selected-item-changed" }, { "name": "vaadin-combo-box-dropdown-closed", "type": { "text": "CustomEvent" }, "description": "Fired after the `vaadin-combo-box-overlay` closes.", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "vaadin-combo-box-dropdown-opened", "type": { "text": "CustomEvent" }, "description": "Fired after the `vaadin-combo-box-overlay` opens.", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "validated", "type": { "text": "CustomEvent" }, "description": "Fired whenever the field is validated.", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `value` property changes.", "name": "value-changed" } ], "attributes": [ { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "fieldName": "accessibleName", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name-ref", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "fieldName": "accessibleNameRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "allow-custom-value", "type": { "text": "boolean" }, "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.", "fieldName": "allowCustomValue", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "allowed-char-pattern", "type": { "text": "string" }, "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-]\"`", "fieldName": "allowedCharPattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "auto-open-disabled", "type": { "text": "boolean" }, "description": "Set true to prevent the overlay from opening automatically.", "fieldName": "autoOpenDisabled", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "autofocus", "type": { "text": "boolean" }, "description": "Specify that this control should have input focus when the page loads.", "fieldName": "autofocus", "inheritedFrom": { "name": "DelegateFocusMixin", "package": "@vaadin/a11y-base/src/delegate-focus-mixin.js" } }, { "name": "autoselect", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "fieldName": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "clear-button-visible", "type": { "text": "boolean" }, "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.", "fieldName": "clearButtonVisible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "name": "data-provider", "type": { "text": "ComboBoxDataProvider | undefined" }, "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.", "fieldName": "dataProvider", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "DisabledMixin", "package": "@vaadin/a11y-base/src/disabled-mixin.js" } }, { "name": "error-message", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "filter", "type": { "text": "string" }, "description": "Filtering string the user has typed into the input field.", "fieldName": "filter", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "helper-text", "type": { "text": "string" }, "description": "String used for the helper text.", "fieldName": "helperText", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "invalid", "type": { "text": "boolean" }, "description": "Set to true when the field is invalid.", "fieldName": "invalid", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "item-id-path", "type": { "text": "string" }, "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).", "fieldName": "itemIdPath", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "item-label-path", "type": { "text": "string" }, "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.", "fieldName": "itemLabelPath", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "item-value-path", "type": { "text": "string" }, "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.", "fieldName": "itemValuePath", "inheritedFrom": { "name": "ComboBoxItemsMixin", "module": "src/vaadin-combo-box-items-mixin.js" } }, { "name": "label", "type": { "text": "string" }, "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.", "fieldName": "label", "inheritedFrom": { "name": "LabelMixin", "package": "@vaadin/field-base/src/label-mixin.js" } }, { "name": "loading", "type": { "text": "boolean" }, "description": "When set to `true`, \"loading\" attribute is added to host and the overlay element.", "fieldName": "loading", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "manual-validation", "type": { "text": "boolean" }, "description": "Set to true to enable manual validation mode. This mode disables automatic\nconstraint validation, allowing you to control the validation process yourself.\nYou can still trigger constraint validation manually with the `validate()` method\nor use `checkValidity()` to assess the component's validity without affecting\nthe invalid state. In manual validation mode, you can also manipulate\nthe `invalid` property directly through your application logic without conflicts\nwith the component's internal validation.", "fieldName": "manualValidation", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "name", "type": { "text": "string" }, "description": "The name of this field.", "fieldName": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "opened", "type": { "text": "boolean" }, "description": "True if the dropdown is open, false otherwise.", "fieldName": "opened", "inheritedFrom": { "name": "ComboBoxBaseMixin", "module": "src/vaadin-combo-box-base-mixin.js" } }, { "name": "page-size", "type": { "text": "number" }, "description": "Number of items fetched at a time from the dataprovider.", "fieldName": "pageSize", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "name": "pattern", "type": { "text": "string" }, "description": "A regular expression that the value is checked against.\nThe pattern must match the entire value, not just some subset.", "fieldName": "pattern", "inheritedFrom": { "name": "PatternMixin", "package": "@vaadin/field-base/src/pattern-mixin.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "fieldName": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "renderer", "type": { "text": "ComboBoxRenderer | undefined" }, "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.", "fieldName": "renderer", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "required", "type": { "text": "boolean" }, "description": "Specifies that the user must fill in a value.", "fieldName": "required", "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } }, { "name": "selected-item", "type": { "text": "ComboBoxItem | string | undefined" }, "description": "The selected item from the `items` array.", "fieldName": "selectedItem", "inheritedFrom": { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" } }, { "name": "size", "type": { "text": "number" }, "description": "Total number of items.", "fieldName": "size", "inheritedFrom": { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" } }, { "name": "title", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "fieldName": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "value", "type": { "text": "string" }, "description": "The value of the field.", "fieldName": "value", "inheritedFrom": { "name": "InputMixin", "package": "@vaadin/field-base/src/input-mixin.js" } } ], "mixins": [ { "name": "ComboBoxFocusIndexMixin", "module": "src/vaadin-combo-box-focus-index-mixin.js" }, { "name": "ComboBoxDataProviderMixin", "module": "src/vaadin-combo-box-data-provider-mixin.js" }, { "name": "ComboBoxMixin", "module": "src/vaadin-combo-box-mixin.js" }, { "name": "PatternMixin", "package": "@vaadin/field-base/src/pattern-mixin.js" }, { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" }, { "name": "ThemableMixin", "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js" }, { "name": "ElementMixin", "package": "@vaadin/component-base/src/element-mixin.js" }, { "name": "PolylitMixin", "package": "@vaadin/component-base/src/polylit-mixin.js" }, { "name": "LumoInjectionMixin", "package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "vaadin-combo-box", "customElement": true } ], "exports": [ { "kind": "js", "name": "ComboBox", "declaration": { "name": "ComboBox", "module": "src/vaadin-combo-box.js" } } ] } ] }