@workday/canvas-kit-react 11.1.0 → 11.1.1
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/dist/commonjs/select/lib/Select.d.ts +1306 -57
- package/dist/commonjs/select/lib/Select.d.ts.map +1 -1
- package/dist/commonjs/select/lib/Select.js +8 -22
- package/dist/commonjs/select/lib/hooks/useSelectInput.d.ts +1 -2
- package/dist/commonjs/select/lib/hooks/useSelectInput.d.ts.map +1 -1
- package/dist/commonjs/select/lib/hooks/useSelectInput.js +20 -4
- package/dist/es6/select/lib/Select.d.ts +1306 -57
- package/dist/es6/select/lib/Select.d.ts.map +1 -1
- package/dist/es6/select/lib/Select.js +9 -23
- package/dist/es6/select/lib/hooks/useSelectInput.d.ts +1 -2
- package/dist/es6/select/lib/hooks/useSelectInput.d.ts.map +1 -1
- package/dist/es6/select/lib/hooks/useSelectInput.js +20 -4
- package/package.json +4 -4
- package/select/lib/Select.tsx +1 -23
- package/select/lib/hooks/useSelectInput.ts +29 -4
|
@@ -39,13 +39,35 @@ export declare const SelectInput: import("@workday/canvas-kit-react/common").Ele
|
|
|
39
39
|
measure: () => void;
|
|
40
40
|
};
|
|
41
41
|
UNSTABLE_defaultItemHeight: number;
|
|
42
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
42
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
43
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
44
|
+
*
|
|
45
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
46
|
+
*
|
|
47
|
+
* ```tsx
|
|
48
|
+
* <Select items={options}>
|
|
49
|
+
* <FormField label="Your Label">
|
|
50
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
51
|
+
* <Select.Popper>
|
|
52
|
+
* <Select.Card>
|
|
53
|
+
* ...
|
|
54
|
+
* </Select.Card>
|
|
55
|
+
* </Select.Popper>
|
|
56
|
+
* </FormField>
|
|
57
|
+
* </Select>
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
43
60
|
orientation: "horizontal" | "vertical";
|
|
44
61
|
indexRef: React.MutableRefObject<number>;
|
|
45
62
|
nonInteractiveIds: string[];
|
|
46
63
|
isVirtualized: boolean;
|
|
47
64
|
items: import("../..").Item<any>[];
|
|
48
65
|
mode: "multiple" | "single";
|
|
66
|
+
/**
|
|
67
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
68
|
+
* include icons that you would like to render in the `input` when selected.
|
|
69
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
70
|
+
*/
|
|
49
71
|
value: string | undefined;
|
|
50
72
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
51
73
|
width: number;
|
|
@@ -116,13 +138,35 @@ export declare const SelectItem: import("@workday/canvas-kit-react/common").Elem
|
|
|
116
138
|
measure: () => void;
|
|
117
139
|
};
|
|
118
140
|
UNSTABLE_defaultItemHeight: number;
|
|
119
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
141
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
142
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
143
|
+
*
|
|
144
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
145
|
+
*
|
|
146
|
+
* ```tsx
|
|
147
|
+
* <Select items={options}>
|
|
148
|
+
* <FormField label="Your Label">
|
|
149
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
150
|
+
* <Select.Popper>
|
|
151
|
+
* <Select.Card>
|
|
152
|
+
* ...
|
|
153
|
+
* </Select.Card>
|
|
154
|
+
* </Select.Popper>
|
|
155
|
+
* </FormField>
|
|
156
|
+
* </Select>
|
|
157
|
+
* ```
|
|
158
|
+
*/
|
|
120
159
|
orientation: "horizontal" | "vertical";
|
|
121
160
|
indexRef: React.MutableRefObject<number>;
|
|
122
161
|
nonInteractiveIds: string[];
|
|
123
162
|
isVirtualized: boolean;
|
|
124
163
|
items: import("../..").Item<any>[];
|
|
125
164
|
mode: "multiple" | "single";
|
|
165
|
+
/**
|
|
166
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
167
|
+
* include icons that you would like to render in the `input` when selected.
|
|
168
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
169
|
+
*/
|
|
126
170
|
value: string | undefined;
|
|
127
171
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
128
172
|
width: number;
|
|
@@ -192,13 +236,35 @@ export declare const SelectItem: import("@workday/canvas-kit-react/common").Elem
|
|
|
192
236
|
measure: () => void;
|
|
193
237
|
};
|
|
194
238
|
UNSTABLE_defaultItemHeight: number;
|
|
195
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
239
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
240
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
241
|
+
*
|
|
242
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
243
|
+
*
|
|
244
|
+
* ```tsx
|
|
245
|
+
* <Select items={options}>
|
|
246
|
+
* <FormField label="Your Label">
|
|
247
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
248
|
+
* <Select.Popper>
|
|
249
|
+
* <Select.Card>
|
|
250
|
+
* ...
|
|
251
|
+
* </Select.Card>
|
|
252
|
+
* </Select.Popper>
|
|
253
|
+
* </FormField>
|
|
254
|
+
* </Select>
|
|
255
|
+
* ```
|
|
256
|
+
*/
|
|
196
257
|
orientation: "horizontal" | "vertical";
|
|
197
258
|
indexRef: React.MutableRefObject<number>;
|
|
198
259
|
nonInteractiveIds: string[];
|
|
199
260
|
isVirtualized: boolean;
|
|
200
261
|
items: import("../..").Item<any>[];
|
|
201
262
|
mode: "multiple" | "single";
|
|
263
|
+
/**
|
|
264
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
265
|
+
* include icons that you would like to render in the `input` when selected.
|
|
266
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
267
|
+
*/
|
|
202
268
|
value: string | undefined;
|
|
203
269
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
204
270
|
width: number;
|
|
@@ -269,13 +335,35 @@ export declare const SelectItem: import("@workday/canvas-kit-react/common").Elem
|
|
|
269
335
|
measure: () => void;
|
|
270
336
|
};
|
|
271
337
|
UNSTABLE_defaultItemHeight: number;
|
|
272
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
338
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
339
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
340
|
+
*
|
|
341
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
342
|
+
*
|
|
343
|
+
* ```tsx
|
|
344
|
+
* <Select items={options}>
|
|
345
|
+
* <FormField label="Your Label">
|
|
346
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
347
|
+
* <Select.Popper>
|
|
348
|
+
* <Select.Card>
|
|
349
|
+
* ...
|
|
350
|
+
* </Select.Card>
|
|
351
|
+
* </Select.Popper>
|
|
352
|
+
* </FormField>
|
|
353
|
+
* </Select>
|
|
354
|
+
* ```
|
|
355
|
+
*/
|
|
273
356
|
orientation: "horizontal" | "vertical";
|
|
274
357
|
indexRef: React.MutableRefObject<number>;
|
|
275
358
|
nonInteractiveIds: string[];
|
|
276
359
|
isVirtualized: boolean;
|
|
277
360
|
items: import("../..").Item<any>[];
|
|
278
361
|
mode: "multiple" | "single";
|
|
362
|
+
/**
|
|
363
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
364
|
+
* include icons that you would like to render in the `input` when selected.
|
|
365
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
366
|
+
*/
|
|
279
367
|
value: string | undefined;
|
|
280
368
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
281
369
|
width: number;
|
|
@@ -347,13 +435,35 @@ export declare const SelectCard: import("@workday/canvas-kit-react/common").Elem
|
|
|
347
435
|
measure: () => void;
|
|
348
436
|
};
|
|
349
437
|
UNSTABLE_defaultItemHeight: number;
|
|
350
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
438
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
439
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
440
|
+
*
|
|
441
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
442
|
+
*
|
|
443
|
+
* ```tsx
|
|
444
|
+
* <Select items={options}>
|
|
445
|
+
* <FormField label="Your Label">
|
|
446
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
447
|
+
* <Select.Popper>
|
|
448
|
+
* <Select.Card>
|
|
449
|
+
* ...
|
|
450
|
+
* </Select.Card>
|
|
451
|
+
* </Select.Popper>
|
|
452
|
+
* </FormField>
|
|
453
|
+
* </Select>
|
|
454
|
+
* ```
|
|
455
|
+
*/
|
|
351
456
|
orientation: "horizontal" | "vertical";
|
|
352
457
|
indexRef: React.MutableRefObject<number>;
|
|
353
458
|
nonInteractiveIds: string[];
|
|
354
459
|
isVirtualized: boolean;
|
|
355
460
|
items: import("../..").Item<any>[];
|
|
356
461
|
mode: "multiple" | "single";
|
|
462
|
+
/**
|
|
463
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
464
|
+
* include icons that you would like to render in the `input` when selected.
|
|
465
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
466
|
+
*/
|
|
357
467
|
value: string | undefined;
|
|
358
468
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
359
469
|
width: number;
|
|
@@ -423,13 +533,35 @@ export declare const SelectCard: import("@workday/canvas-kit-react/common").Elem
|
|
|
423
533
|
measure: () => void;
|
|
424
534
|
};
|
|
425
535
|
UNSTABLE_defaultItemHeight: number;
|
|
426
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
536
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
537
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
538
|
+
*
|
|
539
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
540
|
+
*
|
|
541
|
+
* ```tsx
|
|
542
|
+
* <Select items={options}>
|
|
543
|
+
* <FormField label="Your Label">
|
|
544
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
545
|
+
* <Select.Popper>
|
|
546
|
+
* <Select.Card>
|
|
547
|
+
* ...
|
|
548
|
+
* </Select.Card>
|
|
549
|
+
* </Select.Popper>
|
|
550
|
+
* </FormField>
|
|
551
|
+
* </Select>
|
|
552
|
+
* ```
|
|
553
|
+
*/
|
|
427
554
|
orientation: "horizontal" | "vertical";
|
|
428
555
|
indexRef: React.MutableRefObject<number>;
|
|
429
556
|
nonInteractiveIds: string[];
|
|
430
557
|
isVirtualized: boolean;
|
|
431
558
|
items: import("../..").Item<any>[];
|
|
432
559
|
mode: "multiple" | "single";
|
|
560
|
+
/**
|
|
561
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
562
|
+
* include icons that you would like to render in the `input` when selected.
|
|
563
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
564
|
+
*/
|
|
433
565
|
value: string | undefined;
|
|
434
566
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
435
567
|
width: number;
|
|
@@ -544,13 +676,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
544
676
|
measure: () => void;
|
|
545
677
|
};
|
|
546
678
|
UNSTABLE_defaultItemHeight: number;
|
|
547
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
679
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
680
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
681
|
+
*
|
|
682
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
683
|
+
*
|
|
684
|
+
* ```tsx
|
|
685
|
+
* <Select items={options}>
|
|
686
|
+
* <FormField label="Your Label">
|
|
687
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
688
|
+
* <Select.Popper>
|
|
689
|
+
* <Select.Card>
|
|
690
|
+
* ...
|
|
691
|
+
* </Select.Card>
|
|
692
|
+
* </Select.Popper>
|
|
693
|
+
* </FormField>
|
|
694
|
+
* </Select>
|
|
695
|
+
* ```
|
|
696
|
+
*/
|
|
548
697
|
orientation: "horizontal" | "vertical";
|
|
549
698
|
indexRef: React.MutableRefObject<number>;
|
|
550
699
|
nonInteractiveIds: string[];
|
|
551
700
|
isVirtualized: boolean;
|
|
552
701
|
items: import("../..").Item<any>[];
|
|
553
702
|
mode: "multiple" | "single";
|
|
703
|
+
/**
|
|
704
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
705
|
+
* include icons that you would like to render in the `input` when selected.
|
|
706
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
707
|
+
*/
|
|
554
708
|
value: string | undefined;
|
|
555
709
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
556
710
|
width: number;
|
|
@@ -581,13 +735,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
581
735
|
measure: () => void;
|
|
582
736
|
};
|
|
583
737
|
UNSTABLE_defaultItemHeight: number;
|
|
584
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
738
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
739
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
740
|
+
*
|
|
741
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
742
|
+
*
|
|
743
|
+
* ```tsx
|
|
744
|
+
* <Select items={options}>
|
|
745
|
+
* <FormField label="Your Label">
|
|
746
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
747
|
+
* <Select.Popper>
|
|
748
|
+
* <Select.Card>
|
|
749
|
+
* ...
|
|
750
|
+
* </Select.Card>
|
|
751
|
+
* </Select.Popper>
|
|
752
|
+
* </FormField>
|
|
753
|
+
* </Select>
|
|
754
|
+
* ```
|
|
755
|
+
*/
|
|
585
756
|
orientation: "horizontal" | "vertical";
|
|
586
757
|
indexRef: React.MutableRefObject<number>;
|
|
587
758
|
nonInteractiveIds: string[];
|
|
588
759
|
isVirtualized: boolean;
|
|
589
760
|
items: import("../..").Item<any>[];
|
|
590
761
|
mode: "multiple" | "single";
|
|
762
|
+
/**
|
|
763
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
764
|
+
* include icons that you would like to render in the `input` when selected.
|
|
765
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
766
|
+
*/
|
|
591
767
|
value: string | undefined;
|
|
592
768
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
593
769
|
width: number;
|
|
@@ -616,13 +792,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
616
792
|
measure: () => void;
|
|
617
793
|
};
|
|
618
794
|
UNSTABLE_defaultItemHeight: number;
|
|
619
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
795
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
796
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
797
|
+
*
|
|
798
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
799
|
+
*
|
|
800
|
+
* ```tsx
|
|
801
|
+
* <Select items={options}>
|
|
802
|
+
* <FormField label="Your Label">
|
|
803
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
804
|
+
* <Select.Popper>
|
|
805
|
+
* <Select.Card>
|
|
806
|
+
* ...
|
|
807
|
+
* </Select.Card>
|
|
808
|
+
* </Select.Popper>
|
|
809
|
+
* </FormField>
|
|
810
|
+
* </Select>
|
|
811
|
+
* ```
|
|
812
|
+
*/
|
|
620
813
|
orientation: "horizontal" | "vertical";
|
|
621
814
|
indexRef: React.MutableRefObject<number>;
|
|
622
815
|
nonInteractiveIds: string[];
|
|
623
816
|
isVirtualized: boolean;
|
|
624
817
|
items: import("../..").Item<any>[];
|
|
625
818
|
mode: "multiple" | "single";
|
|
819
|
+
/**
|
|
820
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
821
|
+
* include icons that you would like to render in the `input` when selected.
|
|
822
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
823
|
+
*/
|
|
626
824
|
value: string | undefined;
|
|
627
825
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
628
826
|
width: number;
|
|
@@ -651,13 +849,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
651
849
|
measure: () => void;
|
|
652
850
|
};
|
|
653
851
|
UNSTABLE_defaultItemHeight: number;
|
|
654
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
852
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
853
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
854
|
+
*
|
|
855
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
856
|
+
*
|
|
857
|
+
* ```tsx
|
|
858
|
+
* <Select items={options}>
|
|
859
|
+
* <FormField label="Your Label">
|
|
860
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
861
|
+
* <Select.Popper>
|
|
862
|
+
* <Select.Card>
|
|
863
|
+
* ...
|
|
864
|
+
* </Select.Card>
|
|
865
|
+
* </Select.Popper>
|
|
866
|
+
* </FormField>
|
|
867
|
+
* </Select>
|
|
868
|
+
* ```
|
|
869
|
+
*/
|
|
655
870
|
orientation: "horizontal" | "vertical";
|
|
656
871
|
indexRef: React.MutableRefObject<number>;
|
|
657
872
|
nonInteractiveIds: string[];
|
|
658
873
|
isVirtualized: boolean;
|
|
659
874
|
items: import("../..").Item<any>[];
|
|
660
875
|
mode: "multiple" | "single";
|
|
876
|
+
/**
|
|
877
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
878
|
+
* include icons that you would like to render in the `input` when selected.
|
|
879
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
880
|
+
*/
|
|
661
881
|
value: string | undefined;
|
|
662
882
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
663
883
|
width: number;
|
|
@@ -688,13 +908,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
688
908
|
measure: () => void;
|
|
689
909
|
};
|
|
690
910
|
UNSTABLE_defaultItemHeight: number;
|
|
691
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
911
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
912
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
913
|
+
*
|
|
914
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
915
|
+
*
|
|
916
|
+
* ```tsx
|
|
917
|
+
* <Select items={options}>
|
|
918
|
+
* <FormField label="Your Label">
|
|
919
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
920
|
+
* <Select.Popper>
|
|
921
|
+
* <Select.Card>
|
|
922
|
+
* ...
|
|
923
|
+
* </Select.Card>
|
|
924
|
+
* </Select.Popper>
|
|
925
|
+
* </FormField>
|
|
926
|
+
* </Select>
|
|
927
|
+
* ```
|
|
928
|
+
*/
|
|
692
929
|
orientation: "horizontal" | "vertical";
|
|
693
930
|
indexRef: React.MutableRefObject<number>;
|
|
694
931
|
nonInteractiveIds: string[];
|
|
695
932
|
isVirtualized: boolean;
|
|
696
933
|
items: import("../..").Item<any>[];
|
|
697
934
|
mode: "multiple" | "single";
|
|
935
|
+
/**
|
|
936
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
937
|
+
* include icons that you would like to render in the `input` when selected.
|
|
938
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
939
|
+
*/
|
|
698
940
|
value: string | undefined;
|
|
699
941
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
700
942
|
width: number;
|
|
@@ -723,13 +965,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
723
965
|
measure: () => void;
|
|
724
966
|
};
|
|
725
967
|
UNSTABLE_defaultItemHeight: number;
|
|
726
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
968
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
969
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
970
|
+
*
|
|
971
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
972
|
+
*
|
|
973
|
+
* ```tsx
|
|
974
|
+
* <Select items={options}>
|
|
975
|
+
* <FormField label="Your Label">
|
|
976
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
977
|
+
* <Select.Popper>
|
|
978
|
+
* <Select.Card>
|
|
979
|
+
* ...
|
|
980
|
+
* </Select.Card>
|
|
981
|
+
* </Select.Popper>
|
|
982
|
+
* </FormField>
|
|
983
|
+
* </Select>
|
|
984
|
+
* ```
|
|
985
|
+
*/
|
|
727
986
|
orientation: "horizontal" | "vertical";
|
|
728
987
|
indexRef: React.MutableRefObject<number>;
|
|
729
988
|
nonInteractiveIds: string[];
|
|
730
989
|
isVirtualized: boolean;
|
|
731
990
|
items: import("../..").Item<any>[];
|
|
732
991
|
mode: "multiple" | "single";
|
|
992
|
+
/**
|
|
993
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
994
|
+
* include icons that you would like to render in the `input` when selected.
|
|
995
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
996
|
+
*/
|
|
733
997
|
value: string | undefined;
|
|
734
998
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
735
999
|
width: number;
|
|
@@ -758,13 +1022,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
758
1022
|
measure: () => void;
|
|
759
1023
|
};
|
|
760
1024
|
UNSTABLE_defaultItemHeight: number;
|
|
761
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1025
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1026
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1027
|
+
*
|
|
1028
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1029
|
+
*
|
|
1030
|
+
* ```tsx
|
|
1031
|
+
* <Select items={options}>
|
|
1032
|
+
* <FormField label="Your Label">
|
|
1033
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1034
|
+
* <Select.Popper>
|
|
1035
|
+
* <Select.Card>
|
|
1036
|
+
* ...
|
|
1037
|
+
* </Select.Card>
|
|
1038
|
+
* </Select.Popper>
|
|
1039
|
+
* </FormField>
|
|
1040
|
+
* </Select>
|
|
1041
|
+
* ```
|
|
1042
|
+
*/
|
|
762
1043
|
orientation: "horizontal" | "vertical";
|
|
763
1044
|
indexRef: React.MutableRefObject<number>;
|
|
764
1045
|
nonInteractiveIds: string[];
|
|
765
1046
|
isVirtualized: boolean;
|
|
766
1047
|
items: import("../..").Item<any>[];
|
|
767
1048
|
mode: "multiple" | "single";
|
|
1049
|
+
/**
|
|
1050
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1051
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1052
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1053
|
+
*/
|
|
768
1054
|
value: string | undefined;
|
|
769
1055
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
770
1056
|
width: number;
|
|
@@ -795,13 +1081,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
795
1081
|
measure: () => void;
|
|
796
1082
|
};
|
|
797
1083
|
UNSTABLE_defaultItemHeight: number;
|
|
798
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1084
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1085
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1086
|
+
*
|
|
1087
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1088
|
+
*
|
|
1089
|
+
* ```tsx
|
|
1090
|
+
* <Select items={options}>
|
|
1091
|
+
* <FormField label="Your Label">
|
|
1092
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1093
|
+
* <Select.Popper>
|
|
1094
|
+
* <Select.Card>
|
|
1095
|
+
* ...
|
|
1096
|
+
* </Select.Card>
|
|
1097
|
+
* </Select.Popper>
|
|
1098
|
+
* </FormField>
|
|
1099
|
+
* </Select>
|
|
1100
|
+
* ```
|
|
1101
|
+
*/
|
|
799
1102
|
orientation: "horizontal" | "vertical";
|
|
800
1103
|
indexRef: React.MutableRefObject<number>;
|
|
801
1104
|
nonInteractiveIds: string[];
|
|
802
1105
|
isVirtualized: boolean;
|
|
803
1106
|
items: import("../..").Item<any>[];
|
|
804
1107
|
mode: "multiple" | "single";
|
|
1108
|
+
/**
|
|
1109
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1110
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1111
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1112
|
+
*/
|
|
805
1113
|
value: string | undefined;
|
|
806
1114
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
807
1115
|
width: number;
|
|
@@ -830,13 +1138,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
830
1138
|
measure: () => void;
|
|
831
1139
|
};
|
|
832
1140
|
UNSTABLE_defaultItemHeight: number;
|
|
833
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1141
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1142
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1143
|
+
*
|
|
1144
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1145
|
+
*
|
|
1146
|
+
* ```tsx
|
|
1147
|
+
* <Select items={options}>
|
|
1148
|
+
* <FormField label="Your Label">
|
|
1149
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1150
|
+
* <Select.Popper>
|
|
1151
|
+
* <Select.Card>
|
|
1152
|
+
* ...
|
|
1153
|
+
* </Select.Card>
|
|
1154
|
+
* </Select.Popper>
|
|
1155
|
+
* </FormField>
|
|
1156
|
+
* </Select>
|
|
1157
|
+
* ```
|
|
1158
|
+
*/
|
|
834
1159
|
orientation: "horizontal" | "vertical";
|
|
835
1160
|
indexRef: React.MutableRefObject<number>;
|
|
836
1161
|
nonInteractiveIds: string[];
|
|
837
1162
|
isVirtualized: boolean;
|
|
838
1163
|
items: import("../..").Item<any>[];
|
|
839
1164
|
mode: "multiple" | "single";
|
|
1165
|
+
/**
|
|
1166
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1167
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1168
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1169
|
+
*/
|
|
840
1170
|
value: string | undefined;
|
|
841
1171
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
842
1172
|
width: number;
|
|
@@ -865,13 +1195,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
865
1195
|
measure: () => void;
|
|
866
1196
|
};
|
|
867
1197
|
UNSTABLE_defaultItemHeight: number;
|
|
868
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1198
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1199
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1200
|
+
*
|
|
1201
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1202
|
+
*
|
|
1203
|
+
* ```tsx
|
|
1204
|
+
* <Select items={options}>
|
|
1205
|
+
* <FormField label="Your Label">
|
|
1206
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1207
|
+
* <Select.Popper>
|
|
1208
|
+
* <Select.Card>
|
|
1209
|
+
* ...
|
|
1210
|
+
* </Select.Card>
|
|
1211
|
+
* </Select.Popper>
|
|
1212
|
+
* </FormField>
|
|
1213
|
+
* </Select>
|
|
1214
|
+
* ```
|
|
1215
|
+
*/
|
|
869
1216
|
orientation: "horizontal" | "vertical";
|
|
870
1217
|
indexRef: React.MutableRefObject<number>;
|
|
871
1218
|
nonInteractiveIds: string[];
|
|
872
1219
|
isVirtualized: boolean;
|
|
873
1220
|
items: import("../..").Item<any>[];
|
|
874
1221
|
mode: "multiple" | "single";
|
|
1222
|
+
/**
|
|
1223
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1224
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1225
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1226
|
+
*/
|
|
875
1227
|
value: string | undefined;
|
|
876
1228
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
877
1229
|
width: number;
|
|
@@ -900,13 +1252,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
900
1252
|
measure: () => void;
|
|
901
1253
|
};
|
|
902
1254
|
UNSTABLE_defaultItemHeight: number;
|
|
903
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1255
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1256
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1257
|
+
*
|
|
1258
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1259
|
+
*
|
|
1260
|
+
* ```tsx
|
|
1261
|
+
* <Select items={options}>
|
|
1262
|
+
* <FormField label="Your Label">
|
|
1263
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1264
|
+
* <Select.Popper>
|
|
1265
|
+
* <Select.Card>
|
|
1266
|
+
* ...
|
|
1267
|
+
* </Select.Card>
|
|
1268
|
+
* </Select.Popper>
|
|
1269
|
+
* </FormField>
|
|
1270
|
+
* </Select>
|
|
1271
|
+
* ```
|
|
1272
|
+
*/
|
|
904
1273
|
orientation: "horizontal" | "vertical";
|
|
905
1274
|
indexRef: React.MutableRefObject<number>;
|
|
906
1275
|
nonInteractiveIds: string[];
|
|
907
1276
|
isVirtualized: boolean;
|
|
908
1277
|
items: import("../..").Item<any>[];
|
|
909
1278
|
mode: "multiple" | "single";
|
|
1279
|
+
/**
|
|
1280
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1281
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1282
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1283
|
+
*/
|
|
910
1284
|
value: string | undefined;
|
|
911
1285
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
912
1286
|
width: number;
|
|
@@ -935,13 +1309,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
935
1309
|
measure: () => void;
|
|
936
1310
|
};
|
|
937
1311
|
UNSTABLE_defaultItemHeight: number;
|
|
938
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1312
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1313
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1314
|
+
*
|
|
1315
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1316
|
+
*
|
|
1317
|
+
* ```tsx
|
|
1318
|
+
* <Select items={options}>
|
|
1319
|
+
* <FormField label="Your Label">
|
|
1320
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1321
|
+
* <Select.Popper>
|
|
1322
|
+
* <Select.Card>
|
|
1323
|
+
* ...
|
|
1324
|
+
* </Select.Card>
|
|
1325
|
+
* </Select.Popper>
|
|
1326
|
+
* </FormField>
|
|
1327
|
+
* </Select>
|
|
1328
|
+
* ```
|
|
1329
|
+
*/
|
|
939
1330
|
orientation: "horizontal" | "vertical";
|
|
940
1331
|
indexRef: React.MutableRefObject<number>;
|
|
941
1332
|
nonInteractiveIds: string[];
|
|
942
1333
|
isVirtualized: boolean;
|
|
943
1334
|
items: import("../..").Item<any>[];
|
|
944
1335
|
mode: "multiple" | "single";
|
|
1336
|
+
/**
|
|
1337
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1338
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1339
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1340
|
+
*/
|
|
945
1341
|
value: string | undefined;
|
|
946
1342
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
947
1343
|
width: number;
|
|
@@ -970,13 +1366,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
970
1366
|
measure: () => void;
|
|
971
1367
|
};
|
|
972
1368
|
UNSTABLE_defaultItemHeight: number;
|
|
973
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1369
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1370
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1371
|
+
*
|
|
1372
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1373
|
+
*
|
|
1374
|
+
* ```tsx
|
|
1375
|
+
* <Select items={options}>
|
|
1376
|
+
* <FormField label="Your Label">
|
|
1377
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1378
|
+
* <Select.Popper>
|
|
1379
|
+
* <Select.Card>
|
|
1380
|
+
* ...
|
|
1381
|
+
* </Select.Card>
|
|
1382
|
+
* </Select.Popper>
|
|
1383
|
+
* </FormField>
|
|
1384
|
+
* </Select>
|
|
1385
|
+
* ```
|
|
1386
|
+
*/
|
|
974
1387
|
orientation: "horizontal" | "vertical";
|
|
975
1388
|
indexRef: React.MutableRefObject<number>;
|
|
976
1389
|
nonInteractiveIds: string[];
|
|
977
1390
|
isVirtualized: boolean;
|
|
978
1391
|
items: import("../..").Item<any>[];
|
|
979
1392
|
mode: "multiple" | "single";
|
|
1393
|
+
/**
|
|
1394
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1395
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1396
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1397
|
+
*/
|
|
980
1398
|
value: string | undefined;
|
|
981
1399
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
982
1400
|
width: number;
|
|
@@ -1005,13 +1423,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1005
1423
|
measure: () => void;
|
|
1006
1424
|
};
|
|
1007
1425
|
UNSTABLE_defaultItemHeight: number;
|
|
1008
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1426
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1427
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1428
|
+
*
|
|
1429
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1430
|
+
*
|
|
1431
|
+
* ```tsx
|
|
1432
|
+
* <Select items={options}>
|
|
1433
|
+
* <FormField label="Your Label">
|
|
1434
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1435
|
+
* <Select.Popper>
|
|
1436
|
+
* <Select.Card>
|
|
1437
|
+
* ...
|
|
1438
|
+
* </Select.Card>
|
|
1439
|
+
* </Select.Popper>
|
|
1440
|
+
* </FormField>
|
|
1441
|
+
* </Select>
|
|
1442
|
+
* ```
|
|
1443
|
+
*/
|
|
1009
1444
|
orientation: "horizontal" | "vertical";
|
|
1010
1445
|
indexRef: React.MutableRefObject<number>;
|
|
1011
1446
|
nonInteractiveIds: string[];
|
|
1012
1447
|
isVirtualized: boolean;
|
|
1013
1448
|
items: import("../..").Item<any>[];
|
|
1014
1449
|
mode: "multiple" | "single";
|
|
1450
|
+
/**
|
|
1451
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1452
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1453
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1454
|
+
*/
|
|
1015
1455
|
value: string | undefined;
|
|
1016
1456
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1017
1457
|
width: number;
|
|
@@ -1040,13 +1480,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1040
1480
|
measure: () => void;
|
|
1041
1481
|
};
|
|
1042
1482
|
UNSTABLE_defaultItemHeight: number;
|
|
1043
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1483
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1484
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1485
|
+
*
|
|
1486
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1487
|
+
*
|
|
1488
|
+
* ```tsx
|
|
1489
|
+
* <Select items={options}>
|
|
1490
|
+
* <FormField label="Your Label">
|
|
1491
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1492
|
+
* <Select.Popper>
|
|
1493
|
+
* <Select.Card>
|
|
1494
|
+
* ...
|
|
1495
|
+
* </Select.Card>
|
|
1496
|
+
* </Select.Popper>
|
|
1497
|
+
* </FormField>
|
|
1498
|
+
* </Select>
|
|
1499
|
+
* ```
|
|
1500
|
+
*/
|
|
1044
1501
|
orientation: "horizontal" | "vertical";
|
|
1045
1502
|
indexRef: React.MutableRefObject<number>;
|
|
1046
1503
|
nonInteractiveIds: string[];
|
|
1047
1504
|
isVirtualized: boolean;
|
|
1048
1505
|
items: import("../..").Item<any>[];
|
|
1049
1506
|
mode: "multiple" | "single";
|
|
1507
|
+
/**
|
|
1508
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1509
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1510
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1511
|
+
*/
|
|
1050
1512
|
value: string | undefined;
|
|
1051
1513
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1052
1514
|
width: number;
|
|
@@ -1075,13 +1537,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1075
1537
|
measure: () => void;
|
|
1076
1538
|
};
|
|
1077
1539
|
UNSTABLE_defaultItemHeight: number;
|
|
1078
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1540
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1541
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1542
|
+
*
|
|
1543
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1544
|
+
*
|
|
1545
|
+
* ```tsx
|
|
1546
|
+
* <Select items={options}>
|
|
1547
|
+
* <FormField label="Your Label">
|
|
1548
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1549
|
+
* <Select.Popper>
|
|
1550
|
+
* <Select.Card>
|
|
1551
|
+
* ...
|
|
1552
|
+
* </Select.Card>
|
|
1553
|
+
* </Select.Popper>
|
|
1554
|
+
* </FormField>
|
|
1555
|
+
* </Select>
|
|
1556
|
+
* ```
|
|
1557
|
+
*/
|
|
1079
1558
|
orientation: "horizontal" | "vertical";
|
|
1080
1559
|
indexRef: React.MutableRefObject<number>;
|
|
1081
1560
|
nonInteractiveIds: string[];
|
|
1082
1561
|
isVirtualized: boolean;
|
|
1083
1562
|
items: import("../..").Item<any>[];
|
|
1084
1563
|
mode: "multiple" | "single";
|
|
1564
|
+
/**
|
|
1565
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1566
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1567
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1568
|
+
*/
|
|
1085
1569
|
value: string | undefined;
|
|
1086
1570
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1087
1571
|
width: number;
|
|
@@ -1110,13 +1594,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1110
1594
|
measure: () => void;
|
|
1111
1595
|
};
|
|
1112
1596
|
UNSTABLE_defaultItemHeight: number;
|
|
1113
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1597
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1598
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1599
|
+
*
|
|
1600
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1601
|
+
*
|
|
1602
|
+
* ```tsx
|
|
1603
|
+
* <Select items={options}>
|
|
1604
|
+
* <FormField label="Your Label">
|
|
1605
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1606
|
+
* <Select.Popper>
|
|
1607
|
+
* <Select.Card>
|
|
1608
|
+
* ...
|
|
1609
|
+
* </Select.Card>
|
|
1610
|
+
* </Select.Popper>
|
|
1611
|
+
* </FormField>
|
|
1612
|
+
* </Select>
|
|
1613
|
+
* ```
|
|
1614
|
+
*/
|
|
1114
1615
|
orientation: "horizontal" | "vertical";
|
|
1115
1616
|
indexRef: React.MutableRefObject<number>;
|
|
1116
1617
|
nonInteractiveIds: string[];
|
|
1117
1618
|
isVirtualized: boolean;
|
|
1118
1619
|
items: import("../..").Item<any>[];
|
|
1119
1620
|
mode: "multiple" | "single";
|
|
1621
|
+
/**
|
|
1622
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1623
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1624
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1625
|
+
*/
|
|
1120
1626
|
value: string | undefined;
|
|
1121
1627
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1122
1628
|
width: number;
|
|
@@ -1145,13 +1651,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1145
1651
|
measure: () => void;
|
|
1146
1652
|
};
|
|
1147
1653
|
UNSTABLE_defaultItemHeight: number;
|
|
1148
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1654
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1655
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1656
|
+
*
|
|
1657
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1658
|
+
*
|
|
1659
|
+
* ```tsx
|
|
1660
|
+
* <Select items={options}>
|
|
1661
|
+
* <FormField label="Your Label">
|
|
1662
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1663
|
+
* <Select.Popper>
|
|
1664
|
+
* <Select.Card>
|
|
1665
|
+
* ...
|
|
1666
|
+
* </Select.Card>
|
|
1667
|
+
* </Select.Popper>
|
|
1668
|
+
* </FormField>
|
|
1669
|
+
* </Select>
|
|
1670
|
+
* ```
|
|
1671
|
+
*/
|
|
1149
1672
|
orientation: "horizontal" | "vertical";
|
|
1150
1673
|
indexRef: React.MutableRefObject<number>;
|
|
1151
1674
|
nonInteractiveIds: string[];
|
|
1152
1675
|
isVirtualized: boolean;
|
|
1153
1676
|
items: import("../..").Item<any>[];
|
|
1154
1677
|
mode: "multiple" | "single";
|
|
1678
|
+
/**
|
|
1679
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1680
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1681
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1682
|
+
*/
|
|
1155
1683
|
value: string | undefined;
|
|
1156
1684
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1157
1685
|
width: number;
|
|
@@ -1183,13 +1711,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1183
1711
|
measure: () => void;
|
|
1184
1712
|
};
|
|
1185
1713
|
UNSTABLE_defaultItemHeight: number;
|
|
1186
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1714
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1715
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1716
|
+
*
|
|
1717
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1718
|
+
*
|
|
1719
|
+
* ```tsx
|
|
1720
|
+
* <Select items={options}>
|
|
1721
|
+
* <FormField label="Your Label">
|
|
1722
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1723
|
+
* <Select.Popper>
|
|
1724
|
+
* <Select.Card>
|
|
1725
|
+
* ...
|
|
1726
|
+
* </Select.Card>
|
|
1727
|
+
* </Select.Popper>
|
|
1728
|
+
* </FormField>
|
|
1729
|
+
* </Select>
|
|
1730
|
+
* ```
|
|
1731
|
+
*/
|
|
1187
1732
|
orientation: "horizontal" | "vertical";
|
|
1188
1733
|
indexRef: React.MutableRefObject<number>;
|
|
1189
1734
|
nonInteractiveIds: string[];
|
|
1190
1735
|
isVirtualized: boolean;
|
|
1191
1736
|
items: import("../..").Item<any>[];
|
|
1192
1737
|
mode: "multiple" | "single";
|
|
1738
|
+
/**
|
|
1739
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1740
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1741
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1742
|
+
*/
|
|
1193
1743
|
value: string | undefined;
|
|
1194
1744
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1195
1745
|
width: number;
|
|
@@ -1220,13 +1770,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1220
1770
|
measure: () => void;
|
|
1221
1771
|
};
|
|
1222
1772
|
UNSTABLE_defaultItemHeight: number;
|
|
1223
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1773
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1774
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1775
|
+
*
|
|
1776
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1777
|
+
*
|
|
1778
|
+
* ```tsx
|
|
1779
|
+
* <Select items={options}>
|
|
1780
|
+
* <FormField label="Your Label">
|
|
1781
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1782
|
+
* <Select.Popper>
|
|
1783
|
+
* <Select.Card>
|
|
1784
|
+
* ...
|
|
1785
|
+
* </Select.Card>
|
|
1786
|
+
* </Select.Popper>
|
|
1787
|
+
* </FormField>
|
|
1788
|
+
* </Select>
|
|
1789
|
+
* ```
|
|
1790
|
+
*/
|
|
1224
1791
|
orientation: "horizontal" | "vertical";
|
|
1225
1792
|
indexRef: React.MutableRefObject<number>;
|
|
1226
1793
|
nonInteractiveIds: string[];
|
|
1227
1794
|
isVirtualized: boolean;
|
|
1228
1795
|
items: import("../..").Item<any>[];
|
|
1229
1796
|
mode: "multiple" | "single";
|
|
1797
|
+
/**
|
|
1798
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1799
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1800
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1801
|
+
*/
|
|
1230
1802
|
value: string | undefined;
|
|
1231
1803
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1232
1804
|
width: number;
|
|
@@ -1257,13 +1829,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1257
1829
|
measure: () => void;
|
|
1258
1830
|
};
|
|
1259
1831
|
UNSTABLE_defaultItemHeight: number;
|
|
1260
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1832
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1833
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1834
|
+
*
|
|
1835
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1836
|
+
*
|
|
1837
|
+
* ```tsx
|
|
1838
|
+
* <Select items={options}>
|
|
1839
|
+
* <FormField label="Your Label">
|
|
1840
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1841
|
+
* <Select.Popper>
|
|
1842
|
+
* <Select.Card>
|
|
1843
|
+
* ...
|
|
1844
|
+
* </Select.Card>
|
|
1845
|
+
* </Select.Popper>
|
|
1846
|
+
* </FormField>
|
|
1847
|
+
* </Select>
|
|
1848
|
+
* ```
|
|
1849
|
+
*/
|
|
1261
1850
|
orientation: "horizontal" | "vertical";
|
|
1262
1851
|
indexRef: React.MutableRefObject<number>;
|
|
1263
1852
|
nonInteractiveIds: string[];
|
|
1264
1853
|
isVirtualized: boolean;
|
|
1265
1854
|
items: import("../..").Item<any>[];
|
|
1266
1855
|
mode: "multiple" | "single";
|
|
1856
|
+
/**
|
|
1857
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1858
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1859
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1860
|
+
*/
|
|
1267
1861
|
value: string | undefined;
|
|
1268
1862
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1269
1863
|
width: number;
|
|
@@ -1293,13 +1887,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1293
1887
|
measure: () => void;
|
|
1294
1888
|
};
|
|
1295
1889
|
UNSTABLE_defaultItemHeight: number;
|
|
1296
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1890
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1891
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1892
|
+
*
|
|
1893
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1894
|
+
*
|
|
1895
|
+
* ```tsx
|
|
1896
|
+
* <Select items={options}>
|
|
1897
|
+
* <FormField label="Your Label">
|
|
1898
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1899
|
+
* <Select.Popper>
|
|
1900
|
+
* <Select.Card>
|
|
1901
|
+
* ...
|
|
1902
|
+
* </Select.Card>
|
|
1903
|
+
* </Select.Popper>
|
|
1904
|
+
* </FormField>
|
|
1905
|
+
* </Select>
|
|
1906
|
+
* ```
|
|
1907
|
+
*/
|
|
1297
1908
|
orientation: "horizontal" | "vertical";
|
|
1298
1909
|
indexRef: React.MutableRefObject<number>;
|
|
1299
1910
|
nonInteractiveIds: string[];
|
|
1300
1911
|
isVirtualized: boolean;
|
|
1301
1912
|
items: import("../..").Item<any>[];
|
|
1302
1913
|
mode: "multiple" | "single";
|
|
1914
|
+
/**
|
|
1915
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1916
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1917
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1918
|
+
*/
|
|
1303
1919
|
value: string | undefined;
|
|
1304
1920
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1305
1921
|
width: number;
|
|
@@ -1330,13 +1946,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1330
1946
|
measure: () => void;
|
|
1331
1947
|
};
|
|
1332
1948
|
UNSTABLE_defaultItemHeight: number;
|
|
1333
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
1949
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
1950
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
1951
|
+
*
|
|
1952
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
1953
|
+
*
|
|
1954
|
+
* ```tsx
|
|
1955
|
+
* <Select items={options}>
|
|
1956
|
+
* <FormField label="Your Label">
|
|
1957
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
1958
|
+
* <Select.Popper>
|
|
1959
|
+
* <Select.Card>
|
|
1960
|
+
* ...
|
|
1961
|
+
* </Select.Card>
|
|
1962
|
+
* </Select.Popper>
|
|
1963
|
+
* </FormField>
|
|
1964
|
+
* </Select>
|
|
1965
|
+
* ```
|
|
1966
|
+
*/
|
|
1334
1967
|
orientation: "horizontal" | "vertical";
|
|
1335
1968
|
indexRef: React.MutableRefObject<number>;
|
|
1336
1969
|
nonInteractiveIds: string[];
|
|
1337
1970
|
isVirtualized: boolean;
|
|
1338
1971
|
items: import("../..").Item<any>[];
|
|
1339
1972
|
mode: "multiple" | "single";
|
|
1973
|
+
/**
|
|
1974
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
1975
|
+
* include icons that you would like to render in the `input` when selected.
|
|
1976
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
1977
|
+
*/
|
|
1340
1978
|
value: string | undefined;
|
|
1341
1979
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1342
1980
|
width: number;
|
|
@@ -1365,13 +2003,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1365
2003
|
measure: () => void;
|
|
1366
2004
|
};
|
|
1367
2005
|
UNSTABLE_defaultItemHeight: number;
|
|
1368
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2006
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2007
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2008
|
+
*
|
|
2009
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2010
|
+
*
|
|
2011
|
+
* ```tsx
|
|
2012
|
+
* <Select items={options}>
|
|
2013
|
+
* <FormField label="Your Label">
|
|
2014
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2015
|
+
* <Select.Popper>
|
|
2016
|
+
* <Select.Card>
|
|
2017
|
+
* ...
|
|
2018
|
+
* </Select.Card>
|
|
2019
|
+
* </Select.Popper>
|
|
2020
|
+
* </FormField>
|
|
2021
|
+
* </Select>
|
|
2022
|
+
* ```
|
|
2023
|
+
*/
|
|
1369
2024
|
orientation: "horizontal" | "vertical";
|
|
1370
2025
|
indexRef: React.MutableRefObject<number>;
|
|
1371
2026
|
nonInteractiveIds: string[];
|
|
1372
2027
|
isVirtualized: boolean;
|
|
1373
2028
|
items: import("../..").Item<any>[];
|
|
1374
2029
|
mode: "multiple" | "single";
|
|
2030
|
+
/**
|
|
2031
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2032
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2033
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2034
|
+
*/
|
|
1375
2035
|
value: string | undefined;
|
|
1376
2036
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1377
2037
|
width: number;
|
|
@@ -1400,13 +2060,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1400
2060
|
measure: () => void;
|
|
1401
2061
|
};
|
|
1402
2062
|
UNSTABLE_defaultItemHeight: number;
|
|
1403
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2063
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2064
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2065
|
+
*
|
|
2066
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2067
|
+
*
|
|
2068
|
+
* ```tsx
|
|
2069
|
+
* <Select items={options}>
|
|
2070
|
+
* <FormField label="Your Label">
|
|
2071
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2072
|
+
* <Select.Popper>
|
|
2073
|
+
* <Select.Card>
|
|
2074
|
+
* ...
|
|
2075
|
+
* </Select.Card>
|
|
2076
|
+
* </Select.Popper>
|
|
2077
|
+
* </FormField>
|
|
2078
|
+
* </Select>
|
|
2079
|
+
* ```
|
|
2080
|
+
*/
|
|
1404
2081
|
orientation: "horizontal" | "vertical";
|
|
1405
2082
|
indexRef: React.MutableRefObject<number>;
|
|
1406
2083
|
nonInteractiveIds: string[];
|
|
1407
2084
|
isVirtualized: boolean;
|
|
1408
2085
|
items: import("../..").Item<any>[];
|
|
1409
2086
|
mode: "multiple" | "single";
|
|
2087
|
+
/**
|
|
2088
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2089
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2090
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2091
|
+
*/
|
|
1410
2092
|
value: string | undefined;
|
|
1411
2093
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1412
2094
|
width: number;
|
|
@@ -1437,13 +2119,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1437
2119
|
measure: () => void;
|
|
1438
2120
|
};
|
|
1439
2121
|
UNSTABLE_defaultItemHeight: number;
|
|
1440
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2122
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2123
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2124
|
+
*
|
|
2125
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2126
|
+
*
|
|
2127
|
+
* ```tsx
|
|
2128
|
+
* <Select items={options}>
|
|
2129
|
+
* <FormField label="Your Label">
|
|
2130
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2131
|
+
* <Select.Popper>
|
|
2132
|
+
* <Select.Card>
|
|
2133
|
+
* ...
|
|
2134
|
+
* </Select.Card>
|
|
2135
|
+
* </Select.Popper>
|
|
2136
|
+
* </FormField>
|
|
2137
|
+
* </Select>
|
|
2138
|
+
* ```
|
|
2139
|
+
*/
|
|
1441
2140
|
orientation: "horizontal" | "vertical";
|
|
1442
2141
|
indexRef: React.MutableRefObject<number>;
|
|
1443
2142
|
nonInteractiveIds: string[];
|
|
1444
2143
|
isVirtualized: boolean;
|
|
1445
2144
|
items: import("../..").Item<any>[];
|
|
1446
2145
|
mode: "multiple" | "single";
|
|
2146
|
+
/**
|
|
2147
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2148
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2149
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2150
|
+
*/
|
|
1447
2151
|
value: string | undefined;
|
|
1448
2152
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1449
2153
|
width: number;
|
|
@@ -1472,13 +2176,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1472
2176
|
measure: () => void;
|
|
1473
2177
|
};
|
|
1474
2178
|
UNSTABLE_defaultItemHeight: number;
|
|
1475
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2179
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2180
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2181
|
+
*
|
|
2182
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2183
|
+
*
|
|
2184
|
+
* ```tsx
|
|
2185
|
+
* <Select items={options}>
|
|
2186
|
+
* <FormField label="Your Label">
|
|
2187
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2188
|
+
* <Select.Popper>
|
|
2189
|
+
* <Select.Card>
|
|
2190
|
+
* ...
|
|
2191
|
+
* </Select.Card>
|
|
2192
|
+
* </Select.Popper>
|
|
2193
|
+
* </FormField>
|
|
2194
|
+
* </Select>
|
|
2195
|
+
* ```
|
|
2196
|
+
*/
|
|
1476
2197
|
orientation: "horizontal" | "vertical";
|
|
1477
2198
|
indexRef: React.MutableRefObject<number>;
|
|
1478
2199
|
nonInteractiveIds: string[];
|
|
1479
2200
|
isVirtualized: boolean;
|
|
1480
2201
|
items: import("../..").Item<any>[];
|
|
1481
2202
|
mode: "multiple" | "single";
|
|
2203
|
+
/**
|
|
2204
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2205
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2206
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2207
|
+
*/
|
|
1482
2208
|
value: string | undefined;
|
|
1483
2209
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1484
2210
|
width: number;
|
|
@@ -1507,13 +2233,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1507
2233
|
measure: () => void;
|
|
1508
2234
|
};
|
|
1509
2235
|
UNSTABLE_defaultItemHeight: number;
|
|
1510
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2236
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2237
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2238
|
+
*
|
|
2239
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2240
|
+
*
|
|
2241
|
+
* ```tsx
|
|
2242
|
+
* <Select items={options}>
|
|
2243
|
+
* <FormField label="Your Label">
|
|
2244
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2245
|
+
* <Select.Popper>
|
|
2246
|
+
* <Select.Card>
|
|
2247
|
+
* ...
|
|
2248
|
+
* </Select.Card>
|
|
2249
|
+
* </Select.Popper>
|
|
2250
|
+
* </FormField>
|
|
2251
|
+
* </Select>
|
|
2252
|
+
* ```
|
|
2253
|
+
*/
|
|
1511
2254
|
orientation: "horizontal" | "vertical";
|
|
1512
2255
|
indexRef: React.MutableRefObject<number>;
|
|
1513
2256
|
nonInteractiveIds: string[];
|
|
1514
2257
|
isVirtualized: boolean;
|
|
1515
2258
|
items: import("../..").Item<any>[];
|
|
1516
2259
|
mode: "multiple" | "single";
|
|
2260
|
+
/**
|
|
2261
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2262
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2263
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2264
|
+
*/
|
|
1517
2265
|
value: string | undefined;
|
|
1518
2266
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1519
2267
|
width: number;
|
|
@@ -1544,13 +2292,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1544
2292
|
measure: () => void;
|
|
1545
2293
|
};
|
|
1546
2294
|
UNSTABLE_defaultItemHeight: number;
|
|
1547
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2295
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2296
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2297
|
+
*
|
|
2298
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2299
|
+
*
|
|
2300
|
+
* ```tsx
|
|
2301
|
+
* <Select items={options}>
|
|
2302
|
+
* <FormField label="Your Label">
|
|
2303
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2304
|
+
* <Select.Popper>
|
|
2305
|
+
* <Select.Card>
|
|
2306
|
+
* ...
|
|
2307
|
+
* </Select.Card>
|
|
2308
|
+
* </Select.Popper>
|
|
2309
|
+
* </FormField>
|
|
2310
|
+
* </Select>
|
|
2311
|
+
* ```
|
|
2312
|
+
*/
|
|
1548
2313
|
orientation: "horizontal" | "vertical";
|
|
1549
2314
|
indexRef: React.MutableRefObject<number>;
|
|
1550
2315
|
nonInteractiveIds: string[];
|
|
1551
2316
|
isVirtualized: boolean;
|
|
1552
2317
|
items: import("../..").Item<any>[];
|
|
1553
2318
|
mode: "multiple" | "single";
|
|
2319
|
+
/**
|
|
2320
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2321
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2322
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2323
|
+
*/
|
|
1554
2324
|
value: string | undefined;
|
|
1555
2325
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1556
2326
|
width: number;
|
|
@@ -1579,13 +2349,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1579
2349
|
measure: () => void;
|
|
1580
2350
|
};
|
|
1581
2351
|
UNSTABLE_defaultItemHeight: number;
|
|
1582
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2352
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2353
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2354
|
+
*
|
|
2355
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2356
|
+
*
|
|
2357
|
+
* ```tsx
|
|
2358
|
+
* <Select items={options}>
|
|
2359
|
+
* <FormField label="Your Label">
|
|
2360
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2361
|
+
* <Select.Popper>
|
|
2362
|
+
* <Select.Card>
|
|
2363
|
+
* ...
|
|
2364
|
+
* </Select.Card>
|
|
2365
|
+
* </Select.Popper>
|
|
2366
|
+
* </FormField>
|
|
2367
|
+
* </Select>
|
|
2368
|
+
* ```
|
|
2369
|
+
*/
|
|
1583
2370
|
orientation: "horizontal" | "vertical";
|
|
1584
2371
|
indexRef: React.MutableRefObject<number>;
|
|
1585
2372
|
nonInteractiveIds: string[];
|
|
1586
2373
|
isVirtualized: boolean;
|
|
1587
2374
|
items: import("../..").Item<any>[];
|
|
1588
2375
|
mode: "multiple" | "single";
|
|
2376
|
+
/**
|
|
2377
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2378
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2379
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2380
|
+
*/
|
|
1589
2381
|
value: string | undefined;
|
|
1590
2382
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1591
2383
|
width: number;
|
|
@@ -1614,13 +2406,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1614
2406
|
measure: () => void;
|
|
1615
2407
|
};
|
|
1616
2408
|
UNSTABLE_defaultItemHeight: number;
|
|
1617
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2409
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2410
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2411
|
+
*
|
|
2412
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2413
|
+
*
|
|
2414
|
+
* ```tsx
|
|
2415
|
+
* <Select items={options}>
|
|
2416
|
+
* <FormField label="Your Label">
|
|
2417
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2418
|
+
* <Select.Popper>
|
|
2419
|
+
* <Select.Card>
|
|
2420
|
+
* ...
|
|
2421
|
+
* </Select.Card>
|
|
2422
|
+
* </Select.Popper>
|
|
2423
|
+
* </FormField>
|
|
2424
|
+
* </Select>
|
|
2425
|
+
* ```
|
|
2426
|
+
*/
|
|
1618
2427
|
orientation: "horizontal" | "vertical";
|
|
1619
2428
|
indexRef: React.MutableRefObject<number>;
|
|
1620
2429
|
nonInteractiveIds: string[];
|
|
1621
2430
|
isVirtualized: boolean;
|
|
1622
2431
|
items: import("../..").Item<any>[];
|
|
1623
2432
|
mode: "multiple" | "single";
|
|
2433
|
+
/**
|
|
2434
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2435
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2436
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2437
|
+
*/
|
|
1624
2438
|
value: string | undefined;
|
|
1625
2439
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1626
2440
|
width: number;
|
|
@@ -1649,13 +2463,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1649
2463
|
measure: () => void;
|
|
1650
2464
|
};
|
|
1651
2465
|
UNSTABLE_defaultItemHeight: number;
|
|
1652
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2466
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2467
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2468
|
+
*
|
|
2469
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2470
|
+
*
|
|
2471
|
+
* ```tsx
|
|
2472
|
+
* <Select items={options}>
|
|
2473
|
+
* <FormField label="Your Label">
|
|
2474
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2475
|
+
* <Select.Popper>
|
|
2476
|
+
* <Select.Card>
|
|
2477
|
+
* ...
|
|
2478
|
+
* </Select.Card>
|
|
2479
|
+
* </Select.Popper>
|
|
2480
|
+
* </FormField>
|
|
2481
|
+
* </Select>
|
|
2482
|
+
* ```
|
|
2483
|
+
*/
|
|
1653
2484
|
orientation: "horizontal" | "vertical";
|
|
1654
2485
|
indexRef: React.MutableRefObject<number>;
|
|
1655
2486
|
nonInteractiveIds: string[];
|
|
1656
2487
|
isVirtualized: boolean;
|
|
1657
2488
|
items: import("../..").Item<any>[];
|
|
1658
2489
|
mode: "multiple" | "single";
|
|
2490
|
+
/**
|
|
2491
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2492
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2493
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2494
|
+
*/
|
|
1659
2495
|
value: string | undefined;
|
|
1660
2496
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1661
2497
|
width: number;
|
|
@@ -1684,13 +2520,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1684
2520
|
measure: () => void;
|
|
1685
2521
|
};
|
|
1686
2522
|
UNSTABLE_defaultItemHeight: number;
|
|
1687
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2523
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2524
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2525
|
+
*
|
|
2526
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2527
|
+
*
|
|
2528
|
+
* ```tsx
|
|
2529
|
+
* <Select items={options}>
|
|
2530
|
+
* <FormField label="Your Label">
|
|
2531
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2532
|
+
* <Select.Popper>
|
|
2533
|
+
* <Select.Card>
|
|
2534
|
+
* ...
|
|
2535
|
+
* </Select.Card>
|
|
2536
|
+
* </Select.Popper>
|
|
2537
|
+
* </FormField>
|
|
2538
|
+
* </Select>
|
|
2539
|
+
* ```
|
|
2540
|
+
*/
|
|
1688
2541
|
orientation: "horizontal" | "vertical";
|
|
1689
2542
|
indexRef: React.MutableRefObject<number>;
|
|
1690
2543
|
nonInteractiveIds: string[];
|
|
1691
2544
|
isVirtualized: boolean;
|
|
1692
2545
|
items: import("../..").Item<any>[];
|
|
1693
2546
|
mode: "multiple" | "single";
|
|
2547
|
+
/**
|
|
2548
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2549
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2550
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2551
|
+
*/
|
|
1694
2552
|
value: string | undefined;
|
|
1695
2553
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1696
2554
|
width: number;
|
|
@@ -1719,13 +2577,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1719
2577
|
measure: () => void;
|
|
1720
2578
|
};
|
|
1721
2579
|
UNSTABLE_defaultItemHeight: number;
|
|
1722
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2580
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2581
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2582
|
+
*
|
|
2583
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2584
|
+
*
|
|
2585
|
+
* ```tsx
|
|
2586
|
+
* <Select items={options}>
|
|
2587
|
+
* <FormField label="Your Label">
|
|
2588
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2589
|
+
* <Select.Popper>
|
|
2590
|
+
* <Select.Card>
|
|
2591
|
+
* ...
|
|
2592
|
+
* </Select.Card>
|
|
2593
|
+
* </Select.Popper>
|
|
2594
|
+
* </FormField>
|
|
2595
|
+
* </Select>
|
|
2596
|
+
* ```
|
|
2597
|
+
*/
|
|
1723
2598
|
orientation: "horizontal" | "vertical";
|
|
1724
2599
|
indexRef: React.MutableRefObject<number>;
|
|
1725
2600
|
nonInteractiveIds: string[];
|
|
1726
2601
|
isVirtualized: boolean;
|
|
1727
2602
|
items: import("../..").Item<any>[];
|
|
1728
2603
|
mode: "multiple" | "single";
|
|
2604
|
+
/**
|
|
2605
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2606
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2607
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2608
|
+
*/
|
|
1729
2609
|
value: string | undefined;
|
|
1730
2610
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1731
2611
|
width: number;
|
|
@@ -1754,13 +2634,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1754
2634
|
measure: () => void;
|
|
1755
2635
|
};
|
|
1756
2636
|
UNSTABLE_defaultItemHeight: number;
|
|
1757
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2637
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2638
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2639
|
+
*
|
|
2640
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2641
|
+
*
|
|
2642
|
+
* ```tsx
|
|
2643
|
+
* <Select items={options}>
|
|
2644
|
+
* <FormField label="Your Label">
|
|
2645
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2646
|
+
* <Select.Popper>
|
|
2647
|
+
* <Select.Card>
|
|
2648
|
+
* ...
|
|
2649
|
+
* </Select.Card>
|
|
2650
|
+
* </Select.Popper>
|
|
2651
|
+
* </FormField>
|
|
2652
|
+
* </Select>
|
|
2653
|
+
* ```
|
|
2654
|
+
*/
|
|
1758
2655
|
orientation: "horizontal" | "vertical";
|
|
1759
2656
|
indexRef: React.MutableRefObject<number>;
|
|
1760
2657
|
nonInteractiveIds: string[];
|
|
1761
2658
|
isVirtualized: boolean;
|
|
1762
2659
|
items: import("../..").Item<any>[];
|
|
1763
2660
|
mode: "multiple" | "single";
|
|
2661
|
+
/**
|
|
2662
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2663
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2664
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2665
|
+
*/
|
|
1764
2666
|
value: string | undefined;
|
|
1765
2667
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1766
2668
|
width: number;
|
|
@@ -1789,13 +2691,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1789
2691
|
measure: () => void;
|
|
1790
2692
|
};
|
|
1791
2693
|
UNSTABLE_defaultItemHeight: number;
|
|
1792
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2694
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2695
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2696
|
+
*
|
|
2697
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2698
|
+
*
|
|
2699
|
+
* ```tsx
|
|
2700
|
+
* <Select items={options}>
|
|
2701
|
+
* <FormField label="Your Label">
|
|
2702
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2703
|
+
* <Select.Popper>
|
|
2704
|
+
* <Select.Card>
|
|
2705
|
+
* ...
|
|
2706
|
+
* </Select.Card>
|
|
2707
|
+
* </Select.Popper>
|
|
2708
|
+
* </FormField>
|
|
2709
|
+
* </Select>
|
|
2710
|
+
* ```
|
|
2711
|
+
*/
|
|
1793
2712
|
orientation: "horizontal" | "vertical";
|
|
1794
2713
|
indexRef: React.MutableRefObject<number>;
|
|
1795
2714
|
nonInteractiveIds: string[];
|
|
1796
2715
|
isVirtualized: boolean;
|
|
1797
2716
|
items: import("../..").Item<any>[];
|
|
1798
2717
|
mode: "multiple" | "single";
|
|
2718
|
+
/**
|
|
2719
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2720
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2721
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2722
|
+
*/
|
|
1799
2723
|
value: string | undefined;
|
|
1800
2724
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1801
2725
|
width: number;
|
|
@@ -1824,13 +2748,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1824
2748
|
measure: () => void;
|
|
1825
2749
|
};
|
|
1826
2750
|
UNSTABLE_defaultItemHeight: number;
|
|
1827
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2751
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2752
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2753
|
+
*
|
|
2754
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2755
|
+
*
|
|
2756
|
+
* ```tsx
|
|
2757
|
+
* <Select items={options}>
|
|
2758
|
+
* <FormField label="Your Label">
|
|
2759
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2760
|
+
* <Select.Popper>
|
|
2761
|
+
* <Select.Card>
|
|
2762
|
+
* ...
|
|
2763
|
+
* </Select.Card>
|
|
2764
|
+
* </Select.Popper>
|
|
2765
|
+
* </FormField>
|
|
2766
|
+
* </Select>
|
|
2767
|
+
* ```
|
|
2768
|
+
*/
|
|
1828
2769
|
orientation: "horizontal" | "vertical";
|
|
1829
2770
|
indexRef: React.MutableRefObject<number>;
|
|
1830
2771
|
nonInteractiveIds: string[];
|
|
1831
2772
|
isVirtualized: boolean;
|
|
1832
2773
|
items: import("../..").Item<any>[];
|
|
1833
2774
|
mode: "multiple" | "single";
|
|
2775
|
+
/**
|
|
2776
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2777
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2778
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2779
|
+
*/
|
|
1834
2780
|
value: string | undefined;
|
|
1835
2781
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1836
2782
|
width: number;
|
|
@@ -1859,13 +2805,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1859
2805
|
measure: () => void;
|
|
1860
2806
|
};
|
|
1861
2807
|
UNSTABLE_defaultItemHeight: number;
|
|
1862
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2808
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2809
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2810
|
+
*
|
|
2811
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2812
|
+
*
|
|
2813
|
+
* ```tsx
|
|
2814
|
+
* <Select items={options}>
|
|
2815
|
+
* <FormField label="Your Label">
|
|
2816
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2817
|
+
* <Select.Popper>
|
|
2818
|
+
* <Select.Card>
|
|
2819
|
+
* ...
|
|
2820
|
+
* </Select.Card>
|
|
2821
|
+
* </Select.Popper>
|
|
2822
|
+
* </FormField>
|
|
2823
|
+
* </Select>
|
|
2824
|
+
* ```
|
|
2825
|
+
*/
|
|
1863
2826
|
orientation: "horizontal" | "vertical";
|
|
1864
2827
|
indexRef: React.MutableRefObject<number>;
|
|
1865
2828
|
nonInteractiveIds: string[];
|
|
1866
2829
|
isVirtualized: boolean;
|
|
1867
2830
|
items: import("../..").Item<any>[];
|
|
1868
2831
|
mode: "multiple" | "single";
|
|
2832
|
+
/**
|
|
2833
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2834
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2835
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2836
|
+
*/
|
|
1869
2837
|
value: string | undefined;
|
|
1870
2838
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1871
2839
|
width: number;
|
|
@@ -1894,13 +2862,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1894
2862
|
measure: () => void;
|
|
1895
2863
|
};
|
|
1896
2864
|
UNSTABLE_defaultItemHeight: number;
|
|
1897
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2865
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2866
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2867
|
+
*
|
|
2868
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2869
|
+
*
|
|
2870
|
+
* ```tsx
|
|
2871
|
+
* <Select items={options}>
|
|
2872
|
+
* <FormField label="Your Label">
|
|
2873
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2874
|
+
* <Select.Popper>
|
|
2875
|
+
* <Select.Card>
|
|
2876
|
+
* ...
|
|
2877
|
+
* </Select.Card>
|
|
2878
|
+
* </Select.Popper>
|
|
2879
|
+
* </FormField>
|
|
2880
|
+
* </Select>
|
|
2881
|
+
* ```
|
|
2882
|
+
*/
|
|
1898
2883
|
orientation: "horizontal" | "vertical";
|
|
1899
2884
|
indexRef: React.MutableRefObject<number>;
|
|
1900
2885
|
nonInteractiveIds: string[];
|
|
1901
2886
|
isVirtualized: boolean;
|
|
1902
2887
|
items: import("../..").Item<any>[];
|
|
1903
2888
|
mode: "multiple" | "single";
|
|
2889
|
+
/**
|
|
2890
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2891
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2892
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2893
|
+
*/
|
|
1904
2894
|
value: string | undefined;
|
|
1905
2895
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1906
2896
|
width: number;
|
|
@@ -1932,13 +2922,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1932
2922
|
measure: () => void;
|
|
1933
2923
|
};
|
|
1934
2924
|
UNSTABLE_defaultItemHeight: number;
|
|
1935
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2925
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2926
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2927
|
+
*
|
|
2928
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2929
|
+
*
|
|
2930
|
+
* ```tsx
|
|
2931
|
+
* <Select items={options}>
|
|
2932
|
+
* <FormField label="Your Label">
|
|
2933
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2934
|
+
* <Select.Popper>
|
|
2935
|
+
* <Select.Card>
|
|
2936
|
+
* ...
|
|
2937
|
+
* </Select.Card>
|
|
2938
|
+
* </Select.Popper>
|
|
2939
|
+
* </FormField>
|
|
2940
|
+
* </Select>
|
|
2941
|
+
* ```
|
|
2942
|
+
*/
|
|
1936
2943
|
orientation: "horizontal" | "vertical";
|
|
1937
2944
|
indexRef: React.MutableRefObject<number>;
|
|
1938
2945
|
nonInteractiveIds: string[];
|
|
1939
2946
|
isVirtualized: boolean;
|
|
1940
2947
|
items: import("../..").Item<any>[];
|
|
1941
2948
|
mode: "multiple" | "single";
|
|
2949
|
+
/**
|
|
2950
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
2951
|
+
* include icons that you would like to render in the `input` when selected.
|
|
2952
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
2953
|
+
*/
|
|
1942
2954
|
value: string | undefined;
|
|
1943
2955
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1944
2956
|
width: number;
|
|
@@ -1969,13 +2981,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
1969
2981
|
measure: () => void;
|
|
1970
2982
|
};
|
|
1971
2983
|
UNSTABLE_defaultItemHeight: number;
|
|
1972
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
2984
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
2985
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
2986
|
+
*
|
|
2987
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
2988
|
+
*
|
|
2989
|
+
* ```tsx
|
|
2990
|
+
* <Select items={options}>
|
|
2991
|
+
* <FormField label="Your Label">
|
|
2992
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
2993
|
+
* <Select.Popper>
|
|
2994
|
+
* <Select.Card>
|
|
2995
|
+
* ...
|
|
2996
|
+
* </Select.Card>
|
|
2997
|
+
* </Select.Popper>
|
|
2998
|
+
* </FormField>
|
|
2999
|
+
* </Select>
|
|
3000
|
+
* ```
|
|
3001
|
+
*/
|
|
1973
3002
|
orientation: "horizontal" | "vertical";
|
|
1974
3003
|
indexRef: React.MutableRefObject<number>;
|
|
1975
3004
|
nonInteractiveIds: string[];
|
|
1976
3005
|
isVirtualized: boolean;
|
|
1977
3006
|
items: import("../..").Item<any>[];
|
|
1978
3007
|
mode: "multiple" | "single";
|
|
3008
|
+
/**
|
|
3009
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3010
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3011
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3012
|
+
*/
|
|
1979
3013
|
value: string | undefined;
|
|
1980
3014
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
1981
3015
|
width: number;
|
|
@@ -2006,13 +3040,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2006
3040
|
measure: () => void;
|
|
2007
3041
|
};
|
|
2008
3042
|
UNSTABLE_defaultItemHeight: number;
|
|
2009
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3043
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3044
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3045
|
+
*
|
|
3046
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3047
|
+
*
|
|
3048
|
+
* ```tsx
|
|
3049
|
+
* <Select items={options}>
|
|
3050
|
+
* <FormField label="Your Label">
|
|
3051
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3052
|
+
* <Select.Popper>
|
|
3053
|
+
* <Select.Card>
|
|
3054
|
+
* ...
|
|
3055
|
+
* </Select.Card>
|
|
3056
|
+
* </Select.Popper>
|
|
3057
|
+
* </FormField>
|
|
3058
|
+
* </Select>
|
|
3059
|
+
* ```
|
|
3060
|
+
*/
|
|
2010
3061
|
orientation: "horizontal" | "vertical";
|
|
2011
3062
|
indexRef: React.MutableRefObject<number>;
|
|
2012
3063
|
nonInteractiveIds: string[];
|
|
2013
3064
|
isVirtualized: boolean;
|
|
2014
3065
|
items: import("../..").Item<any>[];
|
|
2015
3066
|
mode: "multiple" | "single";
|
|
3067
|
+
/**
|
|
3068
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3069
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3070
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3071
|
+
*/
|
|
2016
3072
|
value: string | undefined;
|
|
2017
3073
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2018
3074
|
width: number;
|
|
@@ -2042,13 +3098,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2042
3098
|
measure: () => void;
|
|
2043
3099
|
};
|
|
2044
3100
|
UNSTABLE_defaultItemHeight: number;
|
|
2045
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3101
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3102
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3103
|
+
*
|
|
3104
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3105
|
+
*
|
|
3106
|
+
* ```tsx
|
|
3107
|
+
* <Select items={options}>
|
|
3108
|
+
* <FormField label="Your Label">
|
|
3109
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3110
|
+
* <Select.Popper>
|
|
3111
|
+
* <Select.Card>
|
|
3112
|
+
* ...
|
|
3113
|
+
* </Select.Card>
|
|
3114
|
+
* </Select.Popper>
|
|
3115
|
+
* </FormField>
|
|
3116
|
+
* </Select>
|
|
3117
|
+
* ```
|
|
3118
|
+
*/
|
|
2046
3119
|
orientation: "horizontal" | "vertical";
|
|
2047
3120
|
indexRef: React.MutableRefObject<number>;
|
|
2048
3121
|
nonInteractiveIds: string[];
|
|
2049
3122
|
isVirtualized: boolean;
|
|
2050
3123
|
items: import("../..").Item<any>[];
|
|
2051
3124
|
mode: "multiple" | "single";
|
|
3125
|
+
/**
|
|
3126
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3127
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3128
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3129
|
+
*/
|
|
2052
3130
|
value: string | undefined;
|
|
2053
3131
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2054
3132
|
width: number;
|
|
@@ -2134,13 +3212,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2134
3212
|
measure: () => void;
|
|
2135
3213
|
};
|
|
2136
3214
|
UNSTABLE_defaultItemHeight: number;
|
|
2137
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3215
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3216
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3217
|
+
*
|
|
3218
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3219
|
+
*
|
|
3220
|
+
* ```tsx
|
|
3221
|
+
* <Select items={options}>
|
|
3222
|
+
* <FormField label="Your Label">
|
|
3223
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3224
|
+
* <Select.Popper>
|
|
3225
|
+
* <Select.Card>
|
|
3226
|
+
* ...
|
|
3227
|
+
* </Select.Card>
|
|
3228
|
+
* </Select.Popper>
|
|
3229
|
+
* </FormField>
|
|
3230
|
+
* </Select>
|
|
3231
|
+
* ```
|
|
3232
|
+
*/
|
|
2138
3233
|
orientation: "horizontal" | "vertical";
|
|
2139
3234
|
indexRef: React.MutableRefObject<number>;
|
|
2140
3235
|
nonInteractiveIds: string[];
|
|
2141
3236
|
isVirtualized: boolean;
|
|
2142
3237
|
items: import("../..").Item<any>[];
|
|
2143
3238
|
mode: "multiple" | "single";
|
|
3239
|
+
/**
|
|
3240
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3241
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3242
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3243
|
+
*/
|
|
2144
3244
|
value: string | undefined;
|
|
2145
3245
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2146
3246
|
width: number;
|
|
@@ -2225,7 +3325,24 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2225
3325
|
measure: () => void;
|
|
2226
3326
|
};
|
|
2227
3327
|
UNSTABLE_defaultItemHeight: number;
|
|
2228
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3328
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3329
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3330
|
+
*
|
|
3331
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3332
|
+
*
|
|
3333
|
+
* ```tsx
|
|
3334
|
+
* <Select items={options}>
|
|
3335
|
+
* <FormField label="Your Label">
|
|
3336
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3337
|
+
* <Select.Popper>
|
|
3338
|
+
* <Select.Card>
|
|
3339
|
+
* ...
|
|
3340
|
+
* </Select.Card>
|
|
3341
|
+
* </Select.Popper>
|
|
3342
|
+
* </FormField>
|
|
3343
|
+
* </Select>
|
|
3344
|
+
* ```
|
|
3345
|
+
*/
|
|
2229
3346
|
orientation: "horizontal" | "vertical";
|
|
2230
3347
|
indexRef: React.MutableRefObject<number>;
|
|
2231
3348
|
nonInteractiveIds: string[];
|
|
@@ -2315,13 +3432,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2315
3432
|
measure: () => void;
|
|
2316
3433
|
};
|
|
2317
3434
|
UNSTABLE_defaultItemHeight: number;
|
|
2318
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3435
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3436
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3437
|
+
*
|
|
3438
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3439
|
+
*
|
|
3440
|
+
* ```tsx
|
|
3441
|
+
* <Select items={options}>
|
|
3442
|
+
* <FormField label="Your Label">
|
|
3443
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3444
|
+
* <Select.Popper>
|
|
3445
|
+
* <Select.Card>
|
|
3446
|
+
* ...
|
|
3447
|
+
* </Select.Card>
|
|
3448
|
+
* </Select.Popper>
|
|
3449
|
+
* </FormField>
|
|
3450
|
+
* </Select>
|
|
3451
|
+
* ```
|
|
3452
|
+
*/
|
|
2319
3453
|
orientation: "horizontal" | "vertical";
|
|
2320
3454
|
indexRef: React.MutableRefObject<number>;
|
|
2321
3455
|
nonInteractiveIds: string[];
|
|
2322
3456
|
isVirtualized: boolean;
|
|
2323
3457
|
items: import("../..").Item<any>[];
|
|
2324
3458
|
mode: "multiple" | "single";
|
|
3459
|
+
/**
|
|
3460
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3461
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3462
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3463
|
+
*/
|
|
2325
3464
|
value: string | undefined;
|
|
2326
3465
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2327
3466
|
width: number;
|
|
@@ -2391,13 +3530,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2391
3530
|
measure: () => void;
|
|
2392
3531
|
};
|
|
2393
3532
|
UNSTABLE_defaultItemHeight: number;
|
|
2394
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3533
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3534
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3535
|
+
*
|
|
3536
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3537
|
+
*
|
|
3538
|
+
* ```tsx
|
|
3539
|
+
* <Select items={options}>
|
|
3540
|
+
* <FormField label="Your Label">
|
|
3541
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3542
|
+
* <Select.Popper>
|
|
3543
|
+
* <Select.Card>
|
|
3544
|
+
* ...
|
|
3545
|
+
* </Select.Card>
|
|
3546
|
+
* </Select.Popper>
|
|
3547
|
+
* </FormField>
|
|
3548
|
+
* </Select>
|
|
3549
|
+
* ```
|
|
3550
|
+
*/
|
|
2395
3551
|
orientation: "horizontal" | "vertical";
|
|
2396
3552
|
indexRef: React.MutableRefObject<number>;
|
|
2397
3553
|
nonInteractiveIds: string[];
|
|
2398
3554
|
isVirtualized: boolean;
|
|
2399
3555
|
items: import("../..").Item<any>[];
|
|
2400
3556
|
mode: "multiple" | "single";
|
|
3557
|
+
/**
|
|
3558
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3559
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3560
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3561
|
+
*/
|
|
2401
3562
|
value: string | undefined;
|
|
2402
3563
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2403
3564
|
width: number;
|
|
@@ -2486,13 +3647,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2486
3647
|
measure: () => void;
|
|
2487
3648
|
};
|
|
2488
3649
|
UNSTABLE_defaultItemHeight: number;
|
|
2489
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3650
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3651
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3652
|
+
*
|
|
3653
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3654
|
+
*
|
|
3655
|
+
* ```tsx
|
|
3656
|
+
* <Select items={options}>
|
|
3657
|
+
* <FormField label="Your Label">
|
|
3658
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3659
|
+
* <Select.Popper>
|
|
3660
|
+
* <Select.Card>
|
|
3661
|
+
* ...
|
|
3662
|
+
* </Select.Card>
|
|
3663
|
+
* </Select.Popper>
|
|
3664
|
+
* </FormField>
|
|
3665
|
+
* </Select>
|
|
3666
|
+
* ```
|
|
3667
|
+
*/
|
|
2490
3668
|
orientation: "horizontal" | "vertical";
|
|
2491
3669
|
indexRef: React.MutableRefObject<number>;
|
|
2492
3670
|
nonInteractiveIds: string[];
|
|
2493
3671
|
isVirtualized: boolean;
|
|
2494
3672
|
items: import("../..").Item<any>[];
|
|
2495
3673
|
mode: "multiple" | "single";
|
|
3674
|
+
/**
|
|
3675
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3676
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3677
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3678
|
+
*/
|
|
2496
3679
|
value: string | undefined;
|
|
2497
3680
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2498
3681
|
width: number;
|
|
@@ -2581,13 +3764,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2581
3764
|
measure: () => void;
|
|
2582
3765
|
};
|
|
2583
3766
|
UNSTABLE_defaultItemHeight: number;
|
|
2584
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3767
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3768
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3769
|
+
*
|
|
3770
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3771
|
+
*
|
|
3772
|
+
* ```tsx
|
|
3773
|
+
* <Select items={options}>
|
|
3774
|
+
* <FormField label="Your Label">
|
|
3775
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3776
|
+
* <Select.Popper>
|
|
3777
|
+
* <Select.Card>
|
|
3778
|
+
* ...
|
|
3779
|
+
* </Select.Card>
|
|
3780
|
+
* </Select.Popper>
|
|
3781
|
+
* </FormField>
|
|
3782
|
+
* </Select>
|
|
3783
|
+
* ```
|
|
3784
|
+
*/
|
|
2585
3785
|
orientation: "horizontal" | "vertical";
|
|
2586
3786
|
indexRef: React.MutableRefObject<number>;
|
|
2587
3787
|
nonInteractiveIds: string[];
|
|
2588
3788
|
isVirtualized: boolean;
|
|
2589
3789
|
items: import("../..").Item<any>[];
|
|
2590
3790
|
mode: "multiple" | "single";
|
|
3791
|
+
/**
|
|
3792
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3793
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3794
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3795
|
+
*/
|
|
2591
3796
|
value: string | undefined;
|
|
2592
3797
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2593
3798
|
width: number;
|
|
@@ -2657,13 +3862,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2657
3862
|
measure: () => void;
|
|
2658
3863
|
};
|
|
2659
3864
|
UNSTABLE_defaultItemHeight: number;
|
|
2660
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3865
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3866
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3867
|
+
*
|
|
3868
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3869
|
+
*
|
|
3870
|
+
* ```tsx
|
|
3871
|
+
* <Select items={options}>
|
|
3872
|
+
* <FormField label="Your Label">
|
|
3873
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3874
|
+
* <Select.Popper>
|
|
3875
|
+
* <Select.Card>
|
|
3876
|
+
* ...
|
|
3877
|
+
* </Select.Card>
|
|
3878
|
+
* </Select.Popper>
|
|
3879
|
+
* </FormField>
|
|
3880
|
+
* </Select>
|
|
3881
|
+
* ```
|
|
3882
|
+
*/
|
|
2661
3883
|
orientation: "horizontal" | "vertical";
|
|
2662
3884
|
indexRef: React.MutableRefObject<number>;
|
|
2663
3885
|
nonInteractiveIds: string[];
|
|
2664
3886
|
isVirtualized: boolean;
|
|
2665
3887
|
items: import("../..").Item<any>[];
|
|
2666
3888
|
mode: "multiple" | "single";
|
|
3889
|
+
/**
|
|
3890
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3891
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3892
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3893
|
+
*/
|
|
2667
3894
|
value: string | undefined;
|
|
2668
3895
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2669
3896
|
width: number;
|
|
@@ -2734,13 +3961,35 @@ export declare const Select: import("@workday/canvas-kit-react/common").Componen
|
|
|
2734
3961
|
measure: () => void;
|
|
2735
3962
|
};
|
|
2736
3963
|
UNSTABLE_defaultItemHeight: number;
|
|
2737
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
3964
|
+
containerRef: React.RefObject<HTMLDivElement>; /**
|
|
3965
|
+
* `Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.
|
|
3966
|
+
*
|
|
3967
|
+
* **Note: The card will be the width of its corresponding `Select.Input`**.
|
|
3968
|
+
*
|
|
3969
|
+
* ```tsx
|
|
3970
|
+
* <Select items={options}>
|
|
3971
|
+
* <FormField label="Your Label">
|
|
3972
|
+
* <Select.Input onChange={(event) => handleChange(event)}>
|
|
3973
|
+
* <Select.Popper>
|
|
3974
|
+
* <Select.Card>
|
|
3975
|
+
* ...
|
|
3976
|
+
* </Select.Card>
|
|
3977
|
+
* </Select.Popper>
|
|
3978
|
+
* </FormField>
|
|
3979
|
+
* </Select>
|
|
3980
|
+
* ```
|
|
3981
|
+
*/
|
|
2738
3982
|
orientation: "horizontal" | "vertical";
|
|
2739
3983
|
indexRef: React.MutableRefObject<number>;
|
|
2740
3984
|
nonInteractiveIds: string[];
|
|
2741
3985
|
isVirtualized: boolean;
|
|
2742
3986
|
items: import("../..").Item<any>[];
|
|
2743
3987
|
mode: "multiple" | "single";
|
|
3988
|
+
/**
|
|
3989
|
+
* The Icon to render at the start of the `input`. Use this prop if your options
|
|
3990
|
+
* include icons that you would like to render in the `input` when selected.
|
|
3991
|
+
* ** Note:An option must be selected in order to render and icon.**
|
|
3992
|
+
*/
|
|
2744
3993
|
value: string | undefined;
|
|
2745
3994
|
inputRef: React.RefObject<HTMLInputElement>;
|
|
2746
3995
|
width: number;
|