@vaadin/multi-select-combo-box 25.1.2 → 25.2.0-alpha10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +638 -1
- package/package.json +15 -15
- package/src/vaadin-multi-select-combo-box-mixin.d.ts +10 -0
- package/src/vaadin-multi-select-combo-box-mixin.js +48 -14
- package/web-types.json +88 -228
- package/web-types.lit.json +78 -78
package/web-types.lit.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/multi-select-combo-box",
|
|
4
|
-
"version": "25.
|
|
4
|
+
"version": "25.2.0-alpha10",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -19,6 +19,20 @@
|
|
|
19
19
|
"description": "`<vaadin-multi-select-combo-box>` is a web component that wraps `<vaadin-combo-box>` and extends\nits functionality to allow selecting multiple items, in addition to basic features.\n\n```html\n<vaadin-multi-select-combo-box id=\"comboBox\"></vaadin-multi-select-combo-box>\n```\n```js\nconst comboBox = document.querySelector('#comboBox');\ncomboBox.items = ['apple', 'banana', 'lemon', 'orange'];\ncomboBox.selectedItems = ['lemon', 'orange'];\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n-----------------------|----------------\n`chips` | The element that wraps slotted chips for selected items\n`label` | The label element\n`input-field` | The element that wraps prefix, value and suffix\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 to a disabled element\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`loading` | Set when loading items from the data provider\n`opened` | Set when the dropdown is open\n`readonly` | Set to a readonly element\n\nThe following custom CSS properties are available for styling:\n\nCustom property | Description | Default\n-----------------------------------------------------|----------------------------|--------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n`--vaadin-multi-select-combo-box-overlay-width` | Width of the overlay | `auto`\n`--vaadin-multi-select-combo-box-overlay-max-height` | Max height of the overlay | `65vh`\n`--vaadin-multi-select-combo-box-input-min-width` | Min width of the input | `4em`\n\n### Internal components\n\nIn addition to `<vaadin-multi-select-combo-box>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-multi-select-combo-box-chip>`\n- `<vaadin-multi-select-combo-box-item>` - has the same API as `<vaadin-item>`.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
|
+
{
|
|
23
|
+
"name": ".accessibleName",
|
|
24
|
+
"description": "String used to label the component to screen reader users.",
|
|
25
|
+
"value": {
|
|
26
|
+
"kind": "expression"
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": ".accessibleNameRef",
|
|
31
|
+
"description": "Id of the element used as label of the component to screen reader users.",
|
|
32
|
+
"value": {
|
|
33
|
+
"kind": "expression"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
22
36
|
{
|
|
23
37
|
"name": "?allowCustomValue",
|
|
24
38
|
"description": "When true, the user can input a value that is not present in the items list.",
|
|
@@ -26,6 +40,13 @@
|
|
|
26
40
|
"kind": "expression"
|
|
27
41
|
}
|
|
28
42
|
},
|
|
43
|
+
{
|
|
44
|
+
"name": ".allowedCharPattern",
|
|
45
|
+
"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-]\"`",
|
|
46
|
+
"value": {
|
|
47
|
+
"kind": "expression"
|
|
48
|
+
}
|
|
49
|
+
},
|
|
29
50
|
{
|
|
30
51
|
"name": "?autoExpandHorizontally",
|
|
31
52
|
"description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
|
|
@@ -69,211 +90,197 @@
|
|
|
69
90
|
}
|
|
70
91
|
},
|
|
71
92
|
{
|
|
72
|
-
"name": "?
|
|
73
|
-
"description": "
|
|
93
|
+
"name": "?collapseChips",
|
|
94
|
+
"description": "Set to true to collapse all selected items chips into the overflow\nchip when they don't all fit, instead of showing as many as possible.\nHas no effect when `autoExpandVertically` is true.",
|
|
74
95
|
"value": {
|
|
75
96
|
"kind": "expression"
|
|
76
97
|
}
|
|
77
98
|
},
|
|
78
99
|
{
|
|
79
|
-
"name": "
|
|
80
|
-
"description": "
|
|
81
|
-
"value": {
|
|
82
|
-
"kind": "expression"
|
|
83
|
-
}
|
|
84
|
-
},
|
|
85
|
-
{
|
|
86
|
-
"name": "?keepFilter",
|
|
87
|
-
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
88
|
-
"value": {
|
|
89
|
-
"kind": "expression"
|
|
90
|
-
}
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
"name": "?loading",
|
|
94
|
-
"description": "True when loading items from the data provider, false otherwise.",
|
|
100
|
+
"name": ".dataProvider",
|
|
101
|
+
"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.",
|
|
95
102
|
"value": {
|
|
96
103
|
"kind": "expression"
|
|
97
104
|
}
|
|
98
105
|
},
|
|
99
106
|
{
|
|
100
|
-
"name": "?
|
|
101
|
-
"description": "
|
|
107
|
+
"name": "?disabled",
|
|
108
|
+
"description": "If true, the user cannot interact with this element.",
|
|
102
109
|
"value": {
|
|
103
110
|
"kind": "expression"
|
|
104
111
|
}
|
|
105
112
|
},
|
|
106
113
|
{
|
|
107
|
-
"name": "
|
|
108
|
-
"description": "
|
|
114
|
+
"name": ".errorMessage",
|
|
115
|
+
"description": "Error to show when the field is invalid.",
|
|
109
116
|
"value": {
|
|
110
117
|
"kind": "expression"
|
|
111
118
|
}
|
|
112
119
|
},
|
|
113
120
|
{
|
|
114
|
-
"name": "
|
|
115
|
-
"description": "
|
|
121
|
+
"name": ".filter",
|
|
122
|
+
"description": "Filtering string the user has typed into the input field.",
|
|
116
123
|
"value": {
|
|
117
124
|
"kind": "expression"
|
|
118
125
|
}
|
|
119
126
|
},
|
|
120
127
|
{
|
|
121
|
-
"name": "
|
|
122
|
-
"description": "
|
|
128
|
+
"name": ".filteredItems",
|
|
129
|
+
"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.",
|
|
123
130
|
"value": {
|
|
124
131
|
"kind": "expression"
|
|
125
132
|
}
|
|
126
133
|
},
|
|
127
134
|
{
|
|
128
|
-
"name": "
|
|
129
|
-
"description": "
|
|
135
|
+
"name": ".helperText",
|
|
136
|
+
"description": "String used for the helper text.",
|
|
130
137
|
"value": {
|
|
131
138
|
"kind": "expression"
|
|
132
139
|
}
|
|
133
140
|
},
|
|
134
141
|
{
|
|
135
|
-
"name": ".
|
|
136
|
-
"description": "
|
|
142
|
+
"name": ".i18n",
|
|
143
|
+
"description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n // Screen reader announcement on clear button click.\n cleared: 'Selection cleared',\n // Screen reader announcement when a chip is focused.\n focused: ' focused. Press Backspace to remove',\n // Screen reader announcement when item is selected.\n selected: 'added to selection',\n // Screen reader announcement when item is deselected.\n deselected: 'removed from selection',\n // Screen reader announcement of the selected items count.\n // {count} is replaced with the actual count of items.\n total: '{count} items selected',\n}\n```",
|
|
137
144
|
"value": {
|
|
138
145
|
"kind": "expression"
|
|
139
146
|
}
|
|
140
147
|
},
|
|
141
148
|
{
|
|
142
|
-
"name": "
|
|
143
|
-
"description": "
|
|
149
|
+
"name": "?invalid",
|
|
150
|
+
"description": "Set to true when the field is invalid.",
|
|
144
151
|
"value": {
|
|
145
152
|
"kind": "expression"
|
|
146
153
|
}
|
|
147
154
|
},
|
|
148
155
|
{
|
|
149
|
-
"name": ".
|
|
150
|
-
"description": "A
|
|
156
|
+
"name": ".itemClassNameGenerator",
|
|
157
|
+
"description": "A function used to generate CSS class names for dropdown\nitems and selected chips based on the item. The return\nvalue should be the generated class name as a string, or\nmultiple class names separated by whitespace characters.",
|
|
151
158
|
"value": {
|
|
152
159
|
"kind": "expression"
|
|
153
160
|
}
|
|
154
161
|
},
|
|
155
162
|
{
|
|
156
|
-
"name": ".
|
|
157
|
-
"description": "
|
|
163
|
+
"name": ".itemIdPath",
|
|
164
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
158
165
|
"value": {
|
|
159
166
|
"kind": "expression"
|
|
160
167
|
}
|
|
161
168
|
},
|
|
162
169
|
{
|
|
163
|
-
"name": ".
|
|
164
|
-
"description": "
|
|
170
|
+
"name": ".itemLabelGenerator",
|
|
171
|
+
"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.",
|
|
165
172
|
"value": {
|
|
166
173
|
"kind": "expression"
|
|
167
174
|
}
|
|
168
175
|
},
|
|
169
176
|
{
|
|
170
|
-
"name": ".
|
|
171
|
-
"description": "
|
|
177
|
+
"name": ".itemLabelPath",
|
|
178
|
+
"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.",
|
|
172
179
|
"value": {
|
|
173
180
|
"kind": "expression"
|
|
174
181
|
}
|
|
175
182
|
},
|
|
176
183
|
{
|
|
177
|
-
"name": ".
|
|
178
|
-
"description": "A
|
|
184
|
+
"name": ".items",
|
|
185
|
+
"description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.",
|
|
179
186
|
"value": {
|
|
180
187
|
"kind": "expression"
|
|
181
188
|
}
|
|
182
189
|
},
|
|
183
190
|
{
|
|
184
|
-
"name": ".
|
|
185
|
-
"description": "
|
|
191
|
+
"name": ".itemValuePath",
|
|
192
|
+
"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.",
|
|
186
193
|
"value": {
|
|
187
194
|
"kind": "expression"
|
|
188
195
|
}
|
|
189
196
|
},
|
|
190
197
|
{
|
|
191
|
-
"name": "
|
|
192
|
-
"description": "
|
|
198
|
+
"name": "?keepFilter",
|
|
199
|
+
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
193
200
|
"value": {
|
|
194
201
|
"kind": "expression"
|
|
195
202
|
}
|
|
196
203
|
},
|
|
197
204
|
{
|
|
198
|
-
"name": ".
|
|
199
|
-
"description": "
|
|
205
|
+
"name": ".label",
|
|
206
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
200
207
|
"value": {
|
|
201
208
|
"kind": "expression"
|
|
202
209
|
}
|
|
203
210
|
},
|
|
204
211
|
{
|
|
205
|
-
"name": "
|
|
206
|
-
"description": "
|
|
212
|
+
"name": "?loading",
|
|
213
|
+
"description": "True when loading items from the data provider, false otherwise.",
|
|
207
214
|
"value": {
|
|
208
215
|
"kind": "expression"
|
|
209
216
|
}
|
|
210
217
|
},
|
|
211
218
|
{
|
|
212
|
-
"name": "
|
|
213
|
-
"description": "
|
|
219
|
+
"name": "?manualValidation",
|
|
220
|
+
"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.",
|
|
214
221
|
"value": {
|
|
215
222
|
"kind": "expression"
|
|
216
223
|
}
|
|
217
224
|
},
|
|
218
225
|
{
|
|
219
|
-
"name": ".
|
|
220
|
-
"description": "
|
|
226
|
+
"name": ".name",
|
|
227
|
+
"description": "The name of this field.",
|
|
221
228
|
"value": {
|
|
222
229
|
"kind": "expression"
|
|
223
230
|
}
|
|
224
231
|
},
|
|
225
232
|
{
|
|
226
|
-
"name": "
|
|
227
|
-
"description": "
|
|
233
|
+
"name": "?opened",
|
|
234
|
+
"description": "True if the dropdown is open, false otherwise.",
|
|
228
235
|
"value": {
|
|
229
236
|
"kind": "expression"
|
|
230
237
|
}
|
|
231
238
|
},
|
|
232
239
|
{
|
|
233
|
-
"name": ".
|
|
234
|
-
"description": "
|
|
240
|
+
"name": ".pageSize",
|
|
241
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
235
242
|
"value": {
|
|
236
243
|
"kind": "expression"
|
|
237
244
|
}
|
|
238
245
|
},
|
|
239
246
|
{
|
|
240
|
-
"name": ".
|
|
241
|
-
"description": "
|
|
247
|
+
"name": ".placeholder",
|
|
248
|
+
"description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
|
|
242
249
|
"value": {
|
|
243
250
|
"kind": "expression"
|
|
244
251
|
}
|
|
245
252
|
},
|
|
246
253
|
{
|
|
247
|
-
"name": "
|
|
248
|
-
"description": "
|
|
254
|
+
"name": "?readonly",
|
|
255
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
249
256
|
"value": {
|
|
250
257
|
"kind": "expression"
|
|
251
258
|
}
|
|
252
259
|
},
|
|
253
260
|
{
|
|
254
|
-
"name": ".
|
|
255
|
-
"description": "
|
|
261
|
+
"name": ".renderer",
|
|
262
|
+
"description": "Custom function for rendering the content of every item.\nReceives three arguments:\n\n- `root` The `<vaadin-multi-select-combo-box-item>` internal container DOM element.\n- `comboBox` The reference to the `<vaadin-multi-select-combo-box>` 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.",
|
|
256
263
|
"value": {
|
|
257
264
|
"kind": "expression"
|
|
258
265
|
}
|
|
259
266
|
},
|
|
260
267
|
{
|
|
261
|
-
"name": "
|
|
262
|
-
"description": "
|
|
268
|
+
"name": "?required",
|
|
269
|
+
"description": "Specifies that the user must fill in a value.",
|
|
263
270
|
"value": {
|
|
264
271
|
"kind": "expression"
|
|
265
272
|
}
|
|
266
273
|
},
|
|
267
274
|
{
|
|
268
|
-
"name": ".
|
|
269
|
-
"description": "
|
|
275
|
+
"name": ".selectedItems",
|
|
276
|
+
"description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
|
|
270
277
|
"value": {
|
|
271
278
|
"kind": "expression"
|
|
272
279
|
}
|
|
273
280
|
},
|
|
274
281
|
{
|
|
275
|
-
"name": "
|
|
276
|
-
"description": "
|
|
282
|
+
"name": "?selectedItemsOnTop",
|
|
283
|
+
"description": "Set to true to group selected items at the top of the overlay.",
|
|
277
284
|
"value": {
|
|
278
285
|
"kind": "expression"
|
|
279
286
|
}
|
|
@@ -313,13 +320,6 @@
|
|
|
313
320
|
"kind": "expression"
|
|
314
321
|
}
|
|
315
322
|
},
|
|
316
|
-
{
|
|
317
|
-
"name": "@input",
|
|
318
|
-
"description": "Fired when the value is changed by the user: on every typing keystroke,\nand the value is cleared using the clear button.",
|
|
319
|
-
"value": {
|
|
320
|
-
"kind": "expression"
|
|
321
|
-
}
|
|
322
|
-
},
|
|
323
323
|
{
|
|
324
324
|
"name": "@invalid-changed",
|
|
325
325
|
"description": "Fired when the `invalid` property changes.",
|