primereact 10.2.1 → 10.3.1

package/web-types.json

@@ -2,7 +2,7 @@
     "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
     "framework": "react",
     "name": "PrimeReact",
-    "version": "10.2.1",
+    "version": "10.3.1",
     "contributions": {
         "html": {
             "types-syntax": "typescript",
@@ -159,7 +159,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and \"self\". The \"self\" value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -2003,7 +2003,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and \"self\". The \"self\" value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -2631,12 +2631,12 @@
                         },
                         {
                             "name": "onRemove",
-                            "description": "Callback to invoke when a chip is removed.",
+                            "description": "Callback to invoke when a chip is removed.\n*",
                             "arguments": [
                                 {
                                     "name": "event",
-                                    "type": "MouseEvent<HTMLElement, MouseEvent>",
-                                    "description": "Browser event."
+                                    "type": "ChipRemoveEvent",
+                                    "description": "Custom remove event"
                                 }
                             ]
                         }
@@ -2945,7 +2945,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and \"self\". The \"self\" value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -4069,13 +4069,22 @@
                                 "type": "string"
                             }
                         },
+                        {
+                            "name": "defaultFocus",
+                            "default": "accept",
+                            "description": "Element to receive the focus when the dialog gets visible, valid values are \"accept\" and \"reject\".",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "appendTo",
                             "default": "document.body",
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and \"self\". The \"self\" value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -4428,6 +4437,15 @@
                                 "kind": "expression",
                                 "type": "CSSTransitionProps"
                             }
+                        },
+                        {
+                            "name": "content",
+                            "default": "null",
+                            "description": "Specifies a custom content for the dialog. For more complex markup, use the \"content\" slot instead.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "ReactNode | Function"
+                            }
                         }
                     ],
                     "events": [
@@ -4593,6 +4611,15 @@
                                 "type": "boolean"
                             }
                         },
+                        {
+                            "name": "defaultFocus",
+                            "default": "accept",
+                            "description": "Element to receive the focus when the dialog gets visible, valid values are \"accept\" and \"reject\".",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "message",
                             "default": "null",
@@ -4689,7 +4716,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -4763,6 +4790,15 @@
                                 "kind": "expression",
                                 "type": "boolean"
                             }
+                        },
+                        {
+                            "name": "content",
+                            "default": "null",
+                            "description": "Specifies a custom content for the dialog. For more complex markup, use the \"content\" slot instead.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "ReactNode | Function"
+                            }
                         }
                     ],
                     "events": [
@@ -4829,6 +4865,24 @@
                                 "type": "boolean"
                             }
                         },
+                        {
+                            "name": "ariaLabel",
+                            "default": "null",
+                            "description": "Used to define a string that labels the component.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "name": "ariaLabelledBy",
+                            "default": "null",
+                            "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "baseZIndex",
                             "default": "0",
@@ -4862,7 +4916,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -5278,7 +5332,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -5495,7 +5549,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -5857,6 +5911,15 @@
                                 "kind": "expression",
                                 "type": "boolean"
                             }
+                        },
+                        {
+                            "name": "content",
+                            "default": "null",
+                            "description": "Specifies a custom content for the dialog. For more complex markup, use the \"content\" slot instead.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "ReactNode | Function"
+                            }
                         }
                     ],
                     "events": [
@@ -6127,6 +6190,15 @@
                                 "type": "PassThroughOptions"
                             }
                         },
+                        {
+                            "name": "tabIndex",
+                            "default": "null",
+                            "description": "Index of the element in tabbing order.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "number"
+                            }
+                        },
                         {
                             "name": "unstyled",
                             "default": "false",
@@ -6137,7 +6209,30 @@
                             }
                         }
                     ],
-                    "events": []
+                    "events": [
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when dock receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when dock loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        }
+                    ]
                 },
                 {
                     "name": "Dropdown",
@@ -6154,7 +6249,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and \"self\". The \"self\" value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -10155,6 +10250,15 @@
                                 "type": "number"
                             }
                         },
+                        {
+                            "name": "roundingMode",
+                            "default": "halfExpand",
+                            "description": "How decimals should be rounded. [further information](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#roundingmode).",
+                            "value": {
+                                "kind": "expression",
+                                "type": "RoundingMode"
+                            }
+                        },
                         {
                             "name": "name",
                             "default": "null",
@@ -11496,6 +11600,15 @@
                                 "type": "IconType<MegaMenuProps>"
                             }
                         },
+                        {
+                            "name": "tabIndex",
+                            "default": "null",
+                            "description": "Index of the element in tabbing order.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "number"
+                            }
+                        },
                         {
                             "name": "end",
                             "default": "null",
@@ -11542,7 +11655,30 @@
                             }
                         }
                     ],
-                    "events": []
+                    "events": [
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        }
+                    ]
                 },
                 {
                     "name": "Mention",
@@ -11882,7 +12018,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -11894,6 +12030,15 @@
                                 "type": "CSSTransitionProps"
                             }
                         },
+                        {
+                            "name": "tabIndex",
+                            "default": "null",
+                            "description": "Index of the element in tabbing order.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "number"
+                            }
+                        },
                         {
                             "name": "children",
                             "default": "null",
@@ -11962,6 +12107,28 @@
                                     "description": "Browser event."
                                 }
                             ]
+                        },
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
                         }
                     ]
                 },
@@ -12010,6 +12177,24 @@
                                 "type": "IconType<MenubarProps>"
                             }
                         },
+                        {
+                            "name": "ariaLabel",
+                            "default": "null",
+                            "description": "Used to define a string that labels the component.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "name": "ariaLabelledBy",
+                            "default": "null",
+                            "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "end",
                             "default": "null",
@@ -12056,7 +12241,30 @@
                             }
                         }
                     ],
-                    "events": []
+                    "events": [
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        }
+                    ]
                 },
                 {
                     "name": "Menuitem",
@@ -12237,7 +12445,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -13127,6 +13335,24 @@
                                 "type": "boolean"
                             }
                         },
+                        {
+                            "name": "ariaLabel",
+                            "default": "null",
+                            "description": "Used to define a string that labels the component.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "name": "ariaLabelledBy",
+                            "default": "null",
+                            "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "dataKey",
                             "default": "null",
@@ -13282,6 +13508,28 @@
                         }
                     ],
                     "events": [
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
                         {
                             "name": "onChange",
                             "description": "Callback to invoke to when a mouse button is pressed.",
@@ -13486,7 +13734,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -13716,7 +13964,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -14024,7 +14272,30 @@
                             }
                         }
                     ],
-                    "events": []
+                    "events": [
+                        {
+                            "name": "onShow",
+                            "description": "Callback to invoke when a panel gets expanded.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "PanelMenuHeaderItemClickEvent",
+                                    "description": "custom event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onHide",
+                            "description": "Callback to invoke when a panel gets collapsed.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "PanelMenuHeaderItemClickEvent",
+                                    "description": "custom event."
+                                }
+                            ]
+                        }
+                    ]
                 },
                 {
                     "name": "Passthrough",
@@ -14183,7 +14454,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -14767,6 +15038,28 @@
                         }
                     ],
                     "events": [
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
                         {
                             "name": "onChange",
                             "description": "Callback to invoke when items are moved from source to target.",
@@ -16007,7 +16300,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and self. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -16054,6 +16347,15 @@
                                 "kind": "expression",
                                 "type": "boolean"
                             }
+                        },
+                        {
+                            "name": "content",
+                            "default": "null",
+                            "description": "Specifies a custom content for the sidebar. For more complex markup, use the \"content\" slot instead.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "ReactNode | Function"
+                            }
                         }
                     ],
                     "events": [
@@ -16186,7 +16488,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -16942,7 +17244,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -17791,7 +18093,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -17871,6 +18173,28 @@
                                     "description": "Browser event."
                                 }
                             ]
+                        },
+                        {
+                            "name": "onFocus",
+                            "description": "Callback to invoke when menu receives focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
+                        },
+                        {
+                            "name": "onBlur",
+                            "description": "Callback to invoke when menu loses focus.",
+                            "arguments": [
+                                {
+                                    "name": "event",
+                                    "type": "SyntheticEvent<Element, Event>",
+                                    "description": "Browser event."
+                                }
+                            ]
                         }
                     ]
                 },
@@ -18027,7 +18351,7 @@
                             "description": "DOM element instance where the component should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -18056,6 +18380,15 @@
                                 "kind": "expression",
                                 "type": "PassThroughOptions"
                             }
+                        },
+                        {
+                            "name": "content",
+                            "default": "null",
+                            "description": "Specifies a custom content for the toast. For more complex markup, use the \"content\" slot instead.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "ReactNode | Function"
+                            }
                         }
                     ],
                     "events": [
@@ -18409,7 +18742,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -18928,6 +19261,24 @@
                                 "type": "string"
                             }
                         },
+                        {
+                            "name": "ariaLabel",
+                            "default": "null",
+                            "description": "Defines a string value that labels an interactive element.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "name": "ariaLabelledby",
+                            "default": "null",
+                            "description": "Identifier of the underlying menu element.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
                         {
                             "name": "togglerTemplate",
                             "default": "null",
@@ -19142,7 +19493,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {
@@ -19487,6 +19838,24 @@
                                 "type": "\"multiple\" | \"checkbox\" | \"single\""
                             }
                         },
+                        {
+                            "name": "tooltip",
+                            "default": "null",
+                            "description": "Content of the tooltip.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "name": "tooltipOptions",
+                            "default": "null",
+                            "description": "Configuration of the tooltip, refer to the tooltip documentation for more information.",
+                            "value": {
+                                "kind": "expression",
+                                "type": "TooltipOptions"
+                            }
+                        },
                         {
                             "name": "transitionOptions",
                             "default": "null",
@@ -19692,7 +20061,7 @@
                             "description": "Defines whether the overall table width should change on column resize, valid values are \"fit\" and \"expand\".",
                             "value": {
                                 "kind": "expression",
-                                "type": "\"fit\" | \"expand\""
+                                "type": "\"expand\" | \"fit\""
                             }
                         },
                         {
@@ -19724,11 +20093,11 @@
                         },
                         {
                             "name": "emptyMessage",
-                            "default": "No records found",
+                            "default": "No results found",
                             "description": "Text to display when there is no data.",
                             "value": {
                                 "kind": "expression",
-                                "type": "string"
+                                "type": "ReactNode | Function"
                             }
                         },
                         {
@@ -19953,7 +20322,7 @@
                             "description": "DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.",
                             "value": {
                                 "kind": "expression",
-                                "type": "null | HTMLElement | \"self\""
+                                "type": "null | HTMLElement | \"self\" | Function"
                             }
                         },
                         {