primereact 8.1.1 → 8.4.0

package/web-types.json

@@ -1,7 +1,7 @@
 {
     "framework": "React",
     "name": "PrimeReact",
-    "version": "8.1.1",
+    "version": "8.4.0",
     "tags": [
         {
             "name": "Accordion",
@@ -1196,6 +1196,12 @@
                     "default": "null",
                     "description": "Maximum number of selectable dates in multiple mode."
                 },
+                {
+                    "name": "showMinMaxRange",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "Whether to allow navigation past min/max dates."
+                },
                 {
                     "name": "showOtherMonths",
                     "type": "boolean",
@@ -2248,6 +2254,18 @@
                     "type": "function",
                     "default": "null",
                     "description": "Template function to return the content of a chip."
+                },
+                {
+                    "name": "keyfilter",
+                    "type": "string/regex",
+                    "default": "null",
+                    "description": "Format definition of the keys to block."
+                },
+                {
+                    "name": "addOnBlur",
+                    "type": "boolean",
+                    "default": "null",
+                    "description": "Whether to add an item when the input loses focus."
                 }
             ],
             "events": [
@@ -2315,6 +2333,17 @@
                             "description": "Browser event"
                         }
                     ]
+                },
+                {
+                    "name": "onKeyDown",
+                    "description": "Callback to invoke when the key pressed.",
+                    "arguments": [
+                        {
+                            "name": "originalEvent",
+                            "type": "object",
+                            "description": "Browser event"
+                        }
+                    ]
                 }
             ]
         },
@@ -3606,6 +3635,12 @@
                     "default": "false",
                     "description": "When enabled, columns can be reordered using drag and drop."
                 },
+                {
+                    "name": "reorderableRows",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "When enabled, rows can be reordered using drag and drop."
+                },
                 {
                     "name": "filters",
                     "type": "array",
@@ -3700,13 +3735,13 @@
                     "name": "rowClassName",
                     "type": "function",
                     "default": "null",
-                    "description": "Function that takes the row data and <br/> returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a classname for a particular now."
+                    "description": "Function that takes the row data and <br/> returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a class name for a particular row."
                 },
                 {
                     "name": "cellClassName",
                     "type": "function",
                     "default": "null",
-                    "description": "Function that takes the cell data and <br/> returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a classname for a particular now."
+                    "description": "Function that takes the cell data and <br/> returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a class name for a particular cell."
                 },
                 {
                     "name": "rowGroupHeaderTemplate",
@@ -5047,6 +5082,12 @@
                     "default": "null",
                     "description": "The template of items."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of filter element."
+                },
                 {
                     "name": "optionGroupTemplate",
                     "type": "any",
@@ -5318,6 +5359,22 @@
                             "description": "Browser event"
                         }
                     ]
+                },
+                {
+                    "name": "onFilter",
+                    "description": "Callback to invoke when the value is filtered.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Original event"
+                        },
+                        {
+                            "name": "event.filter",
+                            "type": "any",
+                            "description": "Value of the filter input"
+                        }
+                    ]
                 }
             ]
         },
@@ -5784,6 +5841,22 @@
                         }
                     ]
                 },
+                {
+                    "name": "onBeforeSelect",
+                    "description": "Callback to invoke before files are selected. Return false from callback to prevent selection.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Original browser event."
+                        },
+                        {
+                            "name": "event.target.files",
+                            "type": "any",
+                            "description": "List of selected files."
+                        }
+                    ]
+                },
                 {
                     "name": "onUpload",
                     "description": "Callback to invoke when file upload is complete.",
@@ -6303,6 +6376,17 @@
                     "name": "onHide",
                     "description": "Triggered when the preview overlay is hidden.",
                     "arguments": []
+                },
+                {
+                    "name": "onError",
+                    "description": "Triggered when image has an error loading.",
+                    "arguments": [
+                        {
+                            "name": "event",
+                            "type": "object",
+                            "description": "Browser event"
+                        }
+                    ]
                 }
             ]
         },
@@ -7264,6 +7348,12 @@
                     "default": "null",
                     "description": "Custom template for the items."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "Custom template for the filter element."
+                },
                 {
                     "name": "optionGroupTemplate",
                     "type": "any",
@@ -7458,6 +7548,18 @@
                     "type": "string",
                     "default": "horizontal",
                     "description": "Defines the orientation, valid values are horizontal and vertical."
+                },
+                {
+                    "name": "start",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of starting element."
+                },
+                {
+                    "name": "end",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of trailing element"
                 }
             ],
             "events": []
@@ -8108,6 +8210,12 @@
                     "default": "null",
                     "description": "Function that gets the option and returns the content for it."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of filter element."
+                },
                 {
                     "name": "optionGroupTemplate",
                     "type": "any",
@@ -8462,6 +8570,42 @@
                     "default": "null",
                     "description": "Function that gets an item in the list and returns the content for it."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of filter element."
+                },
+                {
+                    "name": "filter",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "When specified, displays an input field to filter the items on keyup."
+                },
+                {
+                    "name": "filterBy",
+                    "type": "string",
+                    "default": "label",
+                    "description": "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against."
+                },
+                {
+                    "name": "filterMatchMode",
+                    "type": "string",
+                    "default": "contains",
+                    "description": "Defines how the items are filtered, valid values are \"contains\" (default), \"startsWith\", \"endsWith\", \"equals\" and \"notEquals\"."
+                },
+                {
+                    "name": "filterPlaceholder",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Placeholder text to show when filter input is empty."
+                },
+                {
+                    "name": "filterLocale",
+                    "type": "string",
+                    "default": "undefined",
+                    "description": "Locale to use in filtering. The default locale is the host environment's current locale."
+                },
                 {
                     "name": "tabIndex",
                     "type": "number",
@@ -8485,6 +8629,22 @@
                             "description": "Reordered list"
                         }
                     ]
+                },
+                {
+                    "name": "onFilter",
+                    "description": "Callback to invoke when the value is filtered.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Original event"
+                        },
+                        {
+                            "name": "event.filter",
+                            "type": "any",
+                            "description": "Value of the filter input"
+                        }
+                    ]
                 }
             ]
         },
@@ -9210,6 +9370,72 @@
                     "default": "true",
                     "description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically."
                 },
+                {
+                    "name": "filterBy",
+                    "type": "string",
+                    "default": "null",
+                    "description": "When specified displays an input field to filter the items on keyup and decides which field to search (Accepts multiple fields with a comma)."
+                },
+                {
+                    "name": "filterMatchMode",
+                    "type": "string",
+                    "default": "contains",
+                    "description": "Defines how the items are filtered, valid values are \"contains\" (default) \"startsWith\", \"endsWith\", \"equals\", \"notEquals\", \"in\", \"lt\", \"lte\", \"gt\" and \"gte\"."
+                },
+                {
+                    "name": "filterLocale",
+                    "type": "string",
+                    "default": "undefined",
+                    "description": "Locale to use in filtering. The default locale is the host environment's current locale."
+                },
+                {
+                    "name": "sourceFilterValue",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Filter value in the target list."
+                },
+                {
+                    "name": "targetFilterValue",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Filter value in the source list."
+                },
+                {
+                    "name": "showSourceFilter",
+                    "type": "boolean",
+                    "default": "true",
+                    "description": "Whether to show filter input for source list when filterBy is enabled."
+                },
+                {
+                    "name": "showTargetFilter",
+                    "type": "boolean",
+                    "default": "true",
+                    "description": "Whether to show filter input for target list when filterBy is enabled."
+                },
+                {
+                    "name": "sourceFilterPlaceholder",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Placeholder text on source filter input."
+                },
+                {
+                    "name": "targetFilterPlaceholder",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Placeholder text on target filter input."
+                },
+                {
+                    "name": "sourceFilterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "Template for the source filter content."
+                },
+                {
+                    "name": "targetFilterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "Template for the target filter content."
+                },
                 {
                     "name": "tabIndex",
                     "type": "number",
@@ -9340,6 +9566,38 @@
                             "description": "Selected items array"
                         }
                     ]
+                },
+                {
+                    "name": "onSourceFilterChange",
+                    "description": "Callback to invoke when items are filtered within source list.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Browser event"
+                        },
+                        {
+                            "name": "event.value",
+                            "type": "any",
+                            "description": "Filtered value"
+                        }
+                    ]
+                },
+                {
+                    "name": "onTargetFilterChange",
+                    "description": "Callback to invoke when items are filtered within target list.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Browser event"
+                        },
+                        {
+                            "name": "event.value",
+                            "type": "any",
+                            "description": "Filtered value"
+                        }
+                    ]
                 }
             ]
         },
@@ -10478,6 +10736,18 @@
                     "default": "null",
                     "description": "Name of the icon."
                 },
+                {
+                    "name": "loadingIcon",
+                    "type": "any",
+                    "default": "null",
+                    "description": "Name of the loading icon or JSX.Element for loading icon."
+                },
+                {
+                    "name": "loading",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "Display loading icon of the button"
+                },
                 {
                     "name": "model",
                     "type": "object",
@@ -11890,6 +12160,12 @@
                     "default": "null",
                     "description": "Template of toggler element."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "Template of filter element."
+                },
                 {
                     "name": "showHeader",
                     "type": "boolean",
@@ -12281,6 +12557,12 @@
                     "default": "null",
                     "description": "The template of footer."
                 },
+                {
+                    "name": "filterTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of filter element"
+                },
                 {
                     "name": "transitionOptions",
                     "type": "object",
@@ -12692,7 +12974,7 @@
                     "name": "rowClassName",
                     "type": "function",
                     "default": "null",
-                    "description": "Function that takes the row data and returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a classname for a particular now."
+                    "description": "Function that takes the row data and returns an object in \"&#123;'styleclass' : condition&#125;\" format to define a class name for a particular row."
                 },
                 {
                     "name": "loading",
@@ -13209,6 +13491,12 @@
                     "default": "0",
                     "description": "Delay in scroll before new data is loaded."
                 },
+                {
+                    "name": "resizeDelay",
+                    "type": "number",
+                    "default": "10",
+                    "description": "Delay after window's resize finishes."
+                },
                 {
                     "name": "lazy",
                     "type": "boolean",
@@ -13221,12 +13509,24 @@
                     "default": "false",
                     "description": "Whether to show loader."
                 },
+                {
+                    "name": "autoSize",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "Whether to dynamically change the height or width of scrollable container."
+                },
                 {
                     "name": "loadingTemplate",
                     "type": "any",
                     "default": "null",
                     "description": "The template of loader."
                 },
+                {
+                    "name": "loaderIconTemplate",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of loader's icon."
+                },
                 {
                     "name": "itemTemplate",
                     "type": "any",