-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathall-exported-props.js
5391 lines (3859 loc) · 166 KB
/
all-exported-props.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import PropTypes from 'prop-types';
// Button Component PropTypes
Button.propTypes = {
/** Defines the button type */
type: PropTypes.oneOf(['primary', 'ghost', 'dashed', 'link', 'text', 'default']),
/** Function to handle click event */
onClick: PropTypes.func,
/** Whether the button is disabled */
disabled: PropTypes.bool,
/** Set the loading status of button */
loading: PropTypes.bool,
/** Defines the shape of the button */
shape: PropTypes.oneOf(['circle', 'round']),
/** Defines the size of the button */
size: PropTypes.oneOf(['large', 'middle', 'small']),
/** Icon to be displayed in the button */
icon: PropTypes.node,
/** Whether the button should display as a block element */
block: PropTypes.bool,
/** Makes the background transparent and invert the text and border colors */
ghost: PropTypes.bool,
/** Set the danger status of button */
danger: PropTypes.bool,
/** Redirect url of link button */
href: PropTypes.string,
/** Specifies where to display the linked URL */
target: PropTypes.string,
/** Set the original html type of the button */
htmlType: PropTypes.oneOf(['submit', 'button', 'reset']),
};
// FloatButton Component PropTypes
FloatButton.propTypes = {
/** Function to handle click event */
onClick: PropTypes.func,
/** Defines the position of the button */
position: PropTypes.oneOf(['top-left', 'top-right', 'bottom-left', 'bottom-right']),
/** Icon to be displayed in the button */
icon: PropTypes.node,
/** Size of the button */
size: PropTypes.oneOf(['small', 'medium', 'large']),
/** Color of the button */
color: PropTypes.string,
/** Whether the button is disabled */
disabled: PropTypes.bool,
/** Tooltip text for the button */
tooltip: PropTypes.string,
/** Custom styling for the button */
style: PropTypes.object,
};
// Typography.Text Component PropTypes for Ant Design v5
Typography.Text.propTypes = {
/** The content of the Text */
children: PropTypes.node,
/** Set the text to bold */
strong: PropTypes.bool,
/** Set the color of the text */
color: PropTypes.string,
/** Add a delete line style */
delete: PropTypes.bool,
/** Add an underline to the text */
underline: PropTypes.bool,
/** Highlight the text */
mark: PropTypes.bool,
/** Italicize the text */
italic: PropTypes.bool,
/** Render text as code */
code: PropTypes.bool,
/** Display text with an ellipsis when it overflows */
ellipsis: PropTypes.bool,
/** Add custom styles to the text */
style: PropTypes.object,
/** Add custom class names to the text */
className: PropTypes.string,
/** Make the text copyable */
copyable: PropTypes.bool,
/** Set typography type */
type: PropTypes.oneOf(['secondary', 'success', 'warning', 'danger']),
/** Define custom behavior for ellipsis expansion */
onEllipsis: PropTypes.func,
/** Set the component that will be rendered */
component: PropTypes.string,
/** Disable text selection */
disabled: PropTypes.bool,
/** Set the keyboard style */
keyboard: PropTypes.bool,
/** Set a hyperlink for the text */
href: PropTypes.string,
/** Set the target attribute for hyperlink */
target: PropTypes.string,
/** Set the rel attribute for hyperlink */
rel: PropTypes.string,
/** Set the title attribute for hyperlink */
title: PropTypes.string,
/** Define click event handler */
onClick: PropTypes.func,
};
// Typography.Paragraph Component PropTypes for Ant Design v5
Typography.Paragraph.propTypes = {
/** Content of the Paragraph */
children: PropTypes.node,
/** Set the text to bold */
strong: PropTypes.bool,
/** Set the color of the text */
color: PropTypes.string,
/** Add a delete line style */
delete: PropTypes.bool,
/** Add an underline to the text */
underline: PropTypes.bool,
/** Highlight the text */
mark: PropTypes.bool,
/** Italicize the text */
italic: PropTypes.bool,
/** Render text as code */
code: PropTypes.bool,
/** Display text with an ellipsis when it overflows */
ellipsis: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.shape({
rows: PropTypes.number, // Maximum number of rows before showing ellipsis
expandable: PropTypes.bool, // Allow expansion
onExpand: PropTypes.func, // Callback when expanded
suffix: PropTypes.string, // Add suffix at the end of the text
tooltip: PropTypes.oneOfType([PropTypes.bool, PropTypes.node]), // Show tooltip with full content
}),
]),
/** Add custom styles to the text */
style: PropTypes.object,
/** Add custom class names to the text */
className: PropTypes.string,
/** Make the text copyable */
copyable: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.shape({
text: PropTypes.string, // Text to be copied
onCopy: PropTypes.func, // Callback after text is copied
icon: PropTypes.node, // Custom icon for copy action
tooltips: PropTypes.bool, // Show tooltips
}),
]),
/** Set typography type */
type: PropTypes.oneOf(['secondary', 'success', 'warning', 'danger']),
/** Define custom behavior for ellipsis expansion */
onEllipsis: PropTypes.func,
/** Set the component that will be rendered */
component: PropTypes.elementType,
/** Disable text selection */
disabled: PropTypes.bool,
/** Set the keyboard style */
keyboard: PropTypes.bool,
/** Set a hyperlink for the text */
href: PropTypes.string,
/** Set the target attribute for hyperlink */
target: PropTypes.string,
/** Set the rel attribute for hyperlink */
rel: PropTypes.string,
/** Set the title attribute for hyperlink */
title: PropTypes.string,
/** Define click event handler */
onClick: PropTypes.func,
/** Responsive settings for different screen sizes */
responsive: PropTypes.bool,
};
// Typography.Title Component PropTypes for Ant Design v5
Typography.Title.propTypes = {
/** Content of the Title */
children: PropTypes.node,
/** Level of the title for defining size (h1, h2, etc.) */
level: PropTypes.oneOf([1, 2, 3, 4, 5]),
/** Set the title text to bold */
strong: PropTypes.bool,
/** Set the color of the title text */
color: PropTypes.string,
/** Add a delete line style to the title text */
delete: PropTypes.bool,
/** Add an underline to the title text */
underline: PropTypes.bool,
/** Highlight the title text */
mark: PropTypes.bool,
/** Italicize the title text */
italic: PropTypes.bool,
/** Render title text as code */
code: PropTypes.bool,
/** Display title text with an ellipsis when it overflows */
ellipsis: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.shape({
rows: PropTypes.number, // Maximum number of rows before showing ellipsis
expandable: PropTypes.bool, // Allow expansion
onExpand: PropTypes.func, // Callback when expanded
suffix: PropTypes.string, // Add suffix at the end of the text
tooltip: PropTypes.oneOfType([PropTypes.bool, PropTypes.node]), // Show tooltip with full content
}),
]),
/** Add custom styles to the title text */
style: PropTypes.object,
/** Add custom class names to the title text */
className: PropTypes.string,
/** Make the title text copyable */
copyable: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.shape({
text: PropTypes.string, // Text to be copied
onCopy: PropTypes.func, // Callback after text is copied
icon: PropTypes.node, // Custom icon for copy action
tooltips: PropTypes.bool, // Show tooltips
}),
]),
/** Define custom behavior for ellipsis expansion */
onEllipsis: PropTypes.func,
/** Set the component that will be rendered */
component: PropTypes.elementType,
/** Set a hyperlink for the title text */
href: PropTypes.string,
/** Set the target attribute for the hyperlink */
target: PropTypes.string,
/** Set the rel attribute for the hyperlink */
rel: PropTypes.string,
/** Set the title attribute for the hyperlink */
title: PropTypes.string,
/** Define click event handler */
onClick: PropTypes.func,
/** Responsive settings for different screen sizes */
responsive: PropTypes.bool,
};
// Col Component PropTypes
Col.propTypes = {
/** Flex layout style */
flex: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/** The number of cells to offset Col from the left */
offset: PropTypes.number,
/** Raster order */
order: PropTypes.number,
/** The number of cells that raster is moved to the left */
pull: PropTypes.number,
/** The number of cells that raster is moved to the right */
push: PropTypes.number,
/** Raster number of cells to occupy, 0 corresponds to display: none */
span: PropTypes.number,
/** Responsive settings for different screen sizes */
xs: responsivePropType,
sm: responsivePropType,
md: responsivePropType,
lg: responsivePropType,
xl: responsivePropType,
xxl: responsivePropType,
/** Custom CSS class for the column */
className: PropTypes.string,
/** Custom style for the column */
style: PropTypes.object,
};
// Row Component PropTypes
Row.propTypes = {
/** Horizontal alignment of the flex layout */
justify: PropTypes.oneOf(['start', 'end', 'center', 'space-around', 'space-between', 'space-evenly']),
/** Vertical alignment of the flex layout */
align: PropTypes.oneOf(['top', 'middle', 'bottom']),
/** Spacing between grid items */
gutter: PropTypes.oneOfType([
PropTypes.number,
PropTypes.arrayOf(PropTypes.number),
PropTypes.object
]),
/** Whether to wrap grid items */
wrap: PropTypes.bool,
/** Custom CSS class for the row */
className: PropTypes.string,
/** Custom style for the row */
style: PropTypes.object,
};
// Divider Component PropTypes
Divider.propTypes = {
/** Orientation of divider text */
orientation: PropTypes.oneOf(['left', 'right', 'center']),
/** Whether the divider is dashed */
dashed: PropTypes.bool,
/** Text inside the divider */
children: PropTypes.node,
/** Custom style for the divider */
style: PropTypes.object,
/** Custom CSS class for the divider */
className: PropTypes.string,
/** Type of the divider line */
type: PropTypes.oneOf(['horizontal', 'vertical']),
/** Custom plain style */
plain: PropTypes.bool,
};
Flex.propTypes = {
/** Sets the alignment of elements in the direction of the cross axis */
align: PropTypes.oneOf(['normal']),
/** custom element type */
component: PropTypes.elementType,
/** Sets the flex CSS shorthand properties */
flex: PropTypes.oneOf(['normal']),
/** Sets the gap between grids: number, 'small', 'middle', 'large' */
gap: PropTypes.oneOfType([
PropTypes.oneOf(['small', 'middle', 'large']),
PropTypes.string,
PropTypes.number
]),
/** Sets the alignment of elements in the direction of the main axis */
justify: PropTypes.oneOf(['normal']),
/** Sets whether the element is displayed in a single line or in multiple lines */
wrap: PropTypes.string,
/** Is direction of the flex vertical, use flex-direction: column */
vertical: PropTypes.bool,
};
// Space Component PropTypes
Space.propTypes = {
/** The direction of space */
direction: PropTypes.oneOf(['vertical', 'horizontal']),
/** Size of the space, can be an array to set horizontal and vertical spacing */
size: PropTypes.oneOf(['small', 'medium', 'large']),
/** Whether to wrap items */
wrap: PropTypes.bool,
/** Alignment of items in the space */
align: PropTypes.oneOf(['start', 'end', 'center', 'baseline']),
/** Custom style for the space container */
style: PropTypes.object,
/** Custom class names for the space container */
className: PropTypes.string,
/** React elements within space */
children: PropTypes.node,
/** Split the space with a specific separator */
split: PropTypes.node,
};
Space.compact.propTypes = {
/** Option to fit width to its parent's width */
block: PropTypes.bool,
/** Set direction of layout */
direction: PropTypes.oneOf(['vertical', 'horizontal']),
/** Set child component size */
size: PropTypes.oneOf(['large', 'middle', 'small']),
};
// Layout Component PropTypes
Layout.propTypes = {
/** Custom style for the layout */
style: PropTypes.object,
/** Custom class name for the layout */
className: PropTypes.string,
/** Whether the layout has a `Sider` in its children */
hasSider: PropTypes.bool,
/** Children components inside the layout */
children: PropTypes.node,
};
// Layout.Sider Component PropTypes
Layout.Sider.propTypes = {
/** Children components inside the Sider */
children: PropTypes.node,
/** The breakpoint at which the Sider will automatically collapse */
breakpoint: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
/** Whether the Sider is collapsible */
collapsible: PropTypes.bool,
/** Current collapse status of the Sider */
collapsed: PropTypes.bool,
/** Width of the Sider when it's collapsed */
collapsedWidth: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
/** Custom class name for the sider */
className: PropTypes.string,
/** To set the default collapsed status */
defaultCollapsed: PropTypes.bool,
/** Triggered when the collapse status is changed */
onCollapse: PropTypes.func,
/** Reverse direction of arrow, for a collapsible sider */
reverseArrow: PropTypes.bool,
/** Custom style for the sider */
style: PropTypes.object,
/** The theme of the Sider */
theme: PropTypes.oneOf(['light', 'dark']),
/** Whether to render the trigger or not */
trigger: PropTypes.node,
/** Width of the Sider when it's unfolded */
width: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
/** Zero width trigger styling */
zeroWidthTriggerStyle: PropTypes.object,
};
Anchor.propTypes = {
/** Set the component that will be rendered */
children: PropTypes.node,
/** Fixed mode of Anchor */
affix: PropTypes.bool,
/** Bounding distance of anchor area */
bounds: PropTypes.number,
/** Scrolling container */
getContainer: PropTypes.func,
/** Customize the anchor highlight */
getCurrentAnchor: PropTypes.func,
/** Pixels to offset from top when calculating position of scroll */
offsetTop: PropTypes.number,
/** Whether show ink-square when affix={false} */
showInkInFixed: PropTypes.bool,
/** Anchor scroll offset, default as offsetTop, example */
targetOffset: PropTypes.number,
/** Listening for anchor link change */
onChange: PropTypes.func,
/** Set the handler to handle click event */
onClick: PropTypes.func,
/** Data configuration option content, support nesting through children */
items: PropTypes.arrayOf(
PropTypes.shape({
key: PropTypes.string,
href: PropTypes.string,
title: PropTypes.string,
target: PropTypes.string,
children: PropTypes.node,
})
),
/** Set Anchor direction */
direction: PropTypes.oneOf(['vertical', 'horizontal']),
/** Replace items' href in browser history instead of pushing it */
replace: PropTypes.bool,
}
AnchorItem.propTypes = {
/** The unique identifier of the Anchor Link */
key: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/** The target of hyperlink */
href: PropTypes.string,
/** Specifies where to display the linked URL */
target: PropTypes.string,
/** The content of hyperlink */
title: PropTypes.node,
/** Nested Anchor Link, Attention: This attribute does not support horizontal orientation */
children: PropTypes.arrayOf(PropTypes.shape({ type: PropTypes.oneOf([AnchorItem]) })),
/** Replace item href in browser history instead of pushing it */
replace: PropTypes.bool,
};
Breadcrumb.propTypes = {
/** Custom item renderer */
itemRender: PropTypes.func,
/** Routing parameters */
params: PropTypes.object,
/** The routing stack information of router */
items: PropTypes.array,
/** Custom separator */
separator: PropTypes.node,
};
Dropdown.propTypes = {
/** Whether the dropdown arrow should be visible */
arrow: PropTypes.bool,
/** Whether to adjust dropdown placement automatically when dropdown is off screen */
autoAdjustOverflow: PropTypes.bool,
/** Focus element in overlay when opened */
autoFocus: PropTypes.bool,
/** Whether the dropdown menu is disabled */
disabled: PropTypes.bool,
/** Whether destroy dropdown when hidden */
destroyPopupOnHide: PropTypes.bool,
/** Customize dropdown content */
dropdownRender: PropTypes.func,
/** To set the container of the dropdown menu. The default is to create a div element in body, but you can reset it to the scrolling area and make a relative reposition. Example on CodePen */
getPopupContainer: PropTypes.func,
/** The menu props */
menu: PropTypes.shape(MenuProps),
/** The class name of the dropdown root element */
overlayClassName: PropTypes.string,
/** The style of the dropdown root element */
overlayStyle: PropTypes.object,
/** Placement of popup menu: bottom bottomLeft bottomRight top topLeft topRight */
placement: PropTypes.oneOf(['bottom', 'bottomLeft', 'bottomRight', 'top', 'topLeft', 'topRight']),
/** The trigger mode which executes the dropdown action. Note that hover can't be used on touchscreens */
trigger: PropTypes.oneOf(['click', 'hover', 'contextMenu']),
/** Whether the dropdown menu is currently open. Use visible under 4.23.0 (why?) */
open: PropTypes.bool,
/** Called when the open state is changed. Not trigger when hidden by click item. Use onVisibleChange under 4.23.0 (why?) */
onOpenChange: PropTypes.func,
};
Dropdown.Button.propTypes = {
/** Whether the dropdown arrow should be visible */
arrow: PropTypes.bool,
/** Whether to adjust dropdown placement automatically when dropdown is off screen */
autoAdjustOverflow: PropTypes.bool,
/** Focus element in overlay when opened */
autoFocus: PropTypes.bool,
/** Whether the dropdown menu is disabled */
disabled: PropTypes.bool,
/** Whether destroy dropdown when hidden */
destroyPopupOnHide: PropTypes.bool,
/** Customize dropdown content */
dropdownRender: PropTypes.func,
/** To set the container of the dropdown menu. The default is to create a div element in body, but you can reset it to the scrolling area and make a relative reposition. Example on CodePen */
getPopupContainer: PropTypes.func,
/** The menu props */
menu: PropTypes.shape(MenuProps),
/** The class name of the dropdown root element */
overlayClassName: PropTypes.string,
/** The style of the dropdown root element */
overlayStyle: PropTypes.object,
/** Placement of popup menu: bottom bottomLeft bottomRight top topLeft topRight */
placement: PropTypes.oneOf(['bottom', 'bottomLeft', 'bottomRight', 'top', 'topLeft', 'topRight']),
/** The trigger mode which executes the dropdown action. Note that hover can't be used on touchscreens */
trigger: PropTypes.oneOf(['click', 'hover', 'contextMenu']),
/** Whether the dropdown menu is currently open. Use visible under 4.23.0 (why?) */
open: PropTypes.bool,
/** Called when the open state is changed. Not trigger when hidden by click item. Use onVisibleChange under 4.23.0 (why?) */
onOpenChange: PropTypes.func,
/** Custom buttons inside Dropdown.Button */
buttonsRender: PropTypes.func,
/** Set the loading status of button */
loading: PropTypes.bool,
/** Set the danger status of button */
danger: PropTypes.bool,
/** Icon (appears on the right) */
icon: PropTypes.node,
/** Size of the button, the same as Button */
size: PropTypes.string,
/** Type of the button, the same as Button */
type: PropTypes.string,
/** The same as Button: called when you click the button on the left */
onClick: PropTypes.func,
};
Menu.propTypes = {
/** Array with the keys of default opened sub menus */
defaultOpenKeys: PropTypes.arrayOf(PropTypes.string),
/** Array with the keys of default selected menu items */
defaultSelectedKeys: PropTypes.arrayOf(PropTypes.string),
/** Custom expand icon of submenu */
expandIcon: PropTypes.node,
/** Render submenu into DOM before it becomes visible */
forceSubMenuRender: PropTypes.bool,
/** Specifies the collapsed status when menu is inline mode */
inlineCollapsed: PropTypes.bool,
/** Indent (in pixels) of inline menu items on each level */
inlineIndent: PropTypes.number,
/** Menu item content */
items: PropTypes.arrayOf(PropTypes.shape({ type: PropTypes.oneOf([ItemType]) })),
/** Type of menu */
mode: PropTypes.oneOf(['vertical', 'horizontal', 'inline']),
/** Allows selection of multiple items */
multiple: PropTypes.bool,
/** Array with the keys of currently opened sub-menus */
openKeys: PropTypes.arrayOf(PropTypes.string),
/** Customized the ellipsis icon when menu is collapsed horizontally */
overflowedIndicator: PropTypes.node,
/** Allows selecting menu items */
selectable: PropTypes.bool,
/** Array with the keys of currently selected menu items */
selectedKeys: PropTypes.arrayOf(PropTypes.string),
/** Style of the root node */
style: PropTypes.object,
/** Delay time to hide submenu when mouse leaves (in seconds) */
subMenuCloseDelay: PropTypes.number,
/** Delay time to show submenu when mouse enters, (in seconds) */
subMenuOpenDelay: PropTypes.number,
/** Color theme of the menu */
theme: PropTypes.oneOf(['light', 'dark']),
/** Which action can trigger submenu open/close */
triggerSubMenuAction: PropTypes.oneOf(['hover', 'click']),
/** Called when a menu item is clicked */
onClick: PropTypes.func,
/** Called when a menu item is deselected (multiple mode only) */
onDeselect: PropTypes.func,
/** Called when sub-menus are opened or closed */
onOpenChange: PropTypes.func,
/** Called when a menu item is selected */
onSelect: PropTypes.func,
};
MenuItemType.propTypes = {
/** Display the danger style */
danger: PropTypes.bool,
/** Whether menu item is disabled */
disabled: PropTypes.bool,
/** The icon of the menu item */
icon: PropTypes.node,
/** Unique ID of the menu item */
key: PropTypes.string,
/** Menu label */
label: PropTypes.node,
/** Set display title for collapsed item */
title: PropTypes.string,
};
SubMenuType.propTypes = {
/** Sub-menus or sub-menu items */
children: PropTypes.node,
/** Whether sub-menu is disabled */
disabled: PropTypes.bool,
/** Icon of sub menu */
icon: PropTypes.node,
/** Unique ID of the sub-menu */
key: PropTypes.string,
/** Menu label */
label: PropTypes.node,
/** Sub-menu class name, not working when mode="inline" */
popupClassName: PropTypes.string,
/** Sub-menu offset, not working when mode="inline" */
popupOffset: PropTypes.arrayOf(PropTypes.number),
/** Color theme of the SubMenu (inherits from Menu by default) */
theme: PropTypes.oneOf(['light', 'dark']),
/** Callback executed when the sub-menu title is clicked */
onTitleClick: PropTypes.func,
};
Pagination.propTypes = {
/** Current page number */
current: PropTypes.number,
/** Default initial page number */
defaultCurrent: PropTypes.number,
/** Default number of data items per page */
defaultPageSize: PropTypes.number,
/** Disable pagination */
disabled: PropTypes.bool,
/** Whether to hide pager on a single page */
hideOnSinglePage: PropTypes.bool,
/** To customize item's innerHTML */
itemRender: PropTypes.func,
/** Number of data items per page */
pageSize: PropTypes.number,
/** Specify the sizeChanger options */
pageSizeOptions: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.arrayOf(PropTypes.number)]),
/** If size is not specified, Pagination would resize according to the width of the window */
responsive: PropTypes.bool,
/** Show less page items */
showLessItems: PropTypes.bool,
/** Determine whether you can jump to pages directly */
showQuickJumper: PropTypes.bool,
/** Determine whether to show pageSize select, it will be true when total > 50 */
showSizeChanger: PropTypes.bool,
/** Show page item's title */
showTitle: PropTypes.bool,
/** To display the total number and range */
showTotal: PropTypes.func,
/** Whether to use simple mode */
simple: PropTypes.bool,
/** Specify the size of Pagination, can be set to small */
size: PropTypes.oneOf(['default', 'small']),
/** Total number of data items */
total: PropTypes.number,
/** Called when the page number or pageSize is changed, and it takes the resulting page number and pageSize as its arguments */
onChange: PropTypes.func,
/** Called when pageSize is changed */
onShowSizeChange: PropTypes.func,
};
Steps.propTypes = {
/** Children components, usually Step items */
children: PropTypes.node,
/** Additional CSS class for the Steps component */
className: PropTypes.string,
/** The index of the current step (starting from 0) */
current: PropTypes.number,
/** The direction of the step component, either 'horizontal' or 'vertical' */
direction: PropTypes.oneOf(['horizontal', 'vertical']),
/** The starting number for the first step */
initial: PropTypes.number,
/** The placement of the step label, either 'horizontal' or 'vertical' */
labelPlacement: PropTypes.oneOf(['horizontal', 'vertical']),
/** Function to call when the step changes, provides the current step index as argument */
onChange: PropTypes.func,
/** Percentage of the current step, used when the steps have a progress bar */
percent: PropTypes.number,
/** Whether to apply a dot style progress bar, can be a boolean or a custom render function */
progressDot: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
/** Make the steps responsive */
responsive: PropTypes.bool,
/** The size of the steps, can be 'default' or 'small' */
size: PropTypes.oneOf(['default', 'small']),
/** The status of the current step, can be 'wait', 'process', 'finish', or 'error' */
status: PropTypes.oneOf(['wait', 'process', 'finish', 'error']),
/** Inline style to apply to the Steps component */
style: PropTypes.object,
/** The type of the step component, either 'default' or 'navigation' */
type: PropTypes.oneOf(['default', 'navigation']),
};
StepItem.propTypes = {
/** Children components, usually the content of the step */
children: PropTypes.node,
/** Additional CSS class for the StepItem component */
className: PropTypes.string,
/** Description of the step */
description: PropTypes.node,
/** Icon to be displayed in the step */
icon: PropTypes.node,
/** A status to mark the step as 'wait', 'process', 'finish', or 'error' */
status: PropTypes.oneOf(['wait', 'process', 'finish', 'error']),
/** Title of the step */
title: PropTypes.node,
/** Customized style for the step item */
style: PropTypes.object,
/** Unique identifier for the step */
stepNumber: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/** Whether the step is disabled */
disabled: PropTypes.bool,
/** Callback fired when the step is clicked */
onClick: PropTypes.func,
/** Inline style to apply to the title */
titleStyle: PropTypes.object,
/** Inline style to apply to the description */
descriptionStyle: PropTypes.object,
};
AutoComplete.propTypes = {
/** Children components, typically `AutoComplete.Option` */
children: PropTypes.node,
/** Additional CSS class for the AutoComplete component */
className: PropTypes.string,
/** The default value of the input */
defaultValue: PropTypes.string,
/** Whether the AutoComplete is disabled */
disabled: PropTypes.bool,
/** The data source for autocomplete suggestions */
dataSource: PropTypes.arrayOf(PropTypes.string),
/** Function that will be called when a selection is made */
onSelect: PropTypes.func,
/** Function that will be called when the input is changed */
onChange: PropTypes.func,
/** Placeholder text for the input */
placeholder: PropTypes.string,
/** The value of the input */
value: PropTypes.string,
/** Style object for the container of the AutoComplete */
style: PropTypes.object,