primereact 9.5.0 → 9.6.0

package/api/api.d.ts

@@ -1,17 +1,128 @@
 /**
  *
- * @todo Write the documentation.
+ * API for PrimeReact components.
  *
  * @module api
  *
  */
+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 { PanelPassThroughOptions } from '../panel/panel';
+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 { 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 { DividerPassThroughOptions } from '../divider/divider';
+import { DockPassThroughOptions } from '../dock/dock';
+import { DialogPassThroughOptions } from '../dialog/dialog';
+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 { KnobPassThroughOptions } from '../knob/knob';
+import { ListboxPassThroughOptions } from '../listbox/listbox';
+import { MegaMenuPassThroughOptions } from '../megamenu/megamenu';
+import { MenuPassThroughOptions } from '../menu/menu';
+import { MenubarPassThroughOptions } from '../menubar/menubar';
+import { MessagePassThroughOptions } from '../message/message';
+import { MultiSelectPassThroughOptions } from '../multiselect/multiselect';
+import { OrderListPassThroughOptions } from '../orderlist/orderlist';
+import { OrganizationChartPassThroughOptions } from '../organizationchart/organizationchart';
+import { OverlayPanelPassThroughOptions } from '../overlaypanel/overlaypanel';
+import { PaginatorPassThroughOptions } from '../paginator/paginator';
+import { PanelMenuPassThroughOptions } from '../panelmenu/panelmenu';
+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 { 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 { SpeedDialPassThroughOptions } from '../speeddial/speeddial';
+import { SplitButtonPassThroughOptions } from '../splitbutton/splitbutton';
+import { SplitterPassThroughOptions } from '../splitter/splitter';
+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 { ToolbarPassThroughOptions } from '../toolbar/toolbar';
+import { TreePassThroughOptions } from '../tree/tree';
+import { TreeSelectPassThroughOptions } from '../treeselect/treeselect';
+import { TreeTablePassThroughOptions } from '../treetable/treetable';
+import { VirtualScrollerPassThroughOptions } from '../virtualscroller/virtualscroller';
+import { InputTextareaPassThroughOptions } from '../inputtextarea/inputtextarea';
+import { MessagesPassThroughOptions } from '../messages/messages';
+import { ColumnPassThroughOptions } from '../column/column';
+import { MentionPassThroughOptions } from '../mention/mention';
+import { MultiStateCheckboxPassThroughOptions } from '../multistatecheckbox/multistatecheckbox';
+import { RatingPassThroughOptions } from '../rating/rating';
+import { SlideMenuPassThroughOptions } from '../slidemenu/slidemenu';
+import { SliderPassThroughOptions } from '../slider/slider';
+import { StepsPassThroughOptions } from '../steps/steps';
+import { ToggleButtonPassThroughOptions } from '../togglebutton/togglebutton';
+import { TooltipPassThroughOptions } from '../tooltip/tooltip';
+import { Dispatch, SetStateAction } from 'react';
 
 // 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;
 }
 
@@ -19,39 +130,801 @@ export type InputStyleType = 'outlined' | 'filled';
 
 export type AppendToType = 'self' | 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;
+    /**
+     * 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;
-    hideOverlaysOnViewportChange?: boolean;
+    /**
+     * 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.
+     * @defaultValue { modal: 1100, overlay: 1000, menu: 1000, tooltip: 1100, toast: 1200}
+     */
     zIndex?: ZIndexOptions;
+    /**
+     * This option allows to direct implementation of all relevant attributes (e.g., style, classnames) within the respective HTML tag.
+     */
+    pt?: PrimeReactPTOptions;
+    /**
+     * 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 "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.
+     */
+    multisatecheckbox?: 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;
+}
+
+/**
+ * @deprecated since version 9.6.0. Use PrimeReactContext instead.
+ */
 declare const PrimeReact: APIOptions;
 
 export default PrimeReact;
 
+type PrimeReactProviderProps = {
+    /**
+     * 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 { PrimeReactProvider, PrimeReactContext };
+
 // 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 };
-export declare function addLocale(locale: string, options: object): void;
+/**
+ * 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;
+    /**
+     * ['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[];
+    /**
+     * Today
+     */
+    today?: 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;
+    /**
+     * True
+     */
+    aria?: {
+        /**
+         * True
+         */
+        trueLabel?: string;
+        /**
+         * False
+         */
+        falseLabel?: string;
+        /**
+         * Not Selected
+         */
+        nullLabel?: string;
+        /**
+         * Page
+         */
+        pageLabel?: string;
+        /**
+         * First Page
+         */
+        firstPageLabel?: string;
+        /**
+         * Last Page
+         */
+        lastPageLabel?: string;
+        /**
+         * Next Page
+         */
+        nextPageLabel?: string;
+        /**
+         * Previous Page
+         */
+        previousPageLabel?: string;
+        /**
+         * Select
+         */
+        selectLabel?: string;
+        /**
+         * Unselect
+         */
+        unselectLabel?: string;
+        /**
+         * Expand
+         */
+        expandLabel?: string;
+        /**
+         * Collapse
+         */
+        collapseLabel?: string;
+    };
+}
+
 // Icons
 export interface PrimeIconsOptions {
     readonly ALIGN_CENTER: string;