@leafygreen-ui/combobox 6.0.7 → 6.0.8
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/CHANGELOG.md +6 -0
- package/package.json +2 -2
- package/.turbo/turbo-build.log +0 -23
- package/.turbo/turbo-docs.log +0 -3
- package/.turbo/turbo-tsc.log +0 -1
- package/stories.js +0 -1
- package/tsconfig.tsbuildinfo +0 -1
- package/tsdoc.json +0 -941
package/tsdoc.json
DELETED
|
@@ -1,941 +0,0 @@
|
|
|
1
|
-
[
|
|
2
|
-
{
|
|
3
|
-
"tags": {},
|
|
4
|
-
"description": "",
|
|
5
|
-
"methods": [],
|
|
6
|
-
"displayName": "Chip",
|
|
7
|
-
"props": {
|
|
8
|
-
"ChipProps": {
|
|
9
|
-
"displayName": {
|
|
10
|
-
"name": "displayName",
|
|
11
|
-
"defaultValue": null,
|
|
12
|
-
"description": "",
|
|
13
|
-
"required": true,
|
|
14
|
-
"type": {
|
|
15
|
-
"name": "string"
|
|
16
|
-
},
|
|
17
|
-
"tags": {}
|
|
18
|
-
},
|
|
19
|
-
"isFocused": {
|
|
20
|
-
"name": "isFocused",
|
|
21
|
-
"defaultValue": null,
|
|
22
|
-
"description": "",
|
|
23
|
-
"required": true,
|
|
24
|
-
"type": {
|
|
25
|
-
"name": "enum",
|
|
26
|
-
"raw": "boolean",
|
|
27
|
-
"value": [
|
|
28
|
-
{
|
|
29
|
-
"value": "false"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"value": "true"
|
|
33
|
-
}
|
|
34
|
-
]
|
|
35
|
-
},
|
|
36
|
-
"tags": {}
|
|
37
|
-
},
|
|
38
|
-
"onRemove": {
|
|
39
|
-
"name": "onRemove",
|
|
40
|
-
"defaultValue": null,
|
|
41
|
-
"description": "",
|
|
42
|
-
"required": true,
|
|
43
|
-
"type": {
|
|
44
|
-
"name": "() => void"
|
|
45
|
-
},
|
|
46
|
-
"tags": {}
|
|
47
|
-
},
|
|
48
|
-
"onFocus": {
|
|
49
|
-
"name": "onFocus",
|
|
50
|
-
"defaultValue": null,
|
|
51
|
-
"description": "",
|
|
52
|
-
"required": true,
|
|
53
|
-
"type": {
|
|
54
|
-
"name": "() => void"
|
|
55
|
-
},
|
|
56
|
-
"tags": {}
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
"tags": {},
|
|
63
|
-
"description": "Combobox is a combination of a Select and TextInput,\nallowing the user to either type a value directly or select a value from the list.\nCan be configured to select a single or multiple options.",
|
|
64
|
-
"methods": [],
|
|
65
|
-
"displayName": "Combobox",
|
|
66
|
-
"props": {
|
|
67
|
-
"DOMAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes",
|
|
68
|
-
"HTMLAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes",
|
|
69
|
-
"BaseComboboxProps": {
|
|
70
|
-
"placeholder": {
|
|
71
|
-
"name": "placeholder",
|
|
72
|
-
"defaultValue": {
|
|
73
|
-
"value": "Select"
|
|
74
|
-
},
|
|
75
|
-
"description": "A placeholder for the input element. Uses the native `placeholder` attribute.",
|
|
76
|
-
"required": false,
|
|
77
|
-
"type": {
|
|
78
|
-
"name": "string"
|
|
79
|
-
},
|
|
80
|
-
"tags": {}
|
|
81
|
-
},
|
|
82
|
-
"children": {
|
|
83
|
-
"name": "children",
|
|
84
|
-
"defaultValue": null,
|
|
85
|
-
"description": "Defines the Combobox Options by passing children. Must be `ComboboxOption` or `ComboboxGroup`",
|
|
86
|
-
"required": false,
|
|
87
|
-
"type": {
|
|
88
|
-
"name": "enum",
|
|
89
|
-
"raw": "ReactNode",
|
|
90
|
-
"value": [
|
|
91
|
-
{
|
|
92
|
-
"value": "string"
|
|
93
|
-
},
|
|
94
|
-
{
|
|
95
|
-
"value": "number"
|
|
96
|
-
},
|
|
97
|
-
{
|
|
98
|
-
"value": "false"
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
"value": "true"
|
|
102
|
-
},
|
|
103
|
-
{
|
|
104
|
-
"value": "{}",
|
|
105
|
-
"description": "",
|
|
106
|
-
"fullComment": "",
|
|
107
|
-
"tags": {}
|
|
108
|
-
},
|
|
109
|
-
{
|
|
110
|
-
"value": "ReactElement<any, string | JSXElementConstructor<any>>",
|
|
111
|
-
"description": "",
|
|
112
|
-
"fullComment": "",
|
|
113
|
-
"tags": {}
|
|
114
|
-
},
|
|
115
|
-
{
|
|
116
|
-
"value": "ReactNodeArray",
|
|
117
|
-
"description": "",
|
|
118
|
-
"fullComment": "",
|
|
119
|
-
"tags": {}
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
"value": "ReactPortal",
|
|
123
|
-
"description": "",
|
|
124
|
-
"fullComment": "",
|
|
125
|
-
"tags": {}
|
|
126
|
-
}
|
|
127
|
-
]
|
|
128
|
-
},
|
|
129
|
-
"tags": {}
|
|
130
|
-
},
|
|
131
|
-
"description": {
|
|
132
|
-
"name": "description",
|
|
133
|
-
"defaultValue": null,
|
|
134
|
-
"description": "A description for the input",
|
|
135
|
-
"required": false,
|
|
136
|
-
"type": {
|
|
137
|
-
"name": "string"
|
|
138
|
-
},
|
|
139
|
-
"tags": {}
|
|
140
|
-
},
|
|
141
|
-
"disabled": {
|
|
142
|
-
"name": "disabled",
|
|
143
|
-
"defaultValue": {
|
|
144
|
-
"value": false
|
|
145
|
-
},
|
|
146
|
-
"description": "Disables all interaction with the component",
|
|
147
|
-
"required": false,
|
|
148
|
-
"type": {
|
|
149
|
-
"name": "enum",
|
|
150
|
-
"raw": "boolean",
|
|
151
|
-
"value": [
|
|
152
|
-
{
|
|
153
|
-
"value": "false"
|
|
154
|
-
},
|
|
155
|
-
{
|
|
156
|
-
"value": "true"
|
|
157
|
-
}
|
|
158
|
-
]
|
|
159
|
-
},
|
|
160
|
-
"tags": {}
|
|
161
|
-
},
|
|
162
|
-
"size": {
|
|
163
|
-
"name": "size",
|
|
164
|
-
"defaultValue": {
|
|
165
|
-
"value": "default"
|
|
166
|
-
},
|
|
167
|
-
"description": "Defines the visual size of the component",
|
|
168
|
-
"required": false,
|
|
169
|
-
"type": {
|
|
170
|
-
"name": "enum",
|
|
171
|
-
"raw": "ComboboxSize",
|
|
172
|
-
"value": [
|
|
173
|
-
{
|
|
174
|
-
"value": "\"xsmall\""
|
|
175
|
-
},
|
|
176
|
-
{
|
|
177
|
-
"value": "\"small\""
|
|
178
|
-
},
|
|
179
|
-
{
|
|
180
|
-
"value": "\"default\""
|
|
181
|
-
},
|
|
182
|
-
{
|
|
183
|
-
"value": "\"large\""
|
|
184
|
-
}
|
|
185
|
-
]
|
|
186
|
-
},
|
|
187
|
-
"tags": {}
|
|
188
|
-
},
|
|
189
|
-
"darkMode": {
|
|
190
|
-
"name": "darkMode",
|
|
191
|
-
"defaultValue": null,
|
|
192
|
-
"description": "Toggles Dark Mode",
|
|
193
|
-
"required": false,
|
|
194
|
-
"type": {
|
|
195
|
-
"name": "enum",
|
|
196
|
-
"raw": "boolean",
|
|
197
|
-
"value": [
|
|
198
|
-
{
|
|
199
|
-
"value": "false"
|
|
200
|
-
},
|
|
201
|
-
{
|
|
202
|
-
"value": "true"
|
|
203
|
-
}
|
|
204
|
-
]
|
|
205
|
-
},
|
|
206
|
-
"tags": {}
|
|
207
|
-
},
|
|
208
|
-
"state": {
|
|
209
|
-
"name": "state",
|
|
210
|
-
"defaultValue": {
|
|
211
|
-
"value": "none"
|
|
212
|
-
},
|
|
213
|
-
"description": "The error state of the component. Defines whether the error message is displayed.",
|
|
214
|
-
"required": false,
|
|
215
|
-
"type": {
|
|
216
|
-
"name": "enum",
|
|
217
|
-
"raw": "State",
|
|
218
|
-
"value": [
|
|
219
|
-
{
|
|
220
|
-
"value": "\"none\""
|
|
221
|
-
},
|
|
222
|
-
{
|
|
223
|
-
"value": "\"error\""
|
|
224
|
-
}
|
|
225
|
-
]
|
|
226
|
-
},
|
|
227
|
-
"tags": {}
|
|
228
|
-
},
|
|
229
|
-
"errorMessage": {
|
|
230
|
-
"name": "errorMessage",
|
|
231
|
-
"defaultValue": null,
|
|
232
|
-
"description": "The message shown below the input when state is `error`",
|
|
233
|
-
"required": false,
|
|
234
|
-
"type": {
|
|
235
|
-
"name": "string"
|
|
236
|
-
},
|
|
237
|
-
"tags": {}
|
|
238
|
-
},
|
|
239
|
-
"searchState": {
|
|
240
|
-
"name": "searchState",
|
|
241
|
-
"defaultValue": {
|
|
242
|
-
"value": "unset"
|
|
243
|
-
},
|
|
244
|
-
"description": "The state of search results. Toggles search messages within the menu.",
|
|
245
|
-
"required": false,
|
|
246
|
-
"type": {
|
|
247
|
-
"name": "enum",
|
|
248
|
-
"raw": "SearchState",
|
|
249
|
-
"value": [
|
|
250
|
-
{
|
|
251
|
-
"value": "\"unset\""
|
|
252
|
-
},
|
|
253
|
-
{
|
|
254
|
-
"value": "\"error\""
|
|
255
|
-
},
|
|
256
|
-
{
|
|
257
|
-
"value": "\"loading\""
|
|
258
|
-
}
|
|
259
|
-
]
|
|
260
|
-
},
|
|
261
|
-
"tags": {}
|
|
262
|
-
},
|
|
263
|
-
"searchEmptyMessage": {
|
|
264
|
-
"name": "searchEmptyMessage",
|
|
265
|
-
"defaultValue": {
|
|
266
|
-
"value": "No results found"
|
|
267
|
-
},
|
|
268
|
-
"description": "A message shown within the menu when there are no options passed in as children, or `filteredOptions` is an empty array",
|
|
269
|
-
"required": false,
|
|
270
|
-
"type": {
|
|
271
|
-
"name": "string"
|
|
272
|
-
},
|
|
273
|
-
"tags": {}
|
|
274
|
-
},
|
|
275
|
-
"searchErrorMessage": {
|
|
276
|
-
"name": "searchErrorMessage",
|
|
277
|
-
"defaultValue": {
|
|
278
|
-
"value": "Could not get results!"
|
|
279
|
-
},
|
|
280
|
-
"description": "A message shown within the menu when searchState is `error`",
|
|
281
|
-
"required": false,
|
|
282
|
-
"type": {
|
|
283
|
-
"name": "string"
|
|
284
|
-
},
|
|
285
|
-
"tags": {}
|
|
286
|
-
},
|
|
287
|
-
"searchLoadingMessage": {
|
|
288
|
-
"name": "searchLoadingMessage",
|
|
289
|
-
"defaultValue": {
|
|
290
|
-
"value": "Loading results..."
|
|
291
|
-
},
|
|
292
|
-
"description": "A message shown within the menu when searchState is `loading`",
|
|
293
|
-
"required": false,
|
|
294
|
-
"type": {
|
|
295
|
-
"name": "string"
|
|
296
|
-
},
|
|
297
|
-
"tags": {}
|
|
298
|
-
},
|
|
299
|
-
"onFilter": {
|
|
300
|
-
"name": "onFilter",
|
|
301
|
-
"defaultValue": null,
|
|
302
|
-
"description": "A callback called when the search input changes.\nReceives a single argument that is the current input value.\nUse this callback to set `searchState` and/or `filteredOptions` appropriately",
|
|
303
|
-
"required": false,
|
|
304
|
-
"type": {
|
|
305
|
-
"name": "(value: string) => void"
|
|
306
|
-
},
|
|
307
|
-
"tags": {}
|
|
308
|
-
},
|
|
309
|
-
"clearable": {
|
|
310
|
-
"name": "clearable",
|
|
311
|
-
"defaultValue": {
|
|
312
|
-
"value": true
|
|
313
|
-
},
|
|
314
|
-
"description": "Defines whether the Clear button appears to the right of the input.",
|
|
315
|
-
"required": false,
|
|
316
|
-
"type": {
|
|
317
|
-
"name": "enum",
|
|
318
|
-
"raw": "boolean",
|
|
319
|
-
"value": [
|
|
320
|
-
{
|
|
321
|
-
"value": "false"
|
|
322
|
-
},
|
|
323
|
-
{
|
|
324
|
-
"value": "true"
|
|
325
|
-
}
|
|
326
|
-
]
|
|
327
|
-
},
|
|
328
|
-
"tags": {}
|
|
329
|
-
},
|
|
330
|
-
"onClear": {
|
|
331
|
-
"name": "onClear",
|
|
332
|
-
"defaultValue": null,
|
|
333
|
-
"description": "A callback fired when the Clear button is pressed.\nFired _after_ `onChange`, and _before_ `onFilter`",
|
|
334
|
-
"required": false,
|
|
335
|
-
"type": {
|
|
336
|
-
"name": "(e: MouseEvent<HTMLButtonElement, MouseEvent>) => void"
|
|
337
|
-
},
|
|
338
|
-
"tags": {}
|
|
339
|
-
},
|
|
340
|
-
"filteredOptions": {
|
|
341
|
-
"name": "filteredOptions",
|
|
342
|
-
"defaultValue": null,
|
|
343
|
-
"description": "An array used to define which options are displayed.\nDo not remove options from the JSX children, as this will affect the selected options",
|
|
344
|
-
"required": false,
|
|
345
|
-
"type": {
|
|
346
|
-
"name": "string[]"
|
|
347
|
-
},
|
|
348
|
-
"tags": {}
|
|
349
|
-
},
|
|
350
|
-
"chipTruncationLocation": {
|
|
351
|
-
"name": "chipTruncationLocation",
|
|
352
|
-
"defaultValue": null,
|
|
353
|
-
"description": "Defines where the ellipses appear in a Chip when the length exceeds the `chipCharacterLimit`",
|
|
354
|
-
"required": false,
|
|
355
|
-
"type": {
|
|
356
|
-
"name": "enum",
|
|
357
|
-
"raw": "TruncationLocation",
|
|
358
|
-
"value": [
|
|
359
|
-
{
|
|
360
|
-
"value": "\"start\""
|
|
361
|
-
},
|
|
362
|
-
{
|
|
363
|
-
"value": "\"middle\""
|
|
364
|
-
},
|
|
365
|
-
{
|
|
366
|
-
"value": "\"end\""
|
|
367
|
-
},
|
|
368
|
-
{
|
|
369
|
-
"value": "\"none\""
|
|
370
|
-
}
|
|
371
|
-
]
|
|
372
|
-
},
|
|
373
|
-
"tags": {}
|
|
374
|
-
},
|
|
375
|
-
"chipCharacterLimit": {
|
|
376
|
-
"name": "chipCharacterLimit",
|
|
377
|
-
"defaultValue": {
|
|
378
|
-
"value": 12
|
|
379
|
-
},
|
|
380
|
-
"description": "Defined the character limit of a multiselect Chip before they start truncating.\nNote: the three ellipses dots are included in the character limit.",
|
|
381
|
-
"required": false,
|
|
382
|
-
"type": {
|
|
383
|
-
"name": "number"
|
|
384
|
-
},
|
|
385
|
-
"tags": {}
|
|
386
|
-
},
|
|
387
|
-
"usePortal": {
|
|
388
|
-
"name": "usePortal",
|
|
389
|
-
"defaultValue": {
|
|
390
|
-
"value": true
|
|
391
|
-
},
|
|
392
|
-
"description": "Specifies that the popover content should be rendered at the end of the DOM,\nrather than in the DOM tree.\n\ndefault: `true`",
|
|
393
|
-
"required": false,
|
|
394
|
-
"type": {
|
|
395
|
-
"name": "enum",
|
|
396
|
-
"raw": "boolean",
|
|
397
|
-
"value": [
|
|
398
|
-
{
|
|
399
|
-
"value": "false"
|
|
400
|
-
},
|
|
401
|
-
{
|
|
402
|
-
"value": "true"
|
|
403
|
-
}
|
|
404
|
-
]
|
|
405
|
-
},
|
|
406
|
-
"tags": {}
|
|
407
|
-
},
|
|
408
|
-
"portalClassName": {
|
|
409
|
-
"name": "portalClassName",
|
|
410
|
-
"defaultValue": null,
|
|
411
|
-
"description": "When usePortal is `true`, specifies a class name to apply to the root element of the portal.",
|
|
412
|
-
"required": false,
|
|
413
|
-
"type": {
|
|
414
|
-
"name": "undefined"
|
|
415
|
-
},
|
|
416
|
-
"tags": {}
|
|
417
|
-
},
|
|
418
|
-
"portalContainer": {
|
|
419
|
-
"name": "portalContainer",
|
|
420
|
-
"defaultValue": null,
|
|
421
|
-
"description": "When usePortal is `true`, specifies an element to portal within. The default behavior is to generate a div at the end of the document to render within.",
|
|
422
|
-
"required": false,
|
|
423
|
-
"type": {
|
|
424
|
-
"name": "null"
|
|
425
|
-
},
|
|
426
|
-
"tags": {}
|
|
427
|
-
},
|
|
428
|
-
"scrollContainer": {
|
|
429
|
-
"name": "scrollContainer",
|
|
430
|
-
"defaultValue": null,
|
|
431
|
-
"description": "When usePortal is `true`, specifies the scrollable element to position relative to.",
|
|
432
|
-
"required": false,
|
|
433
|
-
"type": {
|
|
434
|
-
"name": "null"
|
|
435
|
-
},
|
|
436
|
-
"tags": {}
|
|
437
|
-
},
|
|
438
|
-
"popoverZIndex": {
|
|
439
|
-
"name": "popoverZIndex",
|
|
440
|
-
"defaultValue": null,
|
|
441
|
-
"description": "Number that controls the z-index of the popover element directly.",
|
|
442
|
-
"required": false,
|
|
443
|
-
"type": {
|
|
444
|
-
"name": "number"
|
|
445
|
-
},
|
|
446
|
-
"tags": {}
|
|
447
|
-
},
|
|
448
|
-
"label": {
|
|
449
|
-
"name": "label",
|
|
450
|
-
"defaultValue": null,
|
|
451
|
-
"description": "An accessible label for the input, rendered in a <label> to the DOM",
|
|
452
|
-
"required": false,
|
|
453
|
-
"type": {
|
|
454
|
-
"name": "string"
|
|
455
|
-
},
|
|
456
|
-
"tags": {}
|
|
457
|
-
},
|
|
458
|
-
"aria-label": {
|
|
459
|
-
"name": "aria-label",
|
|
460
|
-
"defaultValue": null,
|
|
461
|
-
"description": "An accessible label for the input, used only for screen-readers",
|
|
462
|
-
"required": false,
|
|
463
|
-
"type": {
|
|
464
|
-
"name": "string"
|
|
465
|
-
},
|
|
466
|
-
"tags": {}
|
|
467
|
-
}
|
|
468
|
-
},
|
|
469
|
-
"AriaAttributes": "https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes",
|
|
470
|
-
"ComboboxMultiselectProps": {
|
|
471
|
-
"onChange": {
|
|
472
|
-
"name": "onChange",
|
|
473
|
-
"defaultValue": null,
|
|
474
|
-
"description": "A callback called when the selection changes.\nCallback receives a single argument that is the new selection, either string, or string array",
|
|
475
|
-
"required": false,
|
|
476
|
-
"type": {
|
|
477
|
-
"name": "enum",
|
|
478
|
-
"raw": "((value: string[]) => void) | ((value: string) => void)",
|
|
479
|
-
"value": [
|
|
480
|
-
{
|
|
481
|
-
"value": "(value: string[]) => void",
|
|
482
|
-
"description": "",
|
|
483
|
-
"fullComment": "",
|
|
484
|
-
"tags": {}
|
|
485
|
-
},
|
|
486
|
-
{
|
|
487
|
-
"value": "(value: string) => void",
|
|
488
|
-
"description": "",
|
|
489
|
-
"fullComment": "",
|
|
490
|
-
"tags": {}
|
|
491
|
-
}
|
|
492
|
-
]
|
|
493
|
-
},
|
|
494
|
-
"tags": {}
|
|
495
|
-
},
|
|
496
|
-
"multiselect": {
|
|
497
|
-
"name": "multiselect",
|
|
498
|
-
"defaultValue": {
|
|
499
|
-
"value": "false as M"
|
|
500
|
-
},
|
|
501
|
-
"description": "Defines whether a user can select multiple options, or only a single option.\nWhen using TypeScript, `multiselect` affects the valid values of `initialValue`, `value`, and `onChange`",
|
|
502
|
-
"required": false,
|
|
503
|
-
"type": {
|
|
504
|
-
"name": "enum",
|
|
505
|
-
"raw": "boolean",
|
|
506
|
-
"value": [
|
|
507
|
-
{
|
|
508
|
-
"value": "false"
|
|
509
|
-
},
|
|
510
|
-
{
|
|
511
|
-
"value": "true"
|
|
512
|
-
}
|
|
513
|
-
]
|
|
514
|
-
},
|
|
515
|
-
"tags": {}
|
|
516
|
-
},
|
|
517
|
-
"initialValue": {
|
|
518
|
-
"name": "initialValue",
|
|
519
|
-
"defaultValue": null,
|
|
520
|
-
"description": "The initial selection.\nMust be a string (or array of strings) that matches the `value` prop of a `ComboboxOption`.\nChanging the `initialValue` after initial render will not change the selection.",
|
|
521
|
-
"required": false,
|
|
522
|
-
"type": {
|
|
523
|
-
"name": "enum",
|
|
524
|
-
"raw": "string | string[]",
|
|
525
|
-
"value": [
|
|
526
|
-
{
|
|
527
|
-
"value": "string"
|
|
528
|
-
},
|
|
529
|
-
{
|
|
530
|
-
"value": "string[]",
|
|
531
|
-
"description": "",
|
|
532
|
-
"fullComment": "",
|
|
533
|
-
"tags": {}
|
|
534
|
-
}
|
|
535
|
-
]
|
|
536
|
-
},
|
|
537
|
-
"tags": {}
|
|
538
|
-
},
|
|
539
|
-
"value": {
|
|
540
|
-
"name": "value",
|
|
541
|
-
"defaultValue": null,
|
|
542
|
-
"description": "The controlled value of the Combobox.\nMust be a string (or array of strings) that matches the `value` prop of a `ComboboxOption`.\nChanging `value` after initial render _will_ affect the selection.\n`value` will always take precedence over `initialValue` if both are provided.",
|
|
543
|
-
"required": false,
|
|
544
|
-
"type": {
|
|
545
|
-
"name": "enum",
|
|
546
|
-
"raw": "string | string[]",
|
|
547
|
-
"value": [
|
|
548
|
-
{
|
|
549
|
-
"value": "string"
|
|
550
|
-
},
|
|
551
|
-
{
|
|
552
|
-
"value": "string[]",
|
|
553
|
-
"description": "",
|
|
554
|
-
"fullComment": "",
|
|
555
|
-
"tags": {}
|
|
556
|
-
}
|
|
557
|
-
]
|
|
558
|
-
},
|
|
559
|
-
"tags": {}
|
|
560
|
-
},
|
|
561
|
-
"overflow": {
|
|
562
|
-
"name": "overflow",
|
|
563
|
-
"defaultValue": {
|
|
564
|
-
"value": "expand-y"
|
|
565
|
-
},
|
|
566
|
-
"description": "Defines the overflow behavior of a multiselect combobox.\n\n`expand-y`: Combobox has fixed width, and additional selections will cause the element to grow in the block direction.\n\n`expand-x`: Combobox has fixed height, and additional selections will cause the element to grow in the inline direction.\n\n`scroll-x`: Combobox has fixed height and width, and additional selections will cause the element to be scrollable in the x (horizontal) direction.",
|
|
567
|
-
"required": false,
|
|
568
|
-
"type": {
|
|
569
|
-
"name": "enum",
|
|
570
|
-
"raw": "Overflow",
|
|
571
|
-
"value": [
|
|
572
|
-
{
|
|
573
|
-
"value": "\"expand-y\""
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
"value": "\"scroll-x\""
|
|
577
|
-
},
|
|
578
|
-
{
|
|
579
|
-
"value": "\"expand-x\""
|
|
580
|
-
}
|
|
581
|
-
]
|
|
582
|
-
},
|
|
583
|
-
"tags": {}
|
|
584
|
-
}
|
|
585
|
-
}
|
|
586
|
-
}
|
|
587
|
-
},
|
|
588
|
-
{
|
|
589
|
-
"tags": {},
|
|
590
|
-
"description": "",
|
|
591
|
-
"methods": [],
|
|
592
|
-
"displayName": "ComboboxGroup",
|
|
593
|
-
"props": {
|
|
594
|
-
"ComboboxGroupProps": {
|
|
595
|
-
"label": {
|
|
596
|
-
"name": "label",
|
|
597
|
-
"defaultValue": null,
|
|
598
|
-
"description": "Label for the group of options",
|
|
599
|
-
"required": true,
|
|
600
|
-
"type": {
|
|
601
|
-
"name": "string"
|
|
602
|
-
},
|
|
603
|
-
"tags": {}
|
|
604
|
-
},
|
|
605
|
-
"children": {
|
|
606
|
-
"name": "children",
|
|
607
|
-
"defaultValue": null,
|
|
608
|
-
"description": "Options in the group. Must be one or more `ComboboxOption` components",
|
|
609
|
-
"required": true,
|
|
610
|
-
"type": {
|
|
611
|
-
"name": "enum",
|
|
612
|
-
"raw": "ReactNode",
|
|
613
|
-
"value": [
|
|
614
|
-
{
|
|
615
|
-
"value": "string"
|
|
616
|
-
},
|
|
617
|
-
{
|
|
618
|
-
"value": "number"
|
|
619
|
-
},
|
|
620
|
-
{
|
|
621
|
-
"value": "false"
|
|
622
|
-
},
|
|
623
|
-
{
|
|
624
|
-
"value": "true"
|
|
625
|
-
},
|
|
626
|
-
{
|
|
627
|
-
"value": "{}",
|
|
628
|
-
"description": "",
|
|
629
|
-
"fullComment": "",
|
|
630
|
-
"tags": {}
|
|
631
|
-
},
|
|
632
|
-
{
|
|
633
|
-
"value": "ReactElement<any, string | JSXElementConstructor<any>>",
|
|
634
|
-
"description": "",
|
|
635
|
-
"fullComment": "",
|
|
636
|
-
"tags": {}
|
|
637
|
-
},
|
|
638
|
-
{
|
|
639
|
-
"value": "ReactNodeArray",
|
|
640
|
-
"description": "",
|
|
641
|
-
"fullComment": "",
|
|
642
|
-
"tags": {}
|
|
643
|
-
},
|
|
644
|
-
{
|
|
645
|
-
"value": "ReactPortal",
|
|
646
|
-
"description": "",
|
|
647
|
-
"fullComment": "",
|
|
648
|
-
"tags": {}
|
|
649
|
-
}
|
|
650
|
-
]
|
|
651
|
-
},
|
|
652
|
-
"tags": {}
|
|
653
|
-
},
|
|
654
|
-
"className": {
|
|
655
|
-
"name": "className",
|
|
656
|
-
"defaultValue": null,
|
|
657
|
-
"description": "Styling prop",
|
|
658
|
-
"required": false,
|
|
659
|
-
"type": {
|
|
660
|
-
"name": "string"
|
|
661
|
-
},
|
|
662
|
-
"tags": {}
|
|
663
|
-
}
|
|
664
|
-
}
|
|
665
|
-
}
|
|
666
|
-
},
|
|
667
|
-
{
|
|
668
|
-
"tags": {},
|
|
669
|
-
"description": "",
|
|
670
|
-
"methods": [],
|
|
671
|
-
"displayName": "ComboboxMenu",
|
|
672
|
-
"props": {
|
|
673
|
-
"ComboboxMenuProps": {
|
|
674
|
-
"children": {
|
|
675
|
-
"name": "children",
|
|
676
|
-
"defaultValue": null,
|
|
677
|
-
"description": "",
|
|
678
|
-
"required": false,
|
|
679
|
-
"type": {
|
|
680
|
-
"name": "enum",
|
|
681
|
-
"raw": "ReactNode",
|
|
682
|
-
"value": [
|
|
683
|
-
{
|
|
684
|
-
"value": "string"
|
|
685
|
-
},
|
|
686
|
-
{
|
|
687
|
-
"value": "number"
|
|
688
|
-
},
|
|
689
|
-
{
|
|
690
|
-
"value": "false"
|
|
691
|
-
},
|
|
692
|
-
{
|
|
693
|
-
"value": "true"
|
|
694
|
-
},
|
|
695
|
-
{
|
|
696
|
-
"value": "{}",
|
|
697
|
-
"description": "",
|
|
698
|
-
"fullComment": "",
|
|
699
|
-
"tags": {}
|
|
700
|
-
},
|
|
701
|
-
{
|
|
702
|
-
"value": "ReactElement<any, string | JSXElementConstructor<any>>",
|
|
703
|
-
"description": "",
|
|
704
|
-
"fullComment": "",
|
|
705
|
-
"tags": {}
|
|
706
|
-
},
|
|
707
|
-
{
|
|
708
|
-
"value": "ReactNodeArray",
|
|
709
|
-
"description": "",
|
|
710
|
-
"fullComment": "",
|
|
711
|
-
"tags": {}
|
|
712
|
-
},
|
|
713
|
-
{
|
|
714
|
-
"value": "ReactPortal",
|
|
715
|
-
"description": "",
|
|
716
|
-
"fullComment": "",
|
|
717
|
-
"tags": {}
|
|
718
|
-
}
|
|
719
|
-
]
|
|
720
|
-
},
|
|
721
|
-
"tags": {}
|
|
722
|
-
},
|
|
723
|
-
"refEl": {
|
|
724
|
-
"name": "refEl",
|
|
725
|
-
"defaultValue": null,
|
|
726
|
-
"description": "",
|
|
727
|
-
"required": true,
|
|
728
|
-
"type": {
|
|
729
|
-
"name": "RefObject<HTMLDivElement>"
|
|
730
|
-
},
|
|
731
|
-
"tags": {}
|
|
732
|
-
},
|
|
733
|
-
"id": {
|
|
734
|
-
"name": "id",
|
|
735
|
-
"defaultValue": null,
|
|
736
|
-
"description": "",
|
|
737
|
-
"required": true,
|
|
738
|
-
"type": {
|
|
739
|
-
"name": "string"
|
|
740
|
-
},
|
|
741
|
-
"tags": {}
|
|
742
|
-
},
|
|
743
|
-
"labelId": {
|
|
744
|
-
"name": "labelId",
|
|
745
|
-
"defaultValue": null,
|
|
746
|
-
"description": "",
|
|
747
|
-
"required": true,
|
|
748
|
-
"type": {
|
|
749
|
-
"name": "string"
|
|
750
|
-
},
|
|
751
|
-
"tags": {}
|
|
752
|
-
},
|
|
753
|
-
"menuWidth": {
|
|
754
|
-
"name": "menuWidth",
|
|
755
|
-
"defaultValue": null,
|
|
756
|
-
"description": "",
|
|
757
|
-
"required": true,
|
|
758
|
-
"type": {
|
|
759
|
-
"name": "number"
|
|
760
|
-
},
|
|
761
|
-
"tags": {}
|
|
762
|
-
}
|
|
763
|
-
},
|
|
764
|
-
"BaseComboboxProps": {
|
|
765
|
-
"searchEmptyMessage": {
|
|
766
|
-
"name": "searchEmptyMessage",
|
|
767
|
-
"defaultValue": null,
|
|
768
|
-
"description": "A message shown within the menu when there are no options passed in as children, or `filteredOptions` is an empty array",
|
|
769
|
-
"required": false,
|
|
770
|
-
"type": {
|
|
771
|
-
"name": "string"
|
|
772
|
-
},
|
|
773
|
-
"tags": {}
|
|
774
|
-
},
|
|
775
|
-
"searchErrorMessage": {
|
|
776
|
-
"name": "searchErrorMessage",
|
|
777
|
-
"defaultValue": null,
|
|
778
|
-
"description": "A message shown within the menu when searchState is `error`",
|
|
779
|
-
"required": false,
|
|
780
|
-
"type": {
|
|
781
|
-
"name": "string"
|
|
782
|
-
},
|
|
783
|
-
"tags": {}
|
|
784
|
-
},
|
|
785
|
-
"searchLoadingMessage": {
|
|
786
|
-
"name": "searchLoadingMessage",
|
|
787
|
-
"defaultValue": null,
|
|
788
|
-
"description": "A message shown within the menu when searchState is `loading`",
|
|
789
|
-
"required": false,
|
|
790
|
-
"type": {
|
|
791
|
-
"name": "string"
|
|
792
|
-
},
|
|
793
|
-
"tags": {}
|
|
794
|
-
},
|
|
795
|
-
"usePortal": {
|
|
796
|
-
"name": "usePortal",
|
|
797
|
-
"defaultValue": null,
|
|
798
|
-
"description": "Specifies that the popover content should be rendered at the end of the DOM,\nrather than in the DOM tree.\n\ndefault: `true`",
|
|
799
|
-
"required": false,
|
|
800
|
-
"type": {
|
|
801
|
-
"name": "enum",
|
|
802
|
-
"raw": "boolean",
|
|
803
|
-
"value": [
|
|
804
|
-
{
|
|
805
|
-
"value": "false"
|
|
806
|
-
},
|
|
807
|
-
{
|
|
808
|
-
"value": "true"
|
|
809
|
-
}
|
|
810
|
-
]
|
|
811
|
-
},
|
|
812
|
-
"tags": {}
|
|
813
|
-
},
|
|
814
|
-
"portalClassName": {
|
|
815
|
-
"name": "portalClassName",
|
|
816
|
-
"defaultValue": null,
|
|
817
|
-
"description": "When usePortal is `true`, specifies a class name to apply to the root element of the portal.",
|
|
818
|
-
"required": false,
|
|
819
|
-
"type": {
|
|
820
|
-
"name": "undefined"
|
|
821
|
-
},
|
|
822
|
-
"tags": {}
|
|
823
|
-
},
|
|
824
|
-
"portalContainer": {
|
|
825
|
-
"name": "portalContainer",
|
|
826
|
-
"defaultValue": null,
|
|
827
|
-
"description": "When usePortal is `true`, specifies an element to portal within. The default behavior is to generate a div at the end of the document to render within.",
|
|
828
|
-
"required": false,
|
|
829
|
-
"type": {
|
|
830
|
-
"name": "null"
|
|
831
|
-
},
|
|
832
|
-
"tags": {}
|
|
833
|
-
},
|
|
834
|
-
"scrollContainer": {
|
|
835
|
-
"name": "scrollContainer",
|
|
836
|
-
"defaultValue": null,
|
|
837
|
-
"description": "When usePortal is `true`, specifies the scrollable element to position relative to.",
|
|
838
|
-
"required": false,
|
|
839
|
-
"type": {
|
|
840
|
-
"name": "null"
|
|
841
|
-
},
|
|
842
|
-
"tags": {}
|
|
843
|
-
},
|
|
844
|
-
"popoverZIndex": {
|
|
845
|
-
"name": "popoverZIndex",
|
|
846
|
-
"defaultValue": null,
|
|
847
|
-
"description": "Number that controls the z-index of the popover element directly.",
|
|
848
|
-
"required": false,
|
|
849
|
-
"type": {
|
|
850
|
-
"name": "number"
|
|
851
|
-
},
|
|
852
|
-
"tags": {}
|
|
853
|
-
}
|
|
854
|
-
}
|
|
855
|
-
}
|
|
856
|
-
},
|
|
857
|
-
{
|
|
858
|
-
"tags": {},
|
|
859
|
-
"description": "",
|
|
860
|
-
"methods": [],
|
|
861
|
-
"displayName": "ComboboxOption",
|
|
862
|
-
"props": {
|
|
863
|
-
"DOMAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes",
|
|
864
|
-
"AriaAttributes": "https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes",
|
|
865
|
-
"HTMLAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes",
|
|
866
|
-
"SharedComboboxOptionProps": {
|
|
867
|
-
"onClick": {
|
|
868
|
-
"name": "onClick",
|
|
869
|
-
"defaultValue": null,
|
|
870
|
-
"description": "Callback fired when an option is clicked.",
|
|
871
|
-
"required": false,
|
|
872
|
-
"type": {
|
|
873
|
-
"name": "(event: SyntheticEvent<HTMLLIElement, Event>, value: string) => void"
|
|
874
|
-
},
|
|
875
|
-
"tags": {}
|
|
876
|
-
},
|
|
877
|
-
"description": {
|
|
878
|
-
"name": "description",
|
|
879
|
-
"defaultValue": null,
|
|
880
|
-
"description": "Optional descriptive text under the displayName.",
|
|
881
|
-
"required": false,
|
|
882
|
-
"type": {
|
|
883
|
-
"name": "string"
|
|
884
|
-
},
|
|
885
|
-
"tags": {}
|
|
886
|
-
},
|
|
887
|
-
"disabled": {
|
|
888
|
-
"name": "disabled",
|
|
889
|
-
"defaultValue": {
|
|
890
|
-
"value": false
|
|
891
|
-
},
|
|
892
|
-
"description": "Defines whether the option is disabled.\nNode: disabled options are still rendered in the menu, but not selectable.",
|
|
893
|
-
"required": false,
|
|
894
|
-
"type": {
|
|
895
|
-
"name": "enum",
|
|
896
|
-
"raw": "boolean",
|
|
897
|
-
"value": [
|
|
898
|
-
{
|
|
899
|
-
"value": "false"
|
|
900
|
-
},
|
|
901
|
-
{
|
|
902
|
-
"value": "true"
|
|
903
|
-
}
|
|
904
|
-
]
|
|
905
|
-
},
|
|
906
|
-
"tags": {}
|
|
907
|
-
},
|
|
908
|
-
"glyph": {
|
|
909
|
-
"name": "glyph",
|
|
910
|
-
"defaultValue": null,
|
|
911
|
-
"description": "The icon to display to the left of the option in the menu.",
|
|
912
|
-
"required": false,
|
|
913
|
-
"type": {
|
|
914
|
-
"name": "ReactElement<any, string | JSXElementConstructor<any>>"
|
|
915
|
-
},
|
|
916
|
-
"tags": {}
|
|
917
|
-
},
|
|
918
|
-
"displayName": {
|
|
919
|
-
"name": "displayName",
|
|
920
|
-
"defaultValue": null,
|
|
921
|
-
"description": "The display value of the option. Used as the rendered string within the menu and chips.\nWhen undefined, this is set to `value`",
|
|
922
|
-
"required": false,
|
|
923
|
-
"type": {
|
|
924
|
-
"name": "string"
|
|
925
|
-
},
|
|
926
|
-
"tags": {}
|
|
927
|
-
},
|
|
928
|
-
"value": {
|
|
929
|
-
"name": "value",
|
|
930
|
-
"defaultValue": null,
|
|
931
|
-
"description": "The internal value of the option. Used as the identifier in Combobox `initialValue`, value and filteredOptions.\nWhen undefined, this is set to `_.kebabCase(displayName)`",
|
|
932
|
-
"required": false,
|
|
933
|
-
"type": {
|
|
934
|
-
"name": "string"
|
|
935
|
-
},
|
|
936
|
-
"tags": {}
|
|
937
|
-
}
|
|
938
|
-
}
|
|
939
|
-
}
|
|
940
|
-
}
|
|
941
|
-
]
|