primereact 8.0.1 → 8.2.0

package/web-types.json

@@ -1,7 +1,7 @@
 {
     "framework": "React",
     "name": "PrimeReact",
-    "version": "8.0.1",
+    "version": "8.2.0",
     "tags": [
         {
             "name": "Accordion",
@@ -814,7 +814,7 @@
                 },
                 {
                     "name": "model",
-                    "type": "array",
+                    "type": "MenuItem[]",
                     "default": "null",
                     "description": "An array of menuitems."
                 },
@@ -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",
@@ -1994,7 +2000,7 @@
                     "name": "readOnly",
                     "type": "boolean",
                     "default": "false",
-                    "description": "When present, it specifies that the element cannot be typed."
+                    "description": "When present, it specifies that the value cannot be changed."
                 },
                 {
                     "name": "tabIndex",
@@ -2248,6 +2254,12 @@
                     "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."
                 }
             ],
             "events": [
@@ -2315,6 +2327,17 @@
                             "description": "Browser event"
                         }
                     ]
+                },
+                {
+                    "name": "onKeyDown",
+                    "description": "Callback to invoke when the key pressed.",
+                    "arguments": [
+                        {
+                            "name": "originalEvent",
+                            "type": "object",
+                            "description": "Browser event"
+                        }
+                    ]
                 }
             ]
         },
@@ -2722,8 +2745,14 @@
                 {
                     "name": "reorderable",
                     "type": "boolean",
-                    "default": "null",
+                    "default": "true",
                     "description": "Used to defined reorderableColumns per column when reorderableColumns of table is enabled, defaults to value of reorderableColumns."
+                },
+                {
+                    "name": "resizeable",
+                    "type": "boolean",
+                    "default": "true",
+                    "description": "Used to defined resizeableColumns per column when resizeableColumns of table is enabled, defaults to value of resizeableColumns."
                 }
             ],
             "events": [
@@ -3694,13 +3723,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",
@@ -4633,6 +4662,18 @@
                     "default": "true",
                     "description": "Keeps dialog in the viewport."
                 },
+                {
+                    "name": "headerStyle",
+                    "type": "object",
+                    "default": "null",
+                    "description": "Style of the header section."
+                },
+                {
+                    "name": "headerClassName",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Style class of the header section."
+                },
                 {
                     "name": "contentStyle",
                     "type": "object",
@@ -5755,6 +5796,17 @@
                         }
                     ]
                 },
+                {
+                    "name": "onBeforeDrop",
+                    "description": "Callback to invoke before files dropped. Return false from callback to prevent drop.",
+                    "arguments": [
+                        {
+                            "name": "event.originalEvent",
+                            "type": "object",
+                            "description": "Original browser event."
+                        }
+                    ]
+                },
                 {
                     "name": "onUpload",
                     "description": "Callback to invoke when file upload is complete.",
@@ -7325,6 +7377,12 @@
                     "default": "undefined",
                     "description": "Locale to use in filtering. The default locale is the host environment's current locale."
                 },
+                {
+                    "name": "filterInputProps",
+                    "type": "object",
+                    "default": "undefined",
+                    "description": "Props for the filter input, any prop is passed implicity to the filter input element."
+                },
                 {
                     "name": "tabIndex",
                     "type": "number",
@@ -7423,6 +7481,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": []
@@ -8260,12 +8330,6 @@
                     "default": "null",
                     "description": "Unique identifier of the element."
                 },
-                {
-                    "name": "inputId",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Unique identifier of the native checkbox element."
-                },
                 {
                     "name": "value",
                     "type": "any",
@@ -8284,6 +8348,12 @@
                     "default": "null",
                     "description": "Property name to use as the value of an option, defaults to the option itself when not defined."
                 },
+                {
+                    "name": "optionLabel",
+                    "type": "string",
+                    "default": "null",
+                    "description": "Property name to refer to the option label, used by screen readers only. Defaults to optionValue."
+                },
                 {
                     "name": "iconTemplate",
                     "type": "any",
@@ -8291,10 +8361,10 @@
                     "description": "Template of icon for the selected option."
                 },
                 {
-                    "name": "name",
+                    "name": "dataKey",
                     "type": "string",
                     "default": "null",
-                    "description": "Name of the checkbox element ."
+                    "description": "A property to uniquely match the value in options for better performance."
                 },
                 {
                     "name": "style",
@@ -8318,7 +8388,7 @@
                     "name": "readOnly",
                     "type": "boolean",
                     "default": "false",
-                    "description": "When present, it specifies that the element value cannot be altered."
+                    "description": "When present, it specifies that the value cannot be changed."
                 },
                 {
                     "name": "empty",
@@ -8337,18 +8407,6 @@
                     "type": "object",
                     "default": "null",
                     "description": "Configuration of the tooltip, refer to the tooltip documentation for more information."
-                },
-                {
-                    "name": "ariaLabelledBy",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
-                },
-                {
-                    "name": "dataKey",
-                    "type": "string",
-                    "default": "null",
-                    "description": "A property to uniquely match the value in options for better performance."
                 }
             ],
             "events": [
@@ -9167,7 +9225,19 @@
                     "name": "itemTemplate",
                     "type": "function",
                     "default": "null",
-                    "description": "Function that gets the option and returns the content for it."
+                    "description": "Template function that gets the options for both source and target items and returns the content for it."
+                },
+                {
+                    "name": "sourceItemTemplate",
+                    "type": "function",
+                    "default": "null",
+                    "description": "Template function that gets the options for the source items and returns the content for it."
+                },
+                {
+                    "name": "targetItemTemplate",
+                    "type": "function",
+                    "default": "null",
+                    "description": "Template function that gets the options for the target items and returns the content for it."
                 },
                 {
                     "name": "metaKeySelection",
@@ -9175,6 +9245,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",
@@ -9305,6 +9441,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"
+                        }
+                    ]
                 }
             ]
         },
@@ -9508,12 +9676,6 @@
                     "type": "object",
                     "default": "null",
                     "description": "Configuration of the tooltip, refer to the tooltip documentation for more information."
-                },
-                {
-                    "name": "ariaLabelledBy",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
                 }
             ],
             "events": [
@@ -9833,12 +9995,6 @@
                     "default": "null",
                     "description": "Configuration of the tooltip, refer to the tooltip documentation for more information."
                 },
-                {
-                    "name": "ariaLabelledBy",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
-                },
                 {
                     "name": "itemTemplate",
                     "type": "function",
@@ -9950,7 +10106,7 @@
                     "name": "modal",
                     "type": "boolean",
                     "default": "true",
-                    "description": "Whether to a modal layer behind the sidebar."
+                    "description": "Whether to add a translucent overlay behind the sidebar."
                 },
                 {
                     "name": "appendTo",
@@ -10231,12 +10387,6 @@
                     "type": "number",
                     "default": "null",
                     "description": "Index of the element in tabbing order."
-                },
-                {
-                    "name": "ariaLabelledBy",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
                 }
             ],
             "events": [
@@ -10461,6 +10611,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",
@@ -10509,6 +10671,18 @@
                     "default": "null",
                     "description": "ClassName class of menu dropdown button."
                 },
+                {
+                    "name": "buttonProps",
+                    "type": "object",
+                    "default": "undefined",
+                    "description": "Props for the main button, any prop is passed implicity to the button element."
+                },
+                {
+                    "name": "menuButtonProps",
+                    "type": "object",
+                    "default": "undefined",
+                    "description": "Props for the dropdown button, any prop is passed implicity to the dropdown button element."
+                },
                 {
                     "name": "tabIndex",
                     "type": "number",
@@ -12663,7 +12837,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",
@@ -13043,24 +13217,12 @@
                     "default": "null",
                     "description": "Unique identifier of the element."
                 },
-                {
-                    "name": "inputId",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Unique identifier of the native checkbox element."
-                },
                 {
                     "name": "value",
                     "type": "any",
                     "default": "null",
                     "description": "Value of the TriStateCheckbox."
                 },
-                {
-                    "name": "name",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Name of the checkbox element ."
-                },
                 {
                     "name": "style",
                     "type": "string",
@@ -13079,6 +13241,18 @@
                     "default": "false",
                     "description": "When present, it specifies that the element value cannot be altered."
                 },
+                {
+                    "name": "readOnly",
+                    "type": "boolean",
+                    "default": "false",
+                    "description": "When present, it specifies that the value cannot be changed."
+                },
+                {
+                    "name": "tabIndex",
+                    "type": "number",
+                    "default": "0",
+                    "description": "Index of the element in tabbing order."
+                },
                 {
                     "name": "tooltip",
                     "type": "any",
@@ -13090,12 +13264,6 @@
                     "type": "object",
                     "default": "null",
                     "description": "Configuration of the tooltip, refer to the tooltip documentation for more information."
-                },
-                {
-                    "name": "ariaLabelledBy",
-                    "type": "string",
-                    "default": "null",
-                    "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
                 }
             ],
             "events": [
@@ -13186,6 +13354,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",
@@ -13198,12 +13372,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",