primevue 3.16.2 → 3.17.0

package/web-types.json

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "framework": "vue",
   "name": "PrimeVue",
-  "version": "3.16.2",
+  "version": "3.17.0",
   "contributions": {
     "html": {
       "types-syntax": "typescript",
@@ -66,6 +66,26 @@
                 "kind": "expression",
                 "type": "string"
               }
+            },
+            {
+              "name": "tabindex",
+              "default": "0",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordion",
+              "description": "Index of the element in tabbing order.",
+              "value": {
+                "kind": "expression",
+                "type": "number"
+              }
+            },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordion",
+              "description": "When enabled, the focused tab is activated.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
             }
           ],
           "events": [
@@ -106,6 +126,25 @@
                   "description": "Closed tab index"
                 }
               ]
+            },
+            {
+              "name": "tab-click",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordion",
+              "description": "Callback to invoke when an active tab is clicked.",
+              "arguments": [
+                {
+                  "name": "originalEvent",
+                  "doc-url": "https://primefaces.org/primevue/showcase/#/accordion",
+                  "type": "object",
+                  "description": "Original event"
+                },
+                {
+                  "name": "index",
+                  "doc-url": "https://primefaces.org/primevue/showcase/#/accordion",
+                  "type": "number",
+                  "description": "Index of the clicked tab"
+                }
+              ]
             }
           ]
         },
@@ -128,6 +167,76 @@
                 "type": "string"
               }
             },
+            {
+              "name": "headerStyle",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Inline style of the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerClass",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Style class of the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Uses to pass all properties of the HTMLDivElement to the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerActionProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentStyle",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Inline style of the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentClass",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Style class of the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/accordiontab",
+              "description": "Uses to pass all properties of the HTMLDivElement to the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
             {
               "name": "disabled",
               "default": "false",
@@ -449,6 +558,16 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/autocomplete",
+              "description": "When enabled, the focused option is selected.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "searchLocale",
               "default": "undefined",
@@ -998,6 +1117,16 @@
                 "type": "string"
               }
             },
+            {
+              "name": "iconClass",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/button",
+              "description": "Style class of the icon.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
+            },
             {
               "name": "badge",
               "default": "null",
@@ -1874,6 +2003,26 @@
                 "kind": "expression",
                 "type": "string"
               }
+            },
+            {
+              "name": "showNavigators",
+              "default": "true",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/carousel",
+              "description": "Whether to display navigation buttons in container.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
+            {
+              "name": "showIndicators",
+              "default": "true",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/carousel",
+              "description": "Whether to display indicator container.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
             }
           ],
           "slots": [
@@ -2103,6 +2252,16 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/cascadeselect",
+              "description": "When enabled, the focused option is selected/opened.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "searchLocale",
               "default": "undefined",
@@ -3524,6 +3683,13 @@
                 "type": "object"
               }
             }
+          ],
+          "slots": [
+            {
+              "name": "message",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/confirmdialog",
+              "description": "Custom content for the component."
+            }
           ]
         },
         {
@@ -6194,6 +6360,16 @@
                 "type": "string"
               }
             },
+            {
+              "name": "resetFilterOnHide",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/dropdown",
+              "description": "Clears the filter value when hiding the dropdown.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "virtualScrollerOptions",
               "default": "null",
@@ -6214,6 +6390,26 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "autoFilterFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/dropdown",
+              "description": "Whether to focus on the filter element when the overlay panel is shown.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/dropdown",
+              "description": "When enabled, the focused option is selected.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "filterMessage",
               "default": "{0} results are available",
@@ -6504,6 +6700,16 @@
                 "kind": "expression",
                 "type": "any"
               }
+            },
+            {
+              "name": "modules",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/editor",
+              "description": "Modules configuration, see <a href=\"http://quilljs.com/docs/modules/\">here</a> for available options.",
+              "value": {
+                "kind": "expression",
+                "type": "object"
+              }
             }
           ],
           "events": [
@@ -6586,6 +6792,19 @@
                   "description": "Text editor instance."
                 }
               ]
+            },
+            {
+              "name": "load",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/editor",
+              "description": "Callback to invoke when the quill modules are loaded.",
+              "arguments": [
+                {
+                  "name": "event.instance",
+                  "doc-url": "https://primefaces.org/primevue/showcase/#/editor",
+                  "type": "any",
+                  "description": "Quill instance"
+                }
+              ]
             }
           ],
           "slots": [
@@ -6634,6 +6853,16 @@
                 "kind": "expression",
                 "type": "boolean"
               }
+            },
+            {
+              "name": "toggleButtonProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/fieldset",
+              "description": "Uses to pass the custom value to read for the anchor inside the component.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
             }
           ],
           "events": [
@@ -8476,6 +8705,16 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/listbox",
+              "description": "When enabled, the focused option is selected.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "filterMessage",
               "default": "{0} results are available",
@@ -9297,6 +9536,16 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "autoFilterFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/multiselect",
+              "description": "Whether to focus on the filter element when the overlay panel is shown.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "filterMessage",
               "default": "{0} results are available",
@@ -10082,6 +10331,16 @@
                 "kind": "expression",
                 "type": "boolean"
               }
+            },
+            {
+              "name": "toggleButtonProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/panel",
+              "description": "Uses to pass the custom value to read for the anchor inside the component.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
             }
           ],
           "events": [
@@ -10315,6 +10574,16 @@
                 "type": "string"
               }
             },
+            {
+              "name": "required",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/password",
+              "description": "When present, it specifies that an input field must be filled out before submitting the form.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
             {
               "name": "inputId",
               "default": "null",
@@ -11012,6 +11281,36 @@
                 "kind": "expression",
                 "type": "boolean"
               }
+            },
+            {
+              "name": "onIcon",
+              "default": "pi pi-star",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Icon for the on state.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
+            },
+            {
+              "name": "offIcon",
+              "default": "pi pi-star-fill",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Icon for the off state.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
+            },
+            {
+              "name": "cancelIcon",
+              "default": "pi pi-ban",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Icon for the cancelable state.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
             }
           ],
           "events": [
@@ -11033,6 +11332,49 @@
                   "description": "Selected option value"
                 }
               ]
+            },
+            {
+              "name": "focus",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Callback to invoke when component receives focus.",
+              "arguments": [
+                {
+                  "name": "event",
+                  "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+                  "type": "object",
+                  "description": "Browser event"
+                }
+              ]
+            },
+            {
+              "name": "blur",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Callback to invoke when component loses focus.",
+              "arguments": [
+                {
+                  "name": "event",
+                  "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+                  "type": "object",
+                  "description": "Browser event"
+                }
+              ]
+            }
+          ],
+          "slots": [
+            {
+              "name": "cancelicon",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Custom cancel icon template."
+            },
+            {
+              "name": "onicon",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Custom on icon template."
+            },
+            {
+              "name": "officon",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/rating",
+              "description": "Custom off icon template."
             }
           ]
         },
@@ -11061,7 +11403,19 @@
             "symbol": "ScrollPanel"
           },
           "doc-url": "https://primefaces.org/primevue/showcase/#/scrollpanel",
-          "description": "ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar."
+          "description": "ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.",
+          "attributes": [
+            {
+              "name": "step",
+              "default": "5",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/scrollpanel",
+              "description": "Step factor to scroll the content while pressing the arrow keys.",
+              "value": {
+                "kind": "expression",
+                "type": "number"
+              }
+            }
+          ]
         },
         {
           "name": "ScrollTop",
@@ -11987,6 +12341,16 @@
                 "kind": "expression",
                 "type": "string"
               }
+            },
+            {
+              "name": "step",
+              "default": "5",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/splitter",
+              "description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys.",
+              "value": {
+                "kind": "expression",
+                "type": "number"
+              }
             }
           ],
           "events": [
@@ -12197,6 +12561,76 @@
                 "type": "string"
               }
             },
+            {
+              "name": "headerStyle",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Inline style of the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerClass",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Style class of the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Uses to pass all properties of the HTMLLiElement to the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "headerActionProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentStyle",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Inline style of the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentClass",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Style class of the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "contentProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Uses to pass all properties of the HTMLDivElement to the tab content.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
             {
               "name": "disabled",
               "default": "null",
@@ -12287,6 +12721,46 @@
                 "kind": "expression",
                 "type": "boolean"
               }
+            },
+            {
+              "name": "tabindex",
+              "default": "0",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Index of the element in tabbing order.",
+              "value": {
+                "kind": "expression",
+                "type": "number"
+              }
+            },
+            {
+              "name": "selectOnFocus",
+              "default": "false",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "When enabled, the focused tab is activated.",
+              "value": {
+                "kind": "expression",
+                "type": "boolean"
+              }
+            },
+            {
+              "name": "previousButtonProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Uses to pass all properties of the HTMLButtonElement to the previous button.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
+            },
+            {
+              "name": "nextButtonProps",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/tabview",
+              "description": "Uses to pass all properties of the HTMLButtonElement to the next button.",
+              "value": {
+                "kind": "expression",
+                "type": "any"
+              }
             }
           ]
         },
@@ -12802,6 +13276,18 @@
           },
           "doc-url": "https://primefaces.org/primevue/showcase/#/toolbar",
           "description": "Toolbar is a grouping component for buttons and other content.",
+          "attributes": [
+            {
+              "name": "aria-labelledby",
+              "default": "null",
+              "doc-url": "https://primefaces.org/primevue/showcase/#/toolbar",
+              "description": "Defines a string value that labels an interactive element.",
+              "value": {
+                "kind": "expression",
+                "type": "string"
+              }
+            }
+          ],
           "slots": [
             {
               "name": "start",