-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
api.d.ts
1494 lines (1473 loc) · 42.3 KB
/
api.d.ts
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
/**
*
* API for PrimeReact components.
*
* @module api
*
*/
import { Dispatch, SetStateAction } from 'react';
import { AccordionPassThroughOptions, AccordionTabPassThroughOptions } from '../accordion/accordion';
import { AutoCompletePassThroughOptions } from '../autocomplete/autocomplete';
import { AvatarPassThroughOptions } from '../avatar/avatar';
import { AvatarGroupPassThroughOptions } from '../avatargroup/avatargroup';
import { BadgePassThroughOptions } from '../badge/badge';
import { BlockUIPassThroughOptions } from '../blockui/blockui';
import { BreadCrumbPassThroughOptions } from '../breadcrumb/breadcrumb';
import { ButtonPassThroughOptions } from '../button/button';
import { CalendarPassThroughOptions } from '../calendar/calendar';
import { CardPassThroughOptions } from '../card/card';
import { CarouselPassThroughOptions } from '../carousel/carousel';
import { CascadeSelectPassThroughOptions } from '../cascadeselect/cascadeselect';
import { ChartPassThroughOptions } from '../chart/chart';
import { CheckboxPassThroughOptions } from '../checkbox/checkbox';
import { ChipPassThroughOptions } from '../chip/chip';
import { ChipsPassThroughOptions } from '../chips/chips';
import { ColorPickerPassThroughOptions } from '../colorpicker/colorpicker';
import { ColumnPassThroughOptions } from '../column/column';
import { ColumnGroupPassThroughOptions } from '../columngroup/columngroup';
import { ConfirmDialogPassThroughOptions } from '../confirmdialog/confirmdialog';
import { ConfirmPopupPassThroughOptions } from '../confirmpopup/confirmpopup';
import { ContextMenuPassThroughOptions } from '../contextmenu/contextmenu';
import { DataTablePassThroughOptions } from '../datatable/datatable';
import { DataViewLayoutOptionsPassThroughOptions, DataViewPassThroughOptions } from '../dataview/dataview';
import { DeferredContentPassThroughOptions } from '../deferredcontent/deferredcontent';
import { DialogPassThroughOptions } from '../dialog/dialog';
import { DividerPassThroughOptions } from '../divider/divider';
import { DockPassThroughOptions } from '../dock/dock';
import { DropdownPassThroughOptions } from '../dropdown/dropdown';
import { EditorPassThroughOptions } from '../editor/editor';
import { FieldsetPassThroughOptions } from '../fieldset/fieldset';
import { FileUploadPassThroughOptions } from '../fileupload/fileupload';
import { GalleriaPassThroughOptions } from '../galleria/galleria';
import { ImagePassThroughOptions } from '../image/image';
import { InplacePassThroughOptions } from '../inplace/inplace';
import { InputNumberPassThroughOptions } from '../inputnumber/inputnumber';
import { InputSwitchPassThroughOptions } from '../inputswitch/inputswitch';
import { InputTextPassThroughOptions } from '../inputtext/inputtext';
import { InputTextareaPassThroughOptions } from '../inputtextarea/inputtextarea';
import { KnobPassThroughOptions } from '../knob/knob';
import { ListboxPassThroughOptions } from '../listbox/listbox';
import { MegaMenuPassThroughOptions } from '../megamenu/megamenu';
import { MentionPassThroughOptions } from '../mention/mention';
import { MenuPassThroughOptions } from '../menu/menu';
import { MenubarPassThroughOptions } from '../menubar/menubar';
import { MessagePassThroughOptions } from '../message/message';
import { MessagesPassThroughOptions } from '../messages/messages';
import { MultiSelectPassThroughOptions } from '../multiselect/multiselect';
import { MultiStateCheckboxPassThroughOptions } from '../multistatecheckbox/multistatecheckbox';
import { OrderListPassThroughOptions } from '../orderlist/orderlist';
import { OrganizationChartPassThroughOptions } from '../organizationchart/organizationchart';
import { OverlayPanelPassThroughOptions } from '../overlaypanel/overlaypanel';
import { PaginatorPassThroughOptions } from '../paginator/paginator';
import { PanelPassThroughOptions } from '../panel/panel';
import { PanelMenuPassThroughOptions } from '../panelmenu/panelmenu';
import { PassThroughOptions } from '../passthrough';
import { PasswordPassThroughOptions } from '../password/password';
import { PickListPassThroughOptions } from '../picklist/picklist';
import { ProgressBarPassThroughOptions } from '../progressbar/progressbar';
import { ProgressSpinnerPassThroughOptions } from '../progressspinner/progressspinner';
import { RadioButtonPassThroughOptions } from '../radiobutton/radiobutton';
import { RatingPassThroughOptions } from '../rating/rating';
import { RowPassThroughOptions } from '../row/row';
import { ScrollPanelPassThroughOptions } from '../scrollpanel/scrollpanel';
import { ScrollTopPassThroughOptions } from '../scrolltop/scrolltop';
import { SelectButtonPassThroughOptions } from '../selectbutton/selectbutton';
import { SidebarPassThroughOptions } from '../sidebar/sidebar';
import { SkeletonPassThroughOptions } from '../skeleton/skeleton';
import { SlideMenuPassThroughOptions } from '../slidemenu/slidemenu';
import { SliderPassThroughOptions } from '../slider/slider';
import { SpeedDialPassThroughOptions } from '../speeddial/speeddial';
import { SplitButtonPassThroughOptions } from '../splitbutton/splitbutton';
import { SplitterPassThroughOptions } from '../splitter/splitter';
import { StepsPassThroughOptions } from '../steps/steps';
import { TabMenuPassThroughOptions } from '../tabmenu/tabmenu';
import { TabPanelPassThroughOptions, TabViewPassThroughOptions } from '../tabview/tabview';
import { TagPassThroughOptions } from '../tag/tag';
import { TerminalPassThroughOptions } from '../terminal/terminal';
import { TieredMenuPassThroughOptions } from '../tieredmenu/tieredmenu';
import { TimelinePassThroughOptions } from '../timeline/timeline';
import { ToastPassThroughOptions } from '../toast/toast';
import { ToggleButtonPassThroughOptions } from '../togglebutton/togglebutton';
import { ToolbarPassThroughOptions } from '../toolbar/toolbar';
import { TooltipPassThroughOptions } from '../tooltip/tooltip';
import { TreePassThroughOptions } from '../tree/tree';
import { TreeSelectPassThroughOptions } from '../treeselect/treeselect';
import { TreeTablePassThroughOptions } from '../treetable/treetable';
import { VirtualScrollerPassThroughOptions } from '../virtualscroller/virtualscroller';
// Config
/**
* ZIndex configuration options.
*/
export interface ZIndexOptions {
/**
* Sets the base index value for Dialog and Sidebar components.
* @defaultValue 1100
*/
modal: number;
/**
* Sets the base index value for Overlay components such as Dropdown and OverlayPanel.
* @defaultValue 1000
*/
overlay: number;
/**
* Sets the base index value for Overlay menus.
* @defaultValue 1000
*/
menu: number;
/**
* Sets the base index value for Tooltip.
* @defaultValue 1100
*/
tooltip: number;
/**
* Sets the base index value for Toast.
* @defaultValue 1200
*/
toast: number;
}
export type InputStyleType = 'outlined' | 'filled';
export type AppendToType = 'self' | HTMLElement | undefined | null | (() => HTMLElement);
export type StyleContainerType = ShadowRoot | HTMLElement | undefined | null;
/**
* Filter match modes for DataTable filter menus.
*/
export interface FilterMatchModeOptions {
/**
* Array of filter match modes for text filtering.
*/
text: any[];
/**
* Array of filter match modes for numeric filtering.
*/
numeric: any[];
/**
* Array of filter match modes for date filtering.
*/
date: any[];
}
/**
* Configuration options for the PrimeReact components.
*/
export interface APIOptions {
/**
* This option allows components with overlays like dropdowns or popups to be mounted into either the component or any DOM element, such as document body and self.
*/
appendTo?: AppendToType;
/**
* This option allows `useStyle` to insert dynamic CSS styles into a specific container. This is useful when styles need to be scoped such as in a Shadow DOM.
* @defaultValue document.head
*/
styleContainer?: StyleContainerType;
/**
* ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. When autoZIndex is false, each group increments its zIndex within itself.
*/
autoZIndex?: boolean;
/**
* PrimeReact components utilize "react-transition-group" internally to implement animations. Setting "cssTransition" to "false" disables all animations.
* @defaultValue true
*/
cssTransition?: boolean;
/**
* Default filter modes to display on DataTable filter menus.
*/
filterMatchModeOptions?: FilterMatchModeOptions;
/**
* Define behavior if the browser window is scrolled while displaying an overlay panel like a Dropdown or Calendar. Depending on your organization's accessibility needs some prefer panels to be closed on scrolling and some prefer the overlay follow the scroll.
* @defaultValue false
*/
hideOverlaysOnDocumentScrolling?: boolean;
/**
* Input fields have two styles: default (outlined with borders) and filled (background-colored). Applying 'p-input-filled' to an input's ancestor enables the filled style.
*/
inputStyle?: InputStyleType;
/**
* The locale configuration sets up the language and region specific preferences.
* @defaultValue 'en'
*/
locale?: string;
/**
* The nonce value to use on dynamically generated style elements.
*/
nonce?: string;
/**
* Determines how null values are sorted.
* @defaultValue 1
*/
nullSortOrder?: number;
/**
* Ripple is an optional animation for the supported components such as buttons.
* @defaultValue false
*/
ripple?: boolean;
/**
* ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. When autoZIndex is false, each group increments its zIndex within itself. Each property is optional, so when autoZIndex is enabled you can set the z-index for any component type, and the rest will be calculated automatically.
* @defaultValue { modal: 1100, overlay: 1000, menu: 1000, tooltip: 1100, toast: 1200}
*/
zIndex?: Partial<ZIndexOptions>;
/**
* This option allows to direct implementation of all relevant attributes (e.g., style, classnames) within the respective HTML tag.
*/
pt?: PrimeReactPTOptions;
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
/**
* When enabled, it removes all of components styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
/**
* This method is used to change the theme dynamically.
* @param {string} theme - The name of the theme to be applied.
* @param {string} newTheme - The name of the new theme to be applied.
* @param {string} linkElementId - The id of the link element to be updated.
* @param callback - Callback to invoke when the theme change is completed.
*/
changeTheme?(theme?: string, newTheme?: string, linkElementId?: string, callback?: () => void): void;
/**
* Sets the "appendTo" state of the context.
*/
setAppendTo?: Dispatch<SetStateAction<AppendToType>>;
/**
* Sets the "styleContainer" state of the context.
*/
setStyleContainer?: Dispatch<SetStateAction<StyleContainerType>>;
/**
* Sets the "autoZIndex" state of the context.
*/
setAutoZIndex?: Dispatch<SetStateAction<boolean>>;
/**
* Sets the "cssTransition" state of the context.
*/
setCssTransition?: Dispatch<SetStateAction<boolean>>;
/**
* Sets the "filterMatchModeOptions" state of the context.
*/
setFilterMatchModeOptions?: Dispatch<SetStateAction<FilterMatchModeOptions>>;
/**
* Sets the "hideOverlaysOnDocumentScrolling" state of the context.
*/
setHideOverlaysOnDocumentScrolling?: Dispatch<SetStateAction<boolean>>;
/**
* Sets the "inputStyle" state of the context.
*/
setInputStyle?: Dispatch<SetStateAction<InputStyleType>>;
/**
* Sets the "locale" state of the context.
*/
setLocale?: Dispatch<SetStateAction<string>>;
/**
* Sets the "nonce" state of the context.
*/
setNonce?: Dispatch<SetStateAction<string>>;
/**
* Sets the "nullSortOrder" state of the context.
*/
setNullSortOrder?: Dispatch<SetStateAction<number>>;
/**
* Sets the "ripple" state of the context.
*/
setRipple?: Dispatch<SetStateAction<boolean>>;
/**
* Sets the "zIndex" state of the context.
*/
setZIndex?: Dispatch<SetStateAction<ZIndexOptions>>;
/**
* Sets the "pt" state of the context.
*/
setPt?: Dispatch<SetStateAction<PrimeReactPTOptions>>;
}
/**
* This option allows to direct implementation of all relevant attributes (e.g., style, classnames) within the respective HTML tag globally for all components.
*/
export interface PrimeReactPTOptions {
/**
* Custom passthrough(pt) options for Accordion.
*/
accordion?: AccordionPassThroughOptions;
/**
* Custom passthrough(pt) options for AccordionTab.
*/
accordiontab?: AccordionTabPassThroughOptions;
/**
* Custom passthrough(pt) options for AutoComplete.
*/
autocomplete?: AutoCompletePassThroughOptions;
/**
* Custom passthrough(pt) options for Avatar.
*/
avatar?: AvatarPassThroughOptions;
/**
* Custom passthrough(pt) options for AvatarGroup.
*/
avatargroup?: AvatarGroupPassThroughOptions;
/**
* Custom passthrough(pt) options for Badge.
*/
badge?: BadgePassThroughOptions;
/**
* Custom passthrough(pt) options for BlockUI.
*/
blockui?: BlockUIPassThroughOptions;
/**
* Custom passthrough(pt) options for Breadcrumb.
*/
breadcrumb?: BreadCrumbPassThroughOptions;
/**
* Custom passthrough(pt) options for Button.
*/
button?: ButtonPassThroughOptions;
/**
* Custom passthrough(pt) options for Calendar.
*/
calendar?: CalendarPassThroughOptions;
/**
* Custom passthrough(pt) options for Card.
*/
card?: CardPassThroughOptions;
/**
* Custom passthrough(pt) options for Carousel.
*/
carousel?: CarouselPassThroughOptions;
/**
* Custom passthrough(pt) options for CascadeSelect.
*/
cascadeselect?: CascadeSelectPassThroughOptions;
/**
* Custom passthrough(pt) options for Chart.
*/
chart?: ChartPassThroughOptions;
/**
* Custom passthrough(pt) options for Checkbox.
*/
checkbox?: CheckboxPassThroughOptions;
/**
* Custom passthrough(pt) options for Chip.
*/
chip?: ChipPassThroughOptions;
/**
* Custom passthrough(pt) options for Chips.
*/
chips?: ChipsPassThroughOptions;
/**
* Custom passthrough(pt) options for ColorPicker.
*/
colorpicker?: ColorPickerPassThroughOptions;
/**
* Custom passthrough(pt) options for Column.
*/
column?: ColumnPassThroughOptions;
/**
* Custom passthrough(pt) options for ColumnGroup.
*/
columngroup?: ColumnGroupPassThroughOptions;
/**
* Custom passthrough(pt) options for ConfirmDialog.
*/
confirmdialog?: ConfirmDialogPassThroughOptions;
/**
* Custom passthrough(pt) options for ConfirmPopup.
*/
confirmpopup?: ConfirmPopupPassThroughOptions;
/**
* Custom passthrough(pt) options for ContextMenu.
*/
contextmenu?: ContextMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for DataTable.
*/
datatable?: DataTablePassThroughOptions;
/**
* Custom passthrough(pt) options for DataView.
*/
dataview?: DataViewPassThroughOptions;
/**
* Custom passthrough(pt) options for DataViewLayoutOptions.
*/
dataviewlayoutoptions?: DataViewLayoutOptionsPassThroughOptions;
/**
* Custom passthrough(pt) options for DeferredContent.
*/
deferredcontent?: DeferredContentPassThroughOptions;
/**
* Custom passthrough(pt) options for Dialog.
*/
dialog?: DialogPassThroughOptions;
/**
* Custom passthrough(pt) options for Divider.
*/
divider?: DividerPassThroughOptions;
/**
* Custom passthrough(pt) options for Dock.
*/
dock?: DockPassThroughOptions;
/**
* Custom passthrough(pt) options for Dropdown.
*/
dropdown?: DropdownPassThroughOptions;
/**
* Custom passthrough(pt) options for Editor.
*/
editor?: EditorPassThroughOptions;
/**
* Custom passthrough(pt) options for Fieldset.
*/
fieldset?: FieldsetPassThroughOptions;
/**
* Custom passthrough(pt) options for FileUpload.
*/
fileupload?: FileUploadPassThroughOptions;
/**
* Custom passthrough(pt) options for FullCalendar.
*/
galleria?: GalleriaPassThroughOptions;
/**
* Custom passthrough(pt) options for Galleria.
*/
image?: ImagePassThroughOptions;
/**
* Custom passthrough(pt) options for Inplace.
*/
inplace?: InplacePassThroughOptions;
/**
* Custom passthrough(pt) options for InputMask.
*/
inputmask?: InputTextPassThroughOptions;
/**
* Custom passthrough(pt) options for InputNumber.
*/
inputnumber?: InputNumberPassThroughOptions;
/**
* Custom passthrough(pt) options for InputSwitch.
*/
inputswitch?: InputSwitchPassThroughOptions;
/**
* Custom passthrough(pt) options for InputText.
*/
inputtext?: InputTextPassThroughOptions;
/**
* Custom passthrough(pt) options for InputTextarea.
*/
inputtextarea?: InputTextareaPassThroughOptions;
/**
* Custom passthrough(pt) options for Knob.
*/
knob?: KnobPassThroughOptions;
/**
* Custom passthrough(pt) options for Listbox.
*/
listbox?: ListboxPassThroughOptions;
/**
* Custom passthrough(pt) options for MegaMenu.
*/
megamenu?: MegaMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for Mention.
*/
mention?: MentionPassThroughOptions;
/**
* Custom passthrough(pt) options for Menu.
*/
menu?: MenuPassThroughOptions;
/**
* Custom passthrough(pt) options for Menubar.
*/
menubar?: MenubarPassThroughOptions;
/**
* Custom passthrough(pt) options for Message.
*/
message?: MessagePassThroughOptions;
/**
* Custom passthrough(pt) options for Messages.
*/
messages?: MessagesPassThroughOptions;
/**
* Custom passthrough(pt) options for MultiSelect.
*/
multiselect?: MultiSelectPassThroughOptions;
/**
* Custom passthrough(pt) options for MultiStateCheckbox.
*/
multistatecheckbox?: MultiStateCheckboxPassThroughOptions;
/**
* Custom passthrough(pt) options for OrderList.
*/
orderlist?: OrderListPassThroughOptions;
/**
* Custom passthrough(pt) options for OrganizationChart.
*/
organizationchart?: OrganizationChartPassThroughOptions;
/**
* Custom passthrough(pt) options for OverlayPanel.
*/
overlaypanel?: OverlayPanelPassThroughOptions;
/**
* Custom passthrough(pt) options for Paginator.
*/
paginator?: PaginatorPassThroughOptions;
/**
* Custom passthrough(pt) options for Panel.
*/
panel?: PanelPassThroughOptions;
/**
* Custom passthrough(pt) options for PanelMenu.
*/
panelmenu?: PanelMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for Password.
*/
password?: PasswordPassThroughOptions;
/**
* Custom passthrough(pt) options for PickList.
*/
picklist?: PickListPassThroughOptions;
/**
* Custom passthrough(pt) options for ProgressBar.
*/
progressbar?: ProgressBarPassThroughOptions;
/**
* Custom passthrough(pt) options for ProgressSpinner.
*/
progressspinner?: ProgressSpinnerPassThroughOptions;
/**
* Custom passthrough(pt) options for RadioButton.
*/
radiobutton?: RadioButtonPassThroughOptions;
/**
* Custom passthrough(pt) options for Rating.
*/
rating?: RatingPassThroughOptions;
/**
* Custom passthrough(pt) options for Row.
*/
row?: RowPassThroughOptions;
/**
* Custom passthrough(pt) options for ScrollPanel.
*/
scrollpanel?: ScrollPanelPassThroughOptions;
/**
* Custom passthrough(pt) options for ScrollTop.
*/
scrolltop?: ScrollTopPassThroughOptions;
/**
* Custom passthrough(pt) options for SelectButton.
*/
selectbutton?: SelectButtonPassThroughOptions;
/**
* Custom passthrough(pt) options for Sidebar.
*/
sidebar?: SidebarPassThroughOptions;
/**
* Custom passthrough(pt) options for Skeleton.
*/
skeleton?: SkeletonPassThroughOptions;
/**
* Custom passthrough(pt) options for SliderMenu.
*/
slidemenu?: SlideMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for Slider.
*/
slider?: SliderPassThroughOptions;
/**
* Custom passthrough(pt) options for SpeedDial.
*/
speeddial?: SpeedDialPassThroughOptions;
/**
* Custom passthrough(pt) options for SplitButton.
*/
splitbutton?: SplitButtonPassThroughOptions;
/**
* Custom passthrough(pt) options for Splitter.
*/
splitter?: SplitterPassThroughOptions;
/**
* Custom passthrough(pt) options for Steps.
*/
steps?: StepsPassThroughOptions;
/**
* Custom passthrough(pt) options for TabMenu.
*/
tabmenu?: TabMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for TabPanel.
*/
tabpanel?: TabPanelPassThroughOptions;
/**
* Custom passthrough(pt) options for TabView.
*/
tabview?: TabViewPassThroughOptions;
/**
* Custom passthrough(pt) options for Tag.
*/
tag?: TagPassThroughOptions;
/**
* Custom passthrough(pt) options for Terminal.
*/
terminal?: TerminalPassThroughOptions;
/**
* Custom passthrough(pt) options for TieredMenu.
*/
tieredmenu?: TieredMenuPassThroughOptions;
/**
* Custom passthrough(pt) options for Timeline.
*/
timeline?: TimelinePassThroughOptions;
/**
* Custom passthrough(pt) options for Toast.
*/
toast?: ToastPassThroughOptions;
/**
* Custom passthrough(pt) options for ToffleButton.
*/
togglebutton?: ToggleButtonPassThroughOptions;
/**
* Custom passthrough(pt) options for Toolbar.
*/
toolbar?: ToolbarPassThroughOptions;
/**
* Custom passthrough(pt) options for Tooltip.
*/
tooltip?: TooltipPassThroughOptions;
/**
* Custom passthrough(pt) options for Tree.
*/
tree?: TreePassThroughOptions;
/**
* Custom passthrough(pt) options for TreeSelect.
*/
treeselect?: TreeSelectPassThroughOptions;
/**
* Custom passthrough(pt) options for TreeTable.
*/
treetable?: TreeTablePassThroughOptions;
/**
* Custom passthrough(pt) options for VirtualScroller.
*/
virtualscroller?: VirtualScrollerPassThroughOptions;
/**
* Custom passthrough(pt) options for global css.
*/
global?: {
css?: (options: any) => string | string | undefined;
};
}
/**
* @deprecated since version 9.6.0. Use PrimeReactContext instead.
*/
declare const PrimeReact: APIOptions;
export default PrimeReact;
type PrimeReactProviderProps = {
/**
* Any default global API options
*/
value?: Partial<APIOptions>;
/**
* Used to get the child elements of the component.
* @readonly
*/
children: React.ReactNode;
};
declare const PrimeReactProvider: React.FC<PrimeReactProviderProps>;
declare const PrimeReactContext: React.Context<APIOptions>;
export { PrimeReactContext, PrimeReactProvider };
// Locale
/**
* Sets the current locale if installed.
* @param {string} locale - Locale string.
* @return {object} - Locale object.
*/
export declare function locale(locale: string): { locale: string; options: object };
/**
* Installs a new locale.
* @param {string} locale - Locale string.
* @param {LocaleOptions} options - Locale options. See [PrimeLocale](https://github.com/primefaces/primelocale) on GitHub for possible options.
*/
export declare function addLocale(locale: string, options: LocaleOptions): void;
/**
* Changes the specific option value of a locale.
* @param {string} key - Option key.
* @param {*} value - Option value.
* @param {string} locale - Locale string.
*/
export declare function updateLocaleOption(key: string, value: any, locale: string): void;
/**
* Changes the option values of a locale.
* @param {LocaleOptions} options - Locale options.
* @param {string} locale - Locale string.
*/
export declare function updateLocaleOptions(options: object, locale: string): void;
/**
* Return the value of a specific locale option.
* @param {string} key - Option key.
* @param {string} locale - Locale string.
*/
export declare function localeOption(key: string, locale: string): any;
/**
* Returns the values of locale options.
* @param {string} locale - Locale string.
*/
export declare function localeOptions(locale: string): object;
// Locale Options
export interface LocaleOptions {
/**
* Starts with
*/
startsWith?: string;
/**
* Contains
*/
contains?: string;
/**
* Not contains
*/
notContains?: string;
/**
* Ends with
*/
endsWith?: string;
/**
* Equals
*/
equals?: string;
/**
* Not equals
*/
notEquals?: string;
/**
* No Filter
*/
noFilter?: string;
/**
* Filter
*/
filter?: string;
/**
* Less than
*/
lt?: string;
/**
* Less than or equal to
*/
lte?: string;
/**
* Greater than
*/
gt?: string;
/**
* Greater than or equal to
*/
gte?: string;
/**
* Date is
*/
dateIs?: string;
/**
* Date is not
*/
dateIsNot?: string;
/**
* Date is before
*/
dateBefore?: string;
/**
* Date is after
*/
dateAfter?: string;
/**
* Custom
*/
custom?: string;
/**
* Clear
*/
clear?: string;
/**
* Apply
*/
apply?: string;
/**
* Match All
*/
matchAll?: string;
/**
* Match Any
*/
matchAny?: string;
/**
* Add Rule
*/
addRule?: string;
/**
* Remove Rule
*/
removeRule?: string;
/**
* Yes
*/
accept?: string;
/**
* No
*/
reject?: string;
/**
* Choose
*/
choose?: string;
/**
* Upload
*/
upload?: string;
/**
* Cancel
*/
cancel?: string;
/**
* Close
*/
close?: string;
/**
* Pending
*/
pending?: string;
/**
* ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
*/
fileSizeTypes?: string[];
/**
* ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
*/
dayNames?: string[];
/**
* ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
*/
dayNamesShort?: string[];
/**
* ['Su', 'Mo', 'Tu', 'We', 'Th', 'Fr', 'Sa']
*/
dayNamesMin?: string[];
/**
* ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
*/
monthNames?: string[];
/**
* ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
*/
monthNamesShort?: string[];
/**
* Choose Year
*/
chooseYear?: string;
/**
* Choose Month
*/
chooseMonth?: string;
/**
* Choose Date
*/
chooseDate?: string;
/**
* Previous Decade
*/
prevDecade?: string;
/**
* Next Decade
*/
nextDecade?: string;
/**
* Previous Year
*/
prevYear?: string;
/**
* Next Year
*/
nextYear?: string;
/**
* Previous Month
*/
prevMonth?: string;
/**
* Next Month
*/
nextMonth?: string;
/**
* Previous Hour
*/
prevHour?: string;
/**
* Next Hour
*/
nextHour?: string;
/**
* Previous Minute
*/
prevMinute?: string;
/**
* Next Minute
*/
nextMinute?: string;
/**
* Previous Second
*/
prevSecond?: string;
/**
* Next Second
*/
nextSecond?: string;
/**
* AM
*/
am?: string;
/**
* PM
*/
pm?: string;
/**
* Today (Calendar date only)
*/
today?: string;
/**
* Now (Calendar using time)
*/
now?: string;
/**
* Wk
*/
weekHeader?: string;
/**
* 0
*/
firstDayOfWeek?: number;
/**
* mm/dd/yy
*/
dateFormat?: string;
/**
* Weak
*/
weak?: string;
/**
* Medium
*/
medium?: string;
/**
* Strong
*/
strong?: string;
/**
* Enter a password
*/
passwordPrompt?: string;
/**
* No available options
*/
emptyFilterMessage?: string;
/**
* No results found
*/
emptyMessage?: string;
/**
* ARIA labels
*/
aria?: {
/**
* True
*/
trueLabel?: string;
/**
* False
*/
falseLabel?: string;
/**
* Not Selected
*/
nullLabel?: string;