{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "vaadin-select.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-select.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-select-list-box.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-select-list-box.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-select-item.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-select-item.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-select-base-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "SelectBaseMixin", "members": [ { "kind": "field", "name": "accessibleDescriptionRef", "privacy": "public", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.", "attribute": "accessible-description-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the component for 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": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.", "attribute": "accessible-name-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-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": "method", "name": "checkValidity", "description": "Returns true if the current value satisfies all constraints (if any)", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-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": "TabindexMixin", "package": "@vaadin/a11y-base/src/tabindex-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": "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": "items", "privacy": "public", "type": { "text": "!Array" }, "description": "An array containing items that will be rendered as the options of the select.\n\n#### Example\n```js\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\nNote: each item is rendered by default as the internal `` that is an extension of ``.\nTo render the item with a custom component, provide a tag name by the `component` property.", "attribute": "items" }, { "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": "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 element.", "attribute": "name" }, { "kind": "field", "name": "noVerticalOverlap", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.", "attribute": "no-vertical-overlap" }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "Set when the select is open", "attribute": "opened" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.", "attribute": "placeholder" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the element is read-only.", "attribute": "readonly" }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "!SelectRenderer | undefined" }, "description": "Custom function for rendering the content of the ``.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `` element.", "deprecated": "Use a slotted `` or the `items` property instead", "attribute": "renderer" }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of the select.\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.", "deprecated": "This method is deprecated and will be removed in Vaadin 26" }, { "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": "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` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.", "attribute": "value" } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "validated", "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-mixin.js" } } ], "attributes": [ { "name": "accessible-description-ref", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.", "fieldName": "accessibleDescriptionRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the component for screen reader users.", "fieldName": "accessibleName", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name-ref", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.", "fieldName": "accessibleNameRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-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": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "TabindexMixin", "package": "@vaadin/a11y-base/src/tabindex-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": "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": "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": "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 element.", "fieldName": "name" }, { "name": "no-vertical-overlap", "type": { "text": "boolean" }, "description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.", "fieldName": "noVerticalOverlap" }, { "name": "opened", "type": { "text": "boolean" }, "description": "Set when the select is open", "fieldName": "opened" }, { "name": "placeholder", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.", "fieldName": "placeholder" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the element is read-only.", "fieldName": "readonly" }, { "name": "renderer", "type": { "text": "!SelectRenderer | undefined" }, "description": "Custom function for rendering the content of the ``.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `` element.", "deprecated": "Use a slotted `` or the `items` property instead", "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": "value", "type": { "text": "string" }, "description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.", "fieldName": "value" } ], "mixins": [ { "name": "DelegateFocusMixin", "package": "@vaadin/a11y-base/src/delegate-focus-mixin.js" }, { "name": "DelegateStateMixin", "package": "@vaadin/component-base/src/delegate-state-mixin.js" }, { "name": "KeyboardMixin", "package": "@vaadin/a11y-base/src/keyboard-mixin.js" }, { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "SelectBaseMixin", "declaration": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-select-item.js", "declarations": [ { "kind": "class", "description": "`` is a Web Component for creating `` items.\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n-------------|----------------\n`checkmark` | The graphical checkmark shown for a selected item\n`content` | The element that wraps the slot\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-------------|-------------\n`active` | Set when the item is pressed down, either with mouse, touch or the keyboard.\n`disabled` | Set when the item is disabled.\n`focus-ring` | Set when the item is focused using the keyboard.\n`focused` | Set when the item is focused.\n`selected` | Set when the item is selected\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-item-border-radius` |\n| `--vaadin-item-checkmark-color` |\n| `--vaadin-item-gap` |\n| `--vaadin-item-height` |\n| `--vaadin-item-padding` |\n| `--vaadin-item-text-align` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "name": "SelectItem", "members": [ { "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" } }, { "type": { "text": "string" }, "description": "String that can be set to visually represent the selected item in `vaadin-select`.", "name": "label", "kind": "field" }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the item is in selected state.", "attribute": "selected", "inheritedFrom": { "name": "ItemMixin", "package": "@vaadin/item/src/vaadin-item-mixin.js" } }, { "kind": "field", "name": "value", "description": "Submittable string value. The default value is the trimmed text content of the element.", "type": { "text": "string" }, "inheritedFrom": { "name": "ItemMixin", "package": "@vaadin/item/src/vaadin-item-mixin.js" } } ], "attributes": [ { "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": "selected", "type": { "text": "boolean" }, "description": "If true, the item is in selected state.", "fieldName": "selected", "inheritedFrom": { "name": "ItemMixin", "package": "@vaadin/item/src/vaadin-item-mixin.js" } }, { "type": { "text": "string" }, "description": "The theme variants to apply to the component.", "name": "theme" } ], "mixins": [ { "name": "ItemMixin", "package": "@vaadin/item/src/vaadin-item-mixin.js" }, { "name": "ThemableMixin", "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js" }, { "name": "DirMixin", "package": "@vaadin/component-base/src/dir-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-select-item", "customElement": true, "events": [] } ], "exports": [ { "kind": "js", "name": "SelectItem", "declaration": { "name": "SelectItem", "module": "src/vaadin-select-item.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-select-list-box.js", "declarations": [ { "kind": "class", "description": "`` is a Web Component for wrapping `` items.\n\n```html\n\n \n Foo\n Bar\n \n\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n------------------|------------------------\n`items` | The items container\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "name": "SelectListBox", "members": [ { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.", "attribute": "disabled", "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "!Array | undefined" }, "description": "A read-only list of items from which a selection can be made.\nIt is populated from the elements passed to the light DOM,\nand updated dynamically when adding or removing items.", "attribute": "items", "readonly": true, "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "kind": "field", "name": "orientation", "privacy": "public", "type": { "text": "string" }, "description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.", "attribute": "orientation", "readonly": true, "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "number" }, "description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.", "attribute": "selected", "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.", "fieldName": "disabled", "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "name": "orientation", "type": { "text": "string" }, "description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.", "fieldName": "orientation", "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "name": "selected", "type": { "text": "number" }, "description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.", "fieldName": "selected", "inheritedFrom": { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" } }, { "type": { "text": "string" }, "description": "The theme variants to apply to the component.", "name": "theme" } ], "mixins": [ { "name": "ListMixin", "package": "@vaadin/a11y-base/src/list-mixin.js" }, { "name": "ThemableMixin", "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js" }, { "name": "DirMixin", "package": "@vaadin/component-base/src/dir-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-select-list-box", "customElement": true, "events": [] } ], "exports": [ { "kind": "js", "name": "SelectListBox", "declaration": { "name": "SelectListBox", "module": "src/vaadin-select-list-box.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-select-overlay-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "SelectOverlayMixin", "members": [ { "kind": "field", "name": "autofocus", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to move focus into the overlay automatically on open.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.\n\nAn element inside the overlay that has `autofocus` set, such as\n``, receives focus on open instead,\neven when this property is false.", "attribute": "autofocus", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "kind": "method", "name": "bringToFront", "description": "Brings the overlay as visually the frontmost one.", "inheritedFrom": { "name": "OverlayStackMixin", "package": "@vaadin/overlay/src/vaadin-overlay-stack-mixin.js" } }, { "kind": "method", "name": "close", "parameters": [ { "name": "sourceEvent", "type": { "text": "Event=" } } ], "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "kind": "field", "name": "focusTrap", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to move focus into the overlay automatically on open\nand keep it inside: Tab and Shift+Tab cycle through the overlay's\ncontent until the overlay is closed.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.", "attribute": "focus-trap", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.", "attribute": "hidden", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "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": "model", "privacy": "public", "type": { "text": "object" }, "description": "Object with properties that is passed to `renderer` function", "attribute": "model", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "kind": "field", "name": "modeless", "privacy": "public", "type": { "text": "boolean" }, "description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.", "attribute": "modeless", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the overlay is visible and attached to body.", "attribute": "opened", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "kind": "field", "name": "owner", "privacy": "public", "type": { "text": "HTMLElement" }, "description": "Owner element passed with renderer function", "attribute": "owner", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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": "renderer", "privacy": "public", "type": { "text": "OverlayRenderer | null | undefined" }, "description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.", "attribute": "renderer", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of the overlay.\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.", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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", "inheritedFrom": { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" } }, { "kind": "field", "name": "restoreFocusNode", "privacy": "public", "type": { "text": "HTMLElement" }, "description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.", "attribute": "restore-focus-node", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "kind": "field", "name": "restoreFocusOnClose", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to enable restoring of focus when overlay is closed.", "attribute": "restore-focus-on-close", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "kind": "method", "name": "setBounds", "parameters": [ { "name": "bounds", "type": { "text": "!OverlayBoundsParam" } }, { "name": "absolute", "default": "true", "type": { "text": "boolean" } } ], "description": "Updates the coordinates of the overlay.", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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" } }, { "kind": "field", "name": "withBackdrop", "privacy": "public", "type": { "text": "boolean" }, "description": "When true the overlay has backdrop on top of content when opened.", "attribute": "with-backdrop", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } } ], "mixins": [ { "name": "PositionMixin", "package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js" }, { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" }, { "name": "DirMixin", "package": "@vaadin/component-base/src/dir-mixin.js" } ], "parameters": [ { "name": "superClass" } ], "attributes": [ { "name": "autofocus", "type": { "text": "boolean" }, "description": "Set to true to move focus into the overlay automatically on open.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.\n\nAn element inside the overlay that has `autofocus` set, such as\n``, receives focus on open instead,\neven when this property is false.", "fieldName": "autofocus", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "name": "focus-trap", "type": { "text": "boolean" }, "description": "Set to true to move focus into the overlay automatically on open\nand keep it inside: Tab and Shift+Tab cycle through the overlay's\ncontent until the overlay is closed.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.", "fieldName": "focusTrap", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "name": "hidden", "type": { "text": "boolean" }, "description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.", "fieldName": "hidden", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "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": "modeless", "type": { "text": "boolean" }, "description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.", "fieldName": "modeless", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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": "opened", "type": { "text": "boolean" }, "description": "When true, the overlay is visible and attached to body.", "fieldName": "opened", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "name": "owner", "type": { "text": "HTMLElement" }, "description": "Owner element passed with renderer function", "fieldName": "owner", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "name": "renderer", "type": { "text": "OverlayRenderer | null | undefined" }, "description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.", "fieldName": "renderer", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-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": "restore-focus-node", "type": { "text": "HTMLElement" }, "description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.", "fieldName": "restoreFocusNode", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js" } }, { "name": "restore-focus-on-close", "type": { "text": "boolean" }, "description": "Set to true to enable restoring of focus when overlay is closed.", "fieldName": "restoreFocusOnClose", "inheritedFrom": { "name": "OverlayFocusMixin", "package": "@vaadin/overlay/src/vaadin-overlay-focus-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" } }, { "name": "with-backdrop", "type": { "text": "boolean" }, "description": "When true the overlay has backdrop on top of content when opened.", "fieldName": "withBackdrop", "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } } ], "events": [ { "name": "vaadin-overlay-closed", "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } }, { "name": "vaadin-overlay-closing", "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "OverlayMixin", "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js" } } ] } ], "exports": [ { "kind": "js", "name": "SelectOverlayMixin", "declaration": { "name": "SelectOverlayMixin", "module": "src/vaadin-select-overlay-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-select.js", "declarations": [ { "kind": "class", "description": "`` is a Web Component for selecting values from a list of items.\n\n### Items\n\nUse the `items` property to define possible options for the select:\n\n```html\n\n```\n```js\nconst select = document.querySelector('#select');\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\n### Rendering\n\nAlternatively, the content of the select can be populated by using a slotted ``\nwith `` children:\n\n```html\n\n \n Most recent first\n Rating: low to high\n Rating: high to low\n \n\n```\n\n* Hint: By setting the `label` property of inner vaadin-items you will\nbe able to change the visual representation of the selected value in the input part.\n\n#### Renderer (deprecated)\n\nThe content of the select can also be populated by using the renderer callback function, although\nthis approach is deprecated in favor of the `items` property or a slotted ``.\n\nThe renderer function provides `root`, `select` arguments.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `select`.\n\n```js\nconst select = document.querySelector('#select');\nselect.renderer = function(root, select) {\n const listBox = document.createElement('vaadin-list-box');\n // append 3 elements\n ['Jose', 'Manolo', 'Pedro'].forEach(function(name) {\n const item = document.createElement('vaadin-item');\n item.textContent = name;\n item.setAttribute('label', name)\n listBox.appendChild(item);\n });\n\n // update the content\n root.appendChild(listBox);\n};\n```\n\nRenderer is called on initialization of new select and on its opening.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### Styling\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 toggle button\n`field-button` | Set on the toggle 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`backdrop` | Backdrop of the overlay\n`overlay` | The overlay container\n`content` | The overlay content\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`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`phone` | Set when the overlay is shown in phone mode\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------------|\n| `--vaadin-field-default-width` |\n| `--vaadin-input-field-background` |\n| `--vaadin-input-field-border-color` |\n| `--vaadin-input-field-border-radius` |\n| `--vaadin-input-field-border-width` |\n| `--vaadin-input-field-bottom-end-radius` |\n| `--vaadin-input-field-bottom-start-radius` |\n| `--vaadin-input-field-button-text-color` |\n| `--vaadin-input-field-container-gap` |\n| `--vaadin-input-field-disabled-background` |\n| `--vaadin-input-field-disabled-text-color` |\n| `--vaadin-input-field-error-color` |\n| `--vaadin-input-field-error-font-size` |\n| `--vaadin-input-field-error-font-weight` |\n| `--vaadin-input-field-error-line-height` |\n| `--vaadin-input-field-gap` |\n| `--vaadin-input-field-helper-color` |\n| `--vaadin-input-field-helper-font-size` |\n| `--vaadin-input-field-helper-font-weight` |\n| `--vaadin-input-field-helper-line-height` |\n| `--vaadin-input-field-label-color` |\n| `--vaadin-input-field-label-font-size` |\n| `--vaadin-input-field-label-font-weight` |\n| `--vaadin-input-field-label-line-height` |\n| `--vaadin-input-field-padding` |\n| `--vaadin-input-field-placeholder-color` |\n| `--vaadin-input-field-required-indicator` |\n| `--vaadin-input-field-required-indicator-color` |\n| `--vaadin-input-field-top-end-radius` |\n| `--vaadin-input-field-top-start-radius` |\n| `--vaadin-input-field-value-color` |\n| `--vaadin-input-field-value-font-size` |\n| `--vaadin-input-field-value-font-weight` |\n| `--vaadin-input-field-value-line-height` |\n| `--vaadin-item-overlay-padding` |\n| `--vaadin-select-overlay-width` |\n\n### Internal components\n\nIn addition to `` itself, the following internal components are used\nand themable:\n\n- `` - has the same API as [``](#/elements/vaadin-button).\n- [``](#/elements/vaadin-select-list-box) - a list-box element.\n- [``](#/elements/vaadin-select-item) - an item element.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "name": "Select", "members": [ { "kind": "field", "name": "accessibleDescriptionRef", "privacy": "public", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.", "attribute": "accessible-description-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the component for 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": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.", "attribute": "accessible-name-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-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": "method", "name": "checkValidity", "description": "Returns true if the current value satisfies all constraints (if any)", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ValidateMixin", "package": "@vaadin/field-base/src/validate-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": "TabindexMixin", "package": "@vaadin/a11y-base/src/tabindex-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": "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": "items", "privacy": "public", "type": { "text": "!Array" }, "description": "An array containing items that will be rendered as the options of the select.\n\n#### Example\n```js\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\nNote: each item is rendered by default as the internal `` that is an extension of ``.\nTo render the item with a custom component, provide a tag name by the `component` property.", "attribute": "items", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-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": "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 element.", "attribute": "name", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "field", "name": "noVerticalOverlap", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.", "attribute": "no-vertical-overlap", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "field", "name": "opened", "privacy": "public", "type": { "text": "boolean" }, "description": "Set when the select is open", "attribute": "opened", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.", "attribute": "placeholder", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the element is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "field", "name": "renderer", "privacy": "public", "type": { "text": "!SelectRenderer | undefined" }, "description": "Custom function for rendering the content of the ``.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `` element.", "deprecated": "Use a slotted `` or the `items` property instead", "attribute": "renderer", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "kind": "method", "name": "requestContentUpdate", "description": "Requests an update for the content of the select.\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.", "deprecated": "This method is deprecated and will be removed in Vaadin 26", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-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": "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` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.", "attribute": "value", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" }, "description": "Fired when the user commits a value change.", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "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" }, { "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-description-ref", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.", "fieldName": "accessibleDescriptionRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the component for screen reader users.", "fieldName": "accessibleName", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name-ref", "type": { "text": "string" }, "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.", "fieldName": "accessibleNameRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-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": "disabled", "type": { "text": "boolean" }, "description": "If true, the user cannot interact with this element.", "fieldName": "disabled", "inheritedFrom": { "name": "TabindexMixin", "package": "@vaadin/a11y-base/src/tabindex-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": "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": "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": "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 element.", "fieldName": "name", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "name": "no-vertical-overlap", "type": { "text": "boolean" }, "description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.", "fieldName": "noVerticalOverlap", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "name": "opened", "type": { "text": "boolean" }, "description": "Set when the select is open", "fieldName": "opened", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.", "fieldName": "placeholder", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the element is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } }, { "name": "renderer", "type": { "text": "!SelectRenderer | undefined" }, "description": "Custom function for rendering the content of the ``.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `` element.", "deprecated": "Use a slotted `` or the `items` property instead", "fieldName": "renderer", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-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" } }, { "type": { "text": "string" }, "description": "The theme variants to apply to the component.", "name": "theme" }, { "name": "value", "type": { "text": "string" }, "description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.", "fieldName": "value", "inheritedFrom": { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" } } ], "mixins": [ { "name": "SelectBaseMixin", "module": "src/vaadin-select-base-mixin.js" }, { "name": "ElementMixin", "package": "@vaadin/component-base/src/element-mixin.js" }, { "name": "ThemableMixin", "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-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-select", "customElement": true } ], "exports": [ { "kind": "js", "name": "Select", "declaration": { "name": "Select", "module": "src/vaadin-select.js" } } ] } ] }