vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Merge branch 'master' of https://github.com/primefaces/primevue

pull/7382/head
Cagatay Civici 2025-03-07 00:19:51 +03:00
parent afae0033d9 900a653500
commit bcd46a36bf
50 changed files with 268 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

212
apps/showcase/doc/common/apidoc/index.json
View File

@ -3806,7 +3806,7 @@
"name": "dropdownMode", "name": "dropdownMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"blank\" | \"current\"", "type": "HintedString<\"blank\" | \"current\">",
"default": "blank", "default": "blank",
"description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value." "description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value."
}, },
@ -3838,7 +3838,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -3862,7 +3862,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -4909,7 +4909,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"large\" | \"normal\" | \"xlarge\"", "type": "HintedString<\"large\" | \"normal\" | \"xlarge\">",
"default": "normal", "default": "normal",
"description": "Size of the element." "description": "Size of the element."
}, },
@ -4917,7 +4917,7 @@
"name": "shape", "name": "shape",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"square\" | \"circle\"", "type": "HintedString<\"square\" | \"circle\">",
"default": "square", "default": "square",
"description": "Shape of the element." "description": "Shape of the element."
}, },
@ -5463,7 +5463,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"small\" | \"large\" | \"xlarge\"", "type": "null | HintedString<\"small\" | \"large\" | \"xlarge\">",
"default": "", "default": "",
"description": "Size of the badge, valid options are 'small', 'large', and 'xlarge'." "description": "Size of the badge, valid options are 'small', 'large', and 'xlarge'."
}, },
@ -10846,7 +10846,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -10870,7 +10870,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -12205,7 +12205,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -13731,7 +13731,7 @@
"name": "format", "name": "format",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"hex\" | \"rgb\" | \"hsb\"", "type": "HintedString<\"hex\" | \"rgb\" | \"hsb\">",
"default": "hex", "default": "hex",
"description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'." "description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'."
}, },
@ -14925,7 +14925,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\"", "type": "HintedString<\"single\" | \"multiple\">",
"default": "", "default": "",
"description": "Defines column based selection mode." "description": "Defines column based selection mode."
}, },
@ -14997,7 +14997,7 @@
"name": "alignFrozen", "name": "alignFrozen",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\"", "type": "HintedString<\"left\" | \"right\">",
"default": "left", "default": "left",
"description": "Position of a frozen column, valid values are left and right." "description": "Position of a frozen column, valid values are left and right."
}, },
@ -15686,7 +15686,7 @@
"name": "type", "name": "type",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"header\" | \"footer\"", "type": "HintedString<\"header\" | \"footer\">",
"default": "", "default": "",
"description": "Type of column group" "description": "Type of column group"
}, },
@ -16876,7 +16876,7 @@
"name": "position", "name": "position",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\">",
"default": "center", "default": "center",
"description": "Position of the dialog." "description": "Position of the dialog."
}, },
@ -20684,7 +20684,7 @@
"name": "paginatorPosition", "name": "paginatorPosition",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"top\" | \"bottom\" | \"both\"", "type": "HintedString<\"top\" | \"bottom\" | \"both\">",
"default": "bottom", "default": "bottom",
"description": "Position of the paginator, options are 'top','bottom' or 'both'." "description": "Position of the paginator, options are 'top','bottom' or 'both'."
}, },
@ -20796,7 +20796,7 @@
"name": "sortMode", "name": "sortMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\"", "type": "HintedString<\"single\" | \"multiple\">",
"default": "single", "default": "single",
"description": "Defines whether sorting works on single column or on multiple columns." "description": "Defines whether sorting works on single column or on multiple columns."
}, },
@ -20820,7 +20820,7 @@
"name": "filterDisplay", "name": "filterDisplay",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"menu\" | \"row\"", "type": "HintedString<\"menu\" | \"row\">",
"default": "", "default": "",
"description": "Layout of the filter elements." "description": "Layout of the filter elements."
}, },
@ -20852,7 +20852,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\"", "type": "HintedString<\"single\" | \"multiple\">",
"default": "", "default": "",
"description": "Specifies the selection mode." "description": "Specifies the selection mode."
}, },
@ -20860,7 +20860,7 @@
"name": "compareSelectionBy", "name": "compareSelectionBy",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"equals\" | \"deepEquals\"", "type": "HintedString<\"equals\" | \"deepEquals\">",
"default": "deepEquals", "default": "deepEquals",
"description": "Algorithm to define if a row is selected." "description": "Algorithm to define if a row is selected."
}, },
@ -20939,7 +20939,7 @@
"name": "columnResizeMode", "name": "columnResizeMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"fit\" | \"expand\"", "type": "HintedString<\"fit\" | \"expand\">",
"default": "fit", "default": "fit",
"description": "Defines whether the overall table width." "description": "Defines whether the overall table width."
}, },
@ -20979,7 +20979,7 @@
"name": "rowGroupMode", "name": "rowGroupMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"subheader\" | \"rowspan\"", "type": "HintedString<\"subheader\" | \"rowspan\">",
"default": "", "default": "",
"description": "Defines the row group mode." "description": "Defines the row group mode."
}, },
@ -21011,7 +21011,7 @@
"name": "stateStorage", "name": "stateStorage",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"session\" | \"local\"", "type": "HintedString<\"session\" | \"local\">",
"default": "session", "default": "session",
"description": "Defines where a stateful table keeps its state." "description": "Defines where a stateful table keeps its state."
}, },
@ -21027,7 +21027,7 @@
"name": "editMode", "name": "editMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"row\" | \"cell\"", "type": "HintedString<\"row\" | \"cell\">",
"default": "", "default": "",
"description": "Defines the incell editing mode." "description": "Defines the incell editing mode."
}, },
@ -21129,7 +21129,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the table." "description": "Defines the size of the table."
}, },
@ -22774,7 +22774,7 @@
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"list\" | \"grid\"", "type": "HintedString<\"list\" | \"grid\">",
"default": "list", "default": "list",
"description": "Layout of the items, valid values are 'list' and 'grid'." "description": "Layout of the items, valid values are 'list' and 'grid'."
}, },
@ -22814,7 +22814,7 @@
"name": "paginatorPosition", "name": "paginatorPosition",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"top\" | \"bottom\" | \"both\"", "type": "HintedString<\"top\" | \"bottom\" | \"both\">",
"default": "bottom", "default": "bottom",
"description": "Position of the paginator, options are 'top','bottom' or 'both'." "description": "Position of the paginator, options are 'top','bottom' or 'both'."
}, },
@ -24107,7 +24107,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\" | \"range\"", "type": "HintedString<\"single\" | \"multiple\" | \"range\">",
"default": "single", "default": "single",
"description": "Defines the quantity of the selection." "description": "Defines the quantity of the selection."
}, },
@ -24155,7 +24155,7 @@
"name": "iconDisplay", "name": "iconDisplay",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"button\" | \"input\"", "type": "HintedString<\"button\" | \"input\">",
"default": "'button'", "default": "'button'",
"description": "Icon position of the component. This only applies if the showIcon option is set to true." "description": "Icon position of the component. This only applies if the showIcon option is set to true."
}, },
@ -24227,7 +24227,7 @@
"name": "view", "name": "view",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"date\" | \"month\" | \"year\"", "type": "HintedString<\"date\" | \"month\" | \"year\">",
"default": "date", "default": "date",
"description": "Type of view to display." "description": "Type of view to display."
}, },
@ -24331,7 +24331,7 @@
"name": "hourFormat", "name": "hourFormat",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"12\" | \"24\"", "type": "HintedString<\"12\" | \"24\">",
"default": "24", "default": "24",
"description": "Specifies hour format." "description": "Specifies hour format."
}, },
@ -24411,7 +24411,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -24435,7 +24435,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -25969,7 +25969,7 @@
"name": "position", "name": "position",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\">",
"default": "center", "default": "center",
"description": "Position of the dialog." "description": "Position of the dialog."
}, },
@ -26572,7 +26572,7 @@
"name": "align", "name": "align",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\" | \"center\">",
"default": "", "default": "",
"description": "Alignment of the content." "description": "Alignment of the content."
}, },
@ -26580,7 +26580,7 @@
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\"", "type": "HintedString<\"horizontal\" | \"vertical\">",
"default": "horizontal", "default": "horizontal",
"description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'." "description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'."
}, },
@ -26588,7 +26588,7 @@
"name": "type", "name": "type",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"solid\" | \"dashed\" | \"dotted\"", "type": "HintedString<\"solid\" | \"dashed\" | \"dotted\">",
"default": "solid", "default": "solid",
"description": "Border style type." "description": "Border style type."
}, },
@ -26976,7 +26976,7 @@
"name": "event", "name": "event",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "undefined | \"focus\" | \"hover\"", "type": "undefined | HintedString<\"focus\" | \"hover\">",
"default": "", "default": "",
"description": "Event to show the tooltip, valid values are hover and focus." "description": "Event to show the tooltip, valid values are hover and focus."
}, },
@ -26984,7 +26984,7 @@
"name": "position", "name": "position",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "undefined | \"left\" | \"right\" | \"top\" | \"bottom\"", "type": "undefined | HintedString<\"left\" | \"right\" | \"top\" | \"bottom\">",
"default": "bottom", "default": "bottom",
"description": "Position of element." "description": "Position of element."
}, },
@ -27036,7 +27036,7 @@
"name": "position", "name": "position",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\">",
"default": "bottom", "default": "bottom",
"description": "Position of element." "description": "Position of element."
}, },
@ -27578,7 +27578,7 @@
"name": "position", "name": "position",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\" | \"full\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\" | \"full\">",
"default": "left", "default": "left",
"description": "Specifies the position of the drawer." "description": "Specifies the position of the drawer."
}, },
@ -30056,7 +30056,7 @@
"name": "mode", "name": "mode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"advanced\" | \"basic\"", "type": "HintedString<\"advanced\" | \"basic\">",
"default": "advanced", "default": "advanced",
"description": "Defines the UI of the component, possible values are 'advanced' and 'basic'." "description": "Defines the UI of the component, possible values are 'advanced' and 'basic'."
}, },
@ -30882,7 +30882,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"on\" | \"in\" | \"over\"", "type": "HintedString<\"on\" | \"in\" | \"over\">",
"default": "false", "default": "false",
"description": "Defines the positioning of the label relative to the input." "description": "Defines the positioning of the label relative to the input."
} }
@ -32055,7 +32055,7 @@
"name": "thumbnailsPosition", "name": "thumbnailsPosition",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\">",
"default": "bottom", "default": "bottom",
"description": "Position of thumbnails." "description": "Position of thumbnails."
}, },
@ -32087,7 +32087,7 @@
"name": "indicatorsPosition", "name": "indicatorsPosition",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\">",
"default": "bottom", "default": "bottom",
"description": "Position of indicators." "description": "Position of indicators."
}, },
@ -35165,7 +35165,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"outlined\" | \"filled\"", "type": "HintedString<\"outlined\" | \"filled\">",
"default": "outlined", "default": "outlined",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -36434,7 +36434,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -36442,7 +36442,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -37032,7 +37032,7 @@
"name": "buttonLayout", "name": "buttonLayout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\" | \"stacked\"", "type": "HintedString<\"horizontal\" | \"vertical\" | \"stacked\">",
"default": "stacked", "default": "stacked",
"description": "Layout of the buttons." "description": "Layout of the buttons."
}, },
@ -37098,7 +37098,7 @@
"name": "localeMatcher", "name": "localeMatcher",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"lookup\" | \"best fit\"", "type": "HintedString<\"lookup\" | \"best fit\">",
"default": "best fit", "default": "best fit",
"description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details." "description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details."
}, },
@ -37106,7 +37106,7 @@
"name": "mode", "name": "mode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"decimal\" | \"currency\"", "type": "HintedString<\"decimal\" | \"currency\">",
"default": "decimal", "default": "decimal",
"description": "Defines the behavior of the component." "description": "Defines the behavior of the component."
}, },
@ -37218,7 +37218,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -37242,7 +37242,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -37890,7 +37890,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -37922,7 +37922,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -39969,7 +39969,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"small\" | \"large\"", "type": "null | HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -39985,7 +39985,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -42591,7 +42591,7 @@
"name": "orientation", "name": "orientation",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\"", "type": "HintedString<\"horizontal\" | \"vertical\">",
"default": "horizontal", "default": "horizontal",
"description": "Defines the orientation." "description": "Defines the orientation."
}, },
@ -44934,7 +44934,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -44942,7 +44942,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"outlined\" | \"simple\"", "type": "HintedString<\"outlined\" | \"simple\">",
"default": "undefined", "default": "undefined",
"description": "Specifies the variant of the component." "description": "Specifies the variant of the component."
} }
@ -46298,7 +46298,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -46322,7 +46322,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -46460,7 +46460,7 @@
"name": "display", "name": "display",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"comma\" | \"chip\"", "type": "HintedString<\"comma\" | \"chip\">",
"default": "comma", "default": "comma",
"description": "Defines how the selected items are displayed." "description": "Defines how the selected items are displayed."
}, },
@ -48450,7 +48450,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\"", "type": "HintedString<\"single\" | \"multiple\">",
"default": "", "default": "",
"description": "Type of the selection." "description": "Type of the selection."
}, },
@ -48946,7 +48946,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"small\" | \"large\" | \"xlarge\"", "type": "null | HintedString<\"small\" | \"large\" | \"xlarge\">",
"default": "", "default": "",
"description": "Size of the badge, valid options are 'small', 'large', and 'xlarge'." "description": "Size of the badge, valid options are 'small', 'large', and 'xlarge'."
}, },
@ -53520,7 +53520,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -53544,7 +53544,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -56506,7 +56506,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -56530,7 +56530,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -58675,7 +58675,7 @@
"name": "target", "name": "target",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"window\" | \"parent\"", "type": "HintedString<\"window\" | \"parent\">",
"default": "window", "default": "window",
"description": "Target of the ScrollTop." "description": "Target of the ScrollTop."
}, },
@ -59497,7 +59497,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -59521,7 +59521,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -60685,7 +60685,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -61178,7 +61178,7 @@
"name": "shape", "name": "shape",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"circle\" | \"rectangle\"", "type": "HintedString<\"circle\" | \"rectangle\">",
"default": "rectangle", "default": "rectangle",
"description": "Shape of the element." "description": "Shape of the element."
}, },
@ -61218,7 +61218,7 @@
"name": "animation", "name": "animation",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"none\" | \"wave\"", "type": "HintedString<\"none\" | \"wave\">",
"default": "wave", "default": "wave",
"description": "Type of the animation." "description": "Type of the animation."
}, },
@ -61555,7 +61555,7 @@
"name": "orientation", "name": "orientation",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\"", "type": "HintedString<\"horizontal\" | \"vertical\">",
"default": "horizontal", "default": "horizontal",
"description": "Orientation of the slider." "description": "Orientation of the slider."
}, },
@ -62089,7 +62089,7 @@
"name": "event", "name": "event",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "undefined | \"focus\" | \"hover\"", "type": "undefined | HintedString<\"focus\" | \"hover\">",
"default": "", "default": "",
"description": "Event to show the tooltip, valid values are hover and focus." "description": "Event to show the tooltip, valid values are hover and focus."
}, },
@ -62097,7 +62097,7 @@
"name": "position", "name": "position",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "undefined | \"left\" | \"right\" | \"top\" | \"bottom\"", "type": "undefined | HintedString<\"left\" | \"right\" | \"top\" | \"bottom\">",
"default": "bottom", "default": "bottom",
"description": "Position of element." "description": "Position of element."
}, },
@ -62134,7 +62134,7 @@
"name": "direction", "name": "direction",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\"", "type": "HintedString<\"left\" | \"right\" | \"up\" | \"down\" | \"up-left\" | \"up-right\" | \"down-left\" | \"down-right\">",
"default": "up", "default": "up",
"description": "Specifies the opening direction of actions." "description": "Specifies the opening direction of actions."
}, },
@ -62150,7 +62150,7 @@
"name": "type", "name": "type",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"circle\" | \"linear\" | \"semi-circle\" | \"quarter-circle\"", "type": "HintedString<\"circle\" | \"linear\" | \"semi-circle\" | \"quarter-circle\">",
"default": "linear", "default": "linear",
"description": "Specifies the opening type of actions." "description": "Specifies the opening type of actions."
}, },
@ -62913,7 +62913,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the button." "description": "Defines the size of the button."
}, },
@ -63409,7 +63409,7 @@
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\"", "type": "HintedString<\"horizontal\" | \"vertical\">",
"default": "horizontal", "default": "horizontal",
"description": "Orientation of the panels." "description": "Orientation of the panels."
}, },
@ -63433,7 +63433,7 @@
"name": "stateStorage", "name": "stateStorage",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"session\" | \"local\"", "type": "HintedString<\"session\" | \"local\">",
"default": "session", "default": "session",
"description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage." "description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage."
}, },
@ -70850,7 +70850,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -70866,7 +70866,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -72041,7 +72041,7 @@
"name": "align", "name": "align",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\" | \"top\" | \"bottom\" | \"alternate\"", "type": "HintedString<\"left\" | \"right\" | \"top\" | \"bottom\" | \"alternate\">",
"default": "left", "default": "left",
"description": "Position of the timeline bar relative to the content." "description": "Position of the timeline bar relative to the content."
}, },
@ -72049,7 +72049,7 @@
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"horizontal\" | \"vertical\"", "type": "HintedString<\"horizontal\" | \"vertical\">",
"default": "horizontal", "default": "horizontal",
"description": "Orientation of the timeline." "description": "Orientation of the timeline."
}, },
@ -72485,7 +72485,7 @@
"name": "severity", "name": "severity",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"error\" | \"secondary\" | \"info\" | \"success\" | \"warn\" | \"contrast\"", "type": "HintedString<\"error\" | \"secondary\" | \"info\" | \"success\" | \"warn\" | \"contrast\">",
"default": "info", "default": "info",
"description": "Severity level of the message." "description": "Severity level of the message."
}, },
@ -73276,7 +73276,7 @@
"name": "iconPos", "name": "iconPos",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"left\" | \"right\"", "type": "HintedString<\"left\" | \"right\">",
"default": "left", "default": "left",
"description": "Position of the icon." "description": "Position of the icon."
}, },
@ -73324,7 +73324,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -75266,7 +75266,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\" | \"checkbox\"", "type": "HintedString<\"single\" | \"multiple\" | \"checkbox\">",
"default": "", "default": "",
"description": "Defines the selection mode." "description": "Defines the selection mode."
}, },
@ -75298,7 +75298,7 @@
"name": "loadingMode", "name": "loadingMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"mask\" | \"icon\"", "type": "HintedString<\"mask\" | \"icon\">",
"default": "mask", "default": "mask",
"description": "Loading mode display." "description": "Loading mode display."
}, },
@ -75322,7 +75322,7 @@
"name": "filterMode", "name": "filterMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"lenient\" | \"strict\"", "type": "HintedString<\"lenient\" | \"strict\">",
"default": "lenient", "default": "lenient",
"description": "Mode for filtering." "description": "Mode for filtering."
}, },
@ -76355,7 +76355,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\" | \"checkbox\"", "type": "HintedString<\"single\" | \"multiple\" | \"checkbox\">",
"default": "", "default": "",
"description": "Defines the selection mode." "description": "Defines the selection mode."
}, },
@ -76379,7 +76379,7 @@
"name": "display", "name": "display",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"comma\" | \"chip\"", "type": "HintedString<\"comma\" | \"chip\">",
"default": "comma", "default": "comma",
"description": "Defines how the selected items are displayed." "description": "Defines how the selected items are displayed."
}, },
@ -76427,7 +76427,7 @@
"name": "loadingMode", "name": "loadingMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"mask\" | \"icon\"", "type": "HintedString<\"mask\" | \"icon\">",
"default": "mask", "default": "mask",
"description": "Loading mode display." "description": "Loading mode display."
}, },
@ -76451,7 +76451,7 @@
"name": "filterMode", "name": "filterMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"lenient\" | \"strict\"", "type": "HintedString<\"lenient\" | \"strict\">",
"default": "lenient", "default": "lenient",
"description": "Mode for filtering." "description": "Mode for filtering."
}, },
@ -76491,7 +76491,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the component." "description": "Defines the size of the component."
}, },
@ -76515,7 +76515,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "null | \"outlined\" | \"filled\"", "type": "null | HintedString<\"outlined\" | \"filled\">",
"default": "null", "default": "null",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
}, },
@ -77985,7 +77985,7 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\" | \"checkbox\"", "type": "HintedString<\"single\" | \"multiple\" | \"checkbox\">",
"default": "", "default": "",
"description": "Defines the selection mode." "description": "Defines the selection mode."
}, },
@ -78049,7 +78049,7 @@
"name": "paginatorPosition", "name": "paginatorPosition",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"top\" | \"bottom\" | \"both\"", "type": "HintedString<\"top\" | \"bottom\" | \"both\">",
"default": "bottom", "default": "bottom",
"description": "Position of the paginator, options are 'top','bottom' or 'both'." "description": "Position of the paginator, options are 'top','bottom' or 'both'."
}, },
@ -78121,7 +78121,7 @@
"name": "loadingMode", "name": "loadingMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"mask\" | \"icon\"", "type": "HintedString<\"mask\" | \"icon\">",
"default": "mask", "default": "mask",
"description": "Loading mode display." "description": "Loading mode display."
}, },
@ -78177,7 +78177,7 @@
"name": "sortMode", "name": "sortMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"single\" | \"multiple\"", "type": "HintedString<\"single\" | \"multiple\">",
"default": "single", "default": "single",
"description": "Defines whether sorting works on single column or on multiple columns." "description": "Defines whether sorting works on single column or on multiple columns."
}, },
@ -78201,7 +78201,7 @@
"name": "filterMode", "name": "filterMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"lenient\" | \"strict\"", "type": "HintedString<\"lenient\" | \"strict\">",
"default": "lenient", "default": "lenient",
"description": "Mode for filtering." "description": "Mode for filtering."
}, },
@ -78225,7 +78225,7 @@
"name": "columnResizeMode", "name": "columnResizeMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"fit\" | \"expand\"", "type": "HintedString<\"fit\" | \"expand\">",
"default": "fit", "default": "fit",
"description": "Defines whether the overall table width should change on column resize." "description": "Defines whether the overall table width should change on column resize."
}, },
@ -78265,7 +78265,7 @@
"name": "size", "name": "size",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"small\" | \"large\"", "type": "HintedString<\"small\" | \"large\">",
"default": "", "default": "",
"description": "Defines the size of the table." "description": "Defines the size of the table."
}, },
@ -79526,7 +79526,7 @@
"name": "orientation", "name": "orientation",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"both\" | \"horizontal\" | \"vertical\"", "type": "HintedString<\"both\" | \"horizontal\" | \"vertical\">",
"default": "vertical", "default": "vertical",
"description": "The orientation of scrollbar." "description": "The orientation of scrollbar."
}, },

6
packages/primevue/src/autocomplete/AutoComplete.d.ts vendored
View File

@ -360,7 +360,7 @@ export interface AutoCompleteProps {
* Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value. * Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value.
* @defaultValue blank * @defaultValue blank
*/ */
dropdownMode?: 'blank' | 'current' | undefined; dropdownMode?: HintedString<'blank' | 'current'> | undefined;
/** /**
* Specifies if multiple values can be selected. * Specifies if multiple values can be selected.
* @defaultValue false * @defaultValue false
@ -378,7 +378,7 @@ export interface AutoCompleteProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -393,7 +393,7 @@ export interface AutoCompleteProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* A property to uniquely identify an option. * A property to uniquely identify an option.
*/ */

6
packages/primevue/src/avatar/Avatar.d.ts vendored
View File

@ -6,7 +6,7 @@
* *
* @module avatar * @module avatar
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -94,12 +94,12 @@ export interface AvatarProps {
* Size of the element. * Size of the element.
* @defaultValue normal * @defaultValue normal
*/ */
size?: 'normal' | 'large' | 'xlarge' | undefined; size?: HintedString<'normal' | 'large' | 'xlarge'> | undefined;
/** /**
* Shape of the element. * Shape of the element.
* @defaultValue square * @defaultValue square
*/ */
shape?: 'square' | 'circle' | undefined; shape?: HintedString<'square' | 'circle'> | undefined;
/** /**
* Establishes a string value that labels the component. * Establishes a string value that labels the component.
*/ */

2
packages/primevue/src/badge/Badge.d.ts vendored
View File

@ -74,7 +74,7 @@ export interface BadgeProps {
/** /**
* Size of the badge, valid options are 'small', 'large', and 'xlarge'. * Size of the badge, valid options are 'small', 'large', and 'xlarge'.
*/ */
size?: 'small' | 'large' | 'xlarge' | null | undefined; size?: HintedString<'small' | 'large' | 'xlarge'> | null | undefined;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */

4
packages/primevue/src/cascadeselect/CascadeSelect.d.ts vendored
View File

@ -311,7 +311,7 @@ export interface CascadeSelectProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -326,7 +326,7 @@ export interface CascadeSelectProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* A property to uniquely identify an option. * A property to uniquely identify an option.
*/ */

4
packages/primevue/src/checkbox/Checkbox.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module checkbox * @module checkbox
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -138,7 +138,7 @@ export interface CheckboxProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* When present, it specifies that an input field is read-only. * When present, it specifies that an input field is read-only.
* @default false * @default false

2
packages/primevue/src/colorpicker/ColorPicker.d.ts vendored
View File

@ -161,7 +161,7 @@ export interface ColorPickerProps {
* Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'. * Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'.
* @defaultValue hex * @defaultValue hex
*/ */
format?: 'hex' | 'rgb' | 'hsb' | undefined; format?: HintedString<'hex' | 'rgb' | 'hsb'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false

6
packages/primevue/src/column/Column.d.ts vendored
View File

@ -8,7 +8,7 @@
* @module column * @module column
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { BadgePassThroughOptions } from 'primevue/badge'; import type { BadgePassThroughOptions } from 'primevue/badge';
import type { ButtonPassThroughOptions } from 'primevue/button'; import type { ButtonPassThroughOptions } from 'primevue/button';
@ -482,7 +482,7 @@ export interface ColumnProps {
/** /**
* Defines column based selection mode. * Defines column based selection mode.
*/ */
selectionMode?: 'single' | 'multiple' | undefined; selectionMode?: HintedString<'single' | 'multiple'> | undefined;
/** /**
* Displays an icon to toggle row expansion. * Displays an icon to toggle row expansion.
* @defaultValue false * @defaultValue false
@ -524,7 +524,7 @@ export interface ColumnProps {
* Position of a frozen column, valid values are left and right. * Position of a frozen column, valid values are left and right.
* @defaultValue left * @defaultValue left
*/ */
alignFrozen?: 'left' | 'right' | undefined; alignFrozen?: HintedString<'left' | 'right'> | undefined;
/** /**
* Whether the column is included in data export. * Whether the column is included in data export.
* @defaultValue false * @defaultValue false

4
packages/primevue/src/columngroup/ColumnGroup.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module columngroup * @module columngroup
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -73,7 +73,7 @@ export interface ColumnGroupProps {
/** /**
* Type of column group * Type of column group
*/ */
type?: 'header' | 'footer' | undefined; type?: HintedString<'header' | 'footer'> | undefined;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */

2
packages/primevue/src/confirmationoptions/ConfirmationOptions.d.ts vendored
View File

@ -32,7 +32,7 @@ export interface ConfirmationOptions {
* Position of the dialog. * Position of the dialog.
* @defaultValue center * @defaultValue center
*/ */
position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined; position?: HintedString<'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright'> | undefined;
/** /**
* Icon to display next to the message. * Icon to display next to the message.
*/ */

20
packages/primevue/src/datatable/DataTable.d.ts vendored
View File

@ -913,7 +913,7 @@ export interface DataTableProps<T = any> {
* Position of the paginator, options are 'top','bottom' or 'both'. * Position of the paginator, options are 'top','bottom' or 'both'.
* @defaultValue bottom * @defaultValue bottom
*/ */
paginatorPosition?: 'top' | 'bottom' | 'both' | undefined; paginatorPosition?: HintedString<'top' | 'bottom' | 'both'> | undefined;
/** /**
* Whether to show it even there is only one page. * Whether to show it even there is only one page.
* @defaultValue true * @defaultValue true
@ -995,7 +995,7 @@ export interface DataTableProps<T = any> {
* Defines whether sorting works on single column or on multiple columns. * Defines whether sorting works on single column or on multiple columns.
* @defaultValue single * @defaultValue single
*/ */
sortMode?: 'single' | 'multiple' | undefined; sortMode?: HintedString<'single' | 'multiple'> | undefined;
/** /**
* When enabled, columns can have an un-sorted state. * When enabled, columns can have an un-sorted state.
* @defaultValue false * @defaultValue false
@ -1009,7 +1009,7 @@ export interface DataTableProps<T = any> {
/** /**
* Layout of the filter elements. * Layout of the filter elements.
*/ */
filterDisplay?: 'menu' | 'row' | undefined; filterDisplay?: HintedString<'menu' | 'row'> | undefined;
/** /**
* An array of fields as string or function to use in global filtering. * An array of fields as string or function to use in global filtering.
*/ */
@ -1025,12 +1025,12 @@ export interface DataTableProps<T = any> {
/** /**
* Specifies the selection mode. * Specifies the selection mode.
*/ */
selectionMode?: 'single' | 'multiple' | undefined; selectionMode?: HintedString<'single' | 'multiple'> | undefined;
/** /**
* Algorithm to define if a row is selected. * Algorithm to define if a row is selected.
* @defaultValue deepEquals * @defaultValue deepEquals
*/ */
compareSelectionBy?: 'equals' | 'deepEquals' | undefined; compareSelectionBy?: HintedString<'equals' | 'deepEquals'> | undefined;
/** /**
* Defines whether metaKey is requred or not for the selection. When true metaKey needs to be pressed to select or unselect an item and * Defines whether metaKey is requred or not for the selection. 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. * when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
@ -1078,7 +1078,7 @@ export interface DataTableProps<T = any> {
* Defines whether the overall table width. * Defines whether the overall table width.
* @defaultValue fit * @defaultValue fit
*/ */
columnResizeMode?: 'fit' | 'expand' | undefined; columnResizeMode?: HintedString<'fit' | 'expand'> | undefined;
/** /**
* When enabled, columns can be reordered using drag and drop. * When enabled, columns can be reordered using drag and drop.
* @defaultValue false * @defaultValue false
@ -1099,7 +1099,7 @@ export interface DataTableProps<T = any> {
/** /**
* Defines the row group mode. * Defines the row group mode.
*/ */
rowGroupMode?: 'subheader' | 'rowspan' | undefined; rowGroupMode?: HintedString<'subheader' | 'rowspan'> | undefined;
/** /**
* One or more field names to use in row grouping. * One or more field names to use in row grouping.
*/ */
@ -1117,7 +1117,7 @@ export interface DataTableProps<T = any> {
* Defines where a stateful table keeps its state. * Defines where a stateful table keeps its state.
* @defaultValue session * @defaultValue session
*/ */
stateStorage?: 'session' | 'local' | undefined; stateStorage?: HintedString<'session' | 'local'> | undefined;
/** /**
* Unique identifier of a stateful table to use in state storage. * Unique identifier of a stateful table to use in state storage.
*/ */
@ -1125,7 +1125,7 @@ export interface DataTableProps<T = any> {
/** /**
* Defines the incell editing mode. * Defines the incell editing mode.
*/ */
editMode?: 'cell' | 'row' | undefined; editMode?: HintedString<'cell' | 'row'> | undefined;
/** /**
* A collection of rows to represent the current editing data in row edit mode. * A collection of rows to represent the current editing data in row edit mode.
*/ */
@ -1187,7 +1187,7 @@ export interface DataTableProps<T = any> {
/** /**
* Defines the size of the table. * Defines the size of the table.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Inline style of the table element. * Inline style of the table element.
*/ */

6
packages/primevue/src/dataview/DataView.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module dataview * @module dataview
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PaginatorPassThroughOptionType } from 'primevue/paginator'; import type { PaginatorPassThroughOptionType } from 'primevue/paginator';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -152,7 +152,7 @@ export interface DataViewProps {
* Layout of the items, valid values are 'list' and 'grid'. * Layout of the items, valid values are 'list' and 'grid'.
* @defaultValue list * @defaultValue list
*/ */
layout?: 'list' | 'grid' | undefined; layout?: HintedString<'list' | 'grid'> | undefined;
/** /**
* Number of rows to display per page. * Number of rows to display per page.
* @defaultValue 0 * @defaultValue 0
@ -176,7 +176,7 @@ export interface DataViewProps {
* Position of the paginator, options are 'top','bottom' or 'both'. * Position of the paginator, options are 'top','bottom' or 'both'.
* @defaultValue bottom * @defaultValue bottom
*/ */
paginatorPosition?: 'top' | 'bottom' | 'both' | undefined; paginatorPosition?: HintedString<'top' | 'bottom' | 'both'> | undefined;
/** /**
* Whether to show it even there is only one page. * Whether to show it even there is only one page.
* @defaultValue true * @defaultValue true

12
packages/primevue/src/datepicker/DatePicker.d.ts vendored
View File

@ -529,7 +529,7 @@ export interface DatePickerProps {
* Defines the quantity of the selection. * Defines the quantity of the selection.
* @defaultValue single * @defaultValue single
*/ */
selectionMode?: 'single' | 'multiple' | 'range' | undefined; selectionMode?: HintedString<'single' | 'multiple' | 'range'> | undefined;
/** /**
* Format of the date. Defaults to PrimeVue Locale configuration. * Format of the date. Defaults to PrimeVue Locale configuration.
*/ */
@ -558,7 +558,7 @@ export interface DatePickerProps {
* Icon position of the component. This only applies if the showIcon option is set to true. * Icon position of the component. This only applies if the showIcon option is set to true.
* @defaultValue 'button' * @defaultValue 'button'
*/ */
iconDisplay?: 'button' | 'input' | undefined; iconDisplay?: HintedString<'button' | 'input'> | undefined;
/** /**
* Icon of the datepicker button. * Icon of the datepicker button.
*/ */
@ -597,7 +597,7 @@ export interface DatePickerProps {
* Type of view to display. * Type of view to display.
* @defaultValue date * @defaultValue date
*/ */
view?: 'date' | 'month' | 'year' | undefined; view?: HintedString<'date' | 'month' | 'year'> | undefined;
/** /**
* The minimum selectable date. * The minimum selectable date.
*/ */
@ -657,7 +657,7 @@ export interface DatePickerProps {
* Specifies hour format. * Specifies hour format.
* @defaultValue 24 * @defaultValue 24
*/ */
hourFormat?: '12' | '24' | undefined; hourFormat?: HintedString<'12' | '24'> | undefined;
/** /**
* Hours to change per step. * Hours to change per step.
* @defaultValue 1 * @defaultValue 1
@ -706,7 +706,7 @@ export interface DatePickerProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -721,7 +721,7 @@ export interface DatePickerProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* When present, it specifies that an input field is read-only. * When present, it specifies that an input field is read-only.
* @defaultValue false * @defaultValue false

2
packages/primevue/src/dialog/Dialog.d.ts vendored
View File

@ -229,7 +229,7 @@ export interface DialogProps {
* Position of the dialog. * Position of the dialog.
* @defaultValue center * @defaultValue center
*/ */
position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined; position?: HintedString<'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright'> | undefined;
/** /**
* Whether the dialog can be displayed full screen. * Whether the dialog can be displayed full screen.
* @defaultValue false * @defaultValue false

8
packages/primevue/src/divider/Divider.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module divider * @module divider
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -74,17 +74,17 @@ export interface DividerProps {
/** /**
* Alignment of the content. * Alignment of the content.
*/ */
align?: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined; align?: HintedString<'left' | 'center' | 'right' | 'top' | 'center' | 'bottom'> | undefined;
/** /**
* Specifies the orientation, valid values are 'horizontal' and 'vertical'. * Specifies the orientation, valid values are 'horizontal' and 'vertical'.
* @defaultValue horizontal * @defaultValue horizontal
*/ */
layout?: 'horizontal' | 'vertical' | undefined; layout?: HintedString<'horizontal' | 'vertical'> | undefined;
/** /**
* Border style type. * Border style type.
* @defaultValue solid * @defaultValue solid
*/ */
type?: 'solid' | 'dashed' | 'dotted' | undefined; type?: HintedString<'solid' | 'dashed' | 'dotted'> | undefined;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */

8
packages/primevue/src/dock/Dock.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module dock * @module dock
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { MenuItem } from 'primevue/menuitem'; import type { MenuItem } from 'primevue/menuitem';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -147,12 +147,12 @@ export interface DockTooltipOptions {
/** /**
* Event to show the tooltip, valid values are hover and focus. * Event to show the tooltip, valid values are hover and focus.
*/ */
event: 'hover' | 'focus' | undefined; event: HintedString<'hover' | 'focus'> | undefined;
/** /**
* Position of element. * Position of element.
* @defaultValue bottom * @defaultValue bottom
*/ */
position: 'bottom' | 'top' | 'left' | 'right' | undefined; position: HintedString<'bottom' | 'top' | 'left' | 'right'> | undefined;
/** /**
* Optional options. * Optional options.
*/ */
@ -185,7 +185,7 @@ export interface DockProps {
* Position of element. * Position of element.
* @defaultValue bottom * @defaultValue bottom
*/ */
position?: 'bottom' | 'top' | 'left' | 'right' | undefined; position?: HintedString<'bottom' | 'top' | 'left' | 'right'> | undefined;
/** /**
* Style class of the element. * Style class of the element.
*/ */

4
packages/primevue/src/drawer/Drawer.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module drawer * @module drawer
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { ButtonPassThroughOptions } from 'primevue/button'; import type { ButtonPassThroughOptions } from 'primevue/button';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -137,7 +137,7 @@ export interface DrawerProps {
* Specifies the position of the drawer. * Specifies the position of the drawer.
* @defaultValue left * @defaultValue left
*/ */
position?: 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined; position?: HintedString<'left' | 'right' | 'top' | 'bottom' | 'full'> | undefined;
/** /**
* Title content of the dialog. * Title content of the dialog.
*/ */

4
packages/primevue/src/fileupload/FileUpload.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module fileupload * @module fileupload
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { BadgePassThroughOptions } from 'primevue/badge'; import type { BadgePassThroughOptions } from 'primevue/badge';
import type { ButtonPassThroughOptions } from 'primevue/button'; import type { ButtonPassThroughOptions } from 'primevue/button';
@ -331,7 +331,7 @@ export interface FileUploadProps {
* Defines the UI of the component, possible values are 'advanced' and 'basic'. * Defines the UI of the component, possible values are 'advanced' and 'basic'.
* @defaultValue advanced * @defaultValue advanced
*/ */
mode?: 'advanced' | 'basic' | undefined; mode?: HintedString<'advanced' | 'basic'> | undefined;
/** /**
* Used to select multiple files at once from file dialog. * Used to select multiple files at once from file dialog.
* @defaultValue false * @defaultValue false

4
packages/primevue/src/floatlabel/FloatLabel.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module floatlabel * @module floatlabel
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { TransitionProps, VNode } from 'vue'; import { TransitionProps, VNode } from 'vue';
@ -92,7 +92,7 @@ export interface FloatLabelProps {
* Defines the positioning of the label relative to the input. * Defines the positioning of the label relative to the input.
* @defaultValue false * @defaultValue false
*/ */
variant?: 'over' | 'in' | 'on' | undefined; variant?: HintedString<'over' | 'in' | 'on'> | undefined;
} }
/** /**

6
packages/primevue/src/galleria/Galleria.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module galleria * @module galleria
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { ButtonHTMLAttributes, HTMLAttributes, TransitionProps, VNode } from 'vue'; import { ButtonHTMLAttributes, HTMLAttributes, TransitionProps, VNode } from 'vue';
@ -348,7 +348,7 @@ export interface GalleriaProps {
* Position of thumbnails. * Position of thumbnails.
* @defaultValue bottom * @defaultValue bottom
*/ */
thumbnailsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; thumbnailsPosition?: HintedString<'bottom' | 'top' | 'left' | 'right'> | undefined;
/** /**
* Height of the viewport in vertical thumbnail. * Height of the viewport in vertical thumbnail.
* @defaultValue 300px * @defaultValue 300px
@ -368,7 +368,7 @@ export interface GalleriaProps {
* Position of indicators. * Position of indicators.
* @defaultValue bottom * @defaultValue bottom
*/ */
indicatorsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined; indicatorsPosition?: HintedString<'bottom' | 'top' | 'left' | 'right'> | undefined;
/** /**
* Base zIndex value to use in layering. * Base zIndex value to use in layering.
* @defaultValue 0 * @defaultValue 0

4
packages/primevue/src/inputchips/InputChips.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module inputchips * @module inputchips
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { ChipPassThroughOptions } from 'primevue/chip'; import type { ChipPassThroughOptions } from 'primevue/chip';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -216,7 +216,7 @@ export interface InputChipsProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue outlined * @defaultValue outlined
*/ */
variant?: 'outlined' | 'filled' | undefined; variant?: HintedString<'outlined' | 'filled'> | undefined;
/** /**
* Placeholder text for the input. * Placeholder text for the input.
*/ */

6
packages/primevue/src/inputmask/InputMask.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module inputmask * @module inputmask
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { InputTextPassThroughOptions } from 'primevue/inputtext'; import type { InputTextPassThroughOptions } from 'primevue/inputtext';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -159,12 +159,12 @@ export interface InputMaskProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Spans 100% width of the container when enabled. * Spans 100% width of the container when enabled.
* @defaultValue null * @defaultValue null

12
packages/primevue/src/inputnumber/InputNumber.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module inputnumber * @module inputnumber
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, Nullable, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, Nullable, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { InputTextPassThroughOptions } from 'primevue/inputtext'; import type { InputTextPassThroughOptions } from 'primevue/inputtext';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -220,7 +220,7 @@ export interface InputNumberProps {
* Layout of the buttons. * Layout of the buttons.
* @defaultValue stacked * @defaultValue stacked
*/ */
buttonLayout?: 'stacked' | 'horizontal' | 'vertical' | undefined; buttonLayout?: HintedString<'stacked' | 'horizontal' | 'vertical'> | undefined;
/** /**
* Style class of the increment button. * Style class of the increment button.
*/ */
@ -256,12 +256,12 @@ export interface InputNumberProps {
* See [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details. * See [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details.
* @defaultValue best fit * @defaultValue best fit
*/ */
localeMatcher?: 'lookup' | 'best fit' | undefined; localeMatcher?: HintedString<'lookup' | 'best fit'> | undefined;
/** /**
* Defines the behavior of the component. * Defines the behavior of the component.
* @defaultValue decimal * @defaultValue decimal
*/ */
mode?: 'decimal' | 'currency' | undefined; mode?: HintedString<'decimal' | 'currency'> | undefined;
/** /**
* Text to display before the value. * Text to display before the value.
*/ */
@ -326,7 +326,7 @@ export interface InputNumberProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -341,7 +341,7 @@ export interface InputNumberProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* When present, it specifies that an input field is read-only. * When present, it specifies that an input field is read-only.
* @defaultValue false * @defaultValue false

6
packages/primevue/src/inputotp/InputOtp.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module inputotp * @module inputotp
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { InputTextPassThroughOptions } from 'primevue/inputtext'; import type { InputTextPassThroughOptions } from 'primevue/inputtext';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -169,7 +169,7 @@ export interface InputOtpProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -189,7 +189,7 @@ export interface InputOtpProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Index of the element in tabbing order. * Index of the element in tabbing order.
*/ */

6
packages/primevue/src/inputtext/InputText.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module inputtext * @module inputtext
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, Nullable, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, Nullable, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { InputHTMLAttributes } from 'vue'; import { InputHTMLAttributes } from 'vue';
@ -98,7 +98,7 @@ export interface InputTextProps extends Omit<InputHTMLAttributes, 'size'> {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined | null; size?: HintedString<'small' | 'large'> | undefined | null;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -108,7 +108,7 @@ export interface InputTextProps extends Omit<InputHTMLAttributes, 'size'> {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Spans 100% width of the container when enabled. * Spans 100% width of the container when enabled.
* @defaultValue null * @defaultValue null

4
packages/primevue/src/megamenu/MegaMenu.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module megamenu * @module megamenu
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { MenuItem } from 'primevue/menuitem'; import type { MenuItem } from 'primevue/menuitem';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -246,7 +246,7 @@ export interface MegaMenuProps {
* Defines the orientation. * Defines the orientation.
* @defaultValue horizontal * @defaultValue horizontal
*/ */
orientation?: 'horizontal' | 'vertical' | undefined; orientation?: HintedString<'horizontal' | 'vertical'> | undefined;
/** /**
* The breakpoint to define the maximum width boundary. * The breakpoint to define the maximum width boundary.
* @defaultValue 960px * @defaultValue 960px

4
packages/primevue/src/message/Message.d.ts vendored
View File

@ -159,12 +159,12 @@ export interface MessageProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Specifies the variant of the component. * Specifies the variant of the component.
* @defaultValue undefined * @defaultValue undefined
*/ */
variant?: 'outlined' | 'simple' | undefined; variant?: HintedString<'outlined' | 'simple'> | undefined;
} }
/** /**

6
packages/primevue/src/multiselect/MultiSelect.d.ts vendored
View File

@ -364,7 +364,7 @@ export interface MultiSelectProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -379,7 +379,7 @@ export interface MultiSelectProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Spans 100% width of the container when enabled. * Spans 100% width of the container when enabled.
* @defaultValue null * @defaultValue null
@ -456,7 +456,7 @@ export interface MultiSelectProps {
* Defines how the selected items are displayed. * Defines how the selected items are displayed.
* @defaultValue comma * @defaultValue comma
*/ */
display?: 'comma' | 'chip' | undefined; display?: HintedString<'comma' | 'chip'> | undefined;
/** /**
* Label to display after exceeding max selected labels. * Label to display after exceeding max selected labels.
* @defaultValue null * @defaultValue null

4
packages/primevue/src/organizationchart/OrganizationChart.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module organizationchart * @module organizationchart
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -243,7 +243,7 @@ export interface OrganizationChartProps {
/** /**
* Type of the selection. * Type of the selection.
*/ */
selectionMode?: 'single' | 'multiple' | undefined; selectionMode?: HintedString<'single' | 'multiple'> | undefined;
/** /**
* A map instance of key-value pairs to represented the collapsed nodes. * A map instance of key-value pairs to represented the collapsed nodes.
*/ */

2
packages/primevue/src/overlaybadge/OverlayBadge.d.ts vendored
View File

@ -90,7 +90,7 @@ export interface OverlayBadgeProps {
/** /**
* Size of the badge, valid options are 'small', 'large', and 'xlarge'. * Size of the badge, valid options are 'small', 'large', and 'xlarge'.
*/ */
size?: 'small' | 'large' | 'xlarge' | null | undefined; size?: HintedString<'small' | 'large' | 'xlarge'> | null | undefined;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */

4
packages/primevue/src/password/Password.d.ts vendored
View File

@ -234,7 +234,7 @@ export interface PasswordProps extends Omit<InputHTMLAttributes, 'size'> {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -249,7 +249,7 @@ export interface PasswordProps extends Omit<InputHTMLAttributes, 'size'> {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Placeholder text for the input. * Placeholder text for the input.
*/ */

6
packages/primevue/src/radiobutton/RadioButton.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module radiobutton * @module radiobutton
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -117,7 +117,7 @@ export interface RadioButtonProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -132,7 +132,7 @@ export interface RadioButtonProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* When present, it specifies that an input field is read-only. * When present, it specifies that an input field is read-only.
* @default false * @default false

4
packages/primevue/src/scrolltop/ScrollTop.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module scrolltop * @module scrolltop
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { ButtonPassThroughOptions, ButtonProps } from 'primevue/button'; import type { ButtonPassThroughOptions, ButtonProps } from 'primevue/button';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -108,7 +108,7 @@ export interface ScrollTopProps {
* Target of the ScrollTop. * Target of the ScrollTop.
* @defaultValue window * @defaultValue window
*/ */
target?: 'window' | 'parent' | undefined; target?: HintedString<'window' | 'parent'> | undefined;
/** /**
* Defines the threshold value of the vertical scroll position of the target to toggle the visibility. * Defines the threshold value of the vertical scroll position of the target to toggle the visibility.
* @defaultValue 400 * @defaultValue 400

4
packages/primevue/src/select/Select.d.ts vendored
View File

@ -366,7 +366,7 @@ export interface SelectProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -381,7 +381,7 @@ export interface SelectProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* A property to uniquely identify an option. * A property to uniquely identify an option.
*/ */

4
packages/primevue/src/selectbutton/SelectButton.d.ts vendored
View File

@ -11,7 +11,7 @@ import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
// import { ToggleButtonPassThroughOptions } from 'primevue/togglebutton'; // import { ToggleButtonPassThroughOptions } from 'primevue/togglebutton';
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
export declare type SelectButtonPassThroughOptionType = SelectButtonPassThroughAttributes | ((options: SelectButtonPassThroughMethodOptions) => SelectButtonPassThroughAttributes | string) | string | null | undefined; export declare type SelectButtonPassThroughOptionType = SelectButtonPassThroughAttributes | ((options: SelectButtonPassThroughMethodOptions) => SelectButtonPassThroughAttributes | string) | string | null | undefined;
@ -184,7 +184,7 @@ export interface SelectButtonProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Form control object, typically used for handling validation and form state. * Form control object, typically used for handling validation and form state.
*/ */

6
packages/primevue/src/skeleton/Skeleton.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module skeleton * @module skeleton
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -70,7 +70,7 @@ export interface SkeletonProps {
* Shape of the element. * Shape of the element.
* @defaultValue rectangle * @defaultValue rectangle
*/ */
shape?: 'rectangle' | 'circle' | undefined; shape?: HintedString<'rectangle' | 'circle'> | undefined;
/** /**
* Size of the Circle or Square. * Size of the Circle or Square.
*/ */
@ -93,7 +93,7 @@ export interface SkeletonProps {
* Type of the animation. * Type of the animation.
* @defaultValue wave * @defaultValue wave
*/ */
animation?: 'wave' | 'none' | undefined; animation?: HintedString<'wave' | 'none'> | undefined;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */

4
packages/primevue/src/slider/Slider.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module slider * @module slider
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
@ -123,7 +123,7 @@ export interface SliderProps {
* Orientation of the slider. * Orientation of the slider.
* @defaultValue horizontal * @defaultValue horizontal
*/ */
orientation?: 'horizontal' | 'vertical' | undefined; orientation?: HintedString<'horizontal' | 'vertical'> | undefined;
/** /**
* Step factor to increment/decrement the value. * Step factor to increment/decrement the value.
* @defaultValue 1 * @defaultValue 1

10
packages/primevue/src/speeddial/SpeedDial.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module speeddial * @module speeddial
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { ButtonPassThroughOptions, ButtonProps } from 'primevue/button'; import type { ButtonPassThroughOptions, ButtonProps } from 'primevue/button';
import type { MenuItem } from 'primevue/menuitem'; import type { MenuItem } from 'primevue/menuitem';
@ -167,12 +167,12 @@ export interface SpeedDialTooltipOptions {
/** /**
* Event to show the tooltip, valid values are hover and focus. * Event to show the tooltip, valid values are hover and focus.
*/ */
event: 'hover' | 'focus' | undefined; event: HintedString<'hover' | 'focus'> | undefined;
/** /**
* Position of element. * Position of element.
* @defaultValue bottom * @defaultValue bottom
*/ */
position: 'bottom' | 'top' | 'left' | 'right' | undefined; position: HintedString<'bottom' | 'top' | 'left' | 'right'> | undefined;
/** /**
* Optional options. * Optional options.
*/ */
@ -196,7 +196,7 @@ export interface SpeedDialProps {
* Specifies the opening direction of actions. * Specifies the opening direction of actions.
* @defaultValue up * @defaultValue up
*/ */
direction?: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined; direction?: HintedString<'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right'> | undefined;
/** /**
* Transition delay step for each action item. * Transition delay step for each action item.
* @defaultValue 30 * @defaultValue 30
@ -206,7 +206,7 @@ export interface SpeedDialProps {
* Specifies the opening type of actions. * Specifies the opening type of actions.
* @defaultValue linear * @defaultValue linear
*/ */
type?: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined; type?: HintedString<'linear' | 'circle' | 'semi-circle' | 'quarter-circle'> | undefined;
/** /**
* Radius for *circle types. * Radius for *circle types.
* @defaultValue 0 * @defaultValue 0

2
packages/primevue/src/splitbutton/SplitButton.d.ts vendored
View File

@ -203,7 +203,7 @@ export interface SplitButtonProps {
/** /**
* Defines the size of the button. * Defines the size of the button.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Add a plain textual class to the button without a background initially. * Add a plain textual class to the button without a background initially.
* @defaultValue false * @defaultValue false

6
packages/primevue/src/splitter/Splitter.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module splitter * @module splitter
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -152,7 +152,7 @@ export interface SplitterProps {
* Orientation of the panels. * Orientation of the panels.
* @defaultValue horizontal * @defaultValue horizontal
*/ */
layout?: 'horizontal' | 'vertical' | undefined; layout?: HintedString<'horizontal' | 'vertical'> | undefined;
/** /**
* Size of the divider in pixels. * Size of the divider in pixels.
* @defaultValue 4 * @defaultValue 4
@ -166,7 +166,7 @@ export interface SplitterProps {
* Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage. * Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage.
* @defaultValue session * @defaultValue session
*/ */
stateStorage?: 'local' | 'session' | undefined; stateStorage?: HintedString<'local' | 'session'> | undefined;
/** /**
* Step factor to increment/decrement the size of the panels while pressing the arrow keys. * Step factor to increment/decrement the size of the panels while pressing the arrow keys.
* @defaultValue 1 * @defaultValue 1

6
packages/primevue/src/textarea/Textarea.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module textarea * @module textarea
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, Nullable, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, Nullable, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import type { TextareaHTMLAttributes } from 'vue'; import type { TextareaHTMLAttributes } from 'vue';
@ -107,7 +107,7 @@ export interface TextareaProps extends TextareaHTMLAttributes {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -117,7 +117,7 @@ export interface TextareaProps extends TextareaHTMLAttributes {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Spans 100% width of the container when enabled. * Spans 100% width of the container when enabled.
* @defaultValue null * @defaultValue null

6
packages/primevue/src/timeline/Timeline.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module timeline * @module timeline
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -117,12 +117,12 @@ export interface TimelineProps {
* Position of the timeline bar relative to the content. * Position of the timeline bar relative to the content.
* @defaultValue left * @defaultValue left
*/ */
align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined; align?: HintedString<'left' | 'right' | 'alternate' | 'top' | 'bottom'> | undefined;
/** /**
* Orientation of the timeline. * Orientation of the timeline.
* @defaultValue horizontal * @defaultValue horizontal
*/ */
layout?: 'vertical' | 'horizontal' | undefined; layout?: HintedString<'vertical' | 'horizontal'> | undefined;
/** /**
* Name of the field that uniquely identifies the a record in the data. * Name of the field that uniquely identifies the a record in the data.
*/ */

4
packages/primevue/src/toast/Toast.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module toast * @module toast
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { ButtonHTMLAttributes, TransitionProps, VNode } from 'vue'; import { ButtonHTMLAttributes, TransitionProps, VNode } from 'vue';
@ -117,7 +117,7 @@ export interface ToastMessageOptions {
* Severity level of the message. * Severity level of the message.
* @defaultValue info * @defaultValue info
*/ */
severity?: 'success' | 'info' | 'warn' | 'error' | 'secondary' | 'contrast' | undefined; severity?: HintedString<'success' | 'info' | 'warn' | 'error' | 'secondary' | 'contrast'> | undefined;
/** /**
* Summary content of the message. * Summary content of the message.
*/ */

6
packages/primevue/src/togglebutton/ToggleButton.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module togglebutton * @module togglebutton
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -134,7 +134,7 @@ export interface ToggleButtonProps {
* Position of the icon. * Position of the icon.
* @defaultValue left * @defaultValue left
*/ */
iconPos?: 'left' | 'right' | undefined; iconPos?: HintedString<'left' | 'right'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -161,7 +161,7 @@ export interface ToggleButtonProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Form control object, typically used for handling validation and form state. * Form control object, typically used for handling validation and form state.
*/ */

6
packages/primevue/src/tree/Tree.d.ts vendored
View File

@ -259,7 +259,7 @@ export interface TreeProps {
/** /**
* Defines the selection mode. * Defines the selection mode.
*/ */
selectionMode?: 'single' | 'multiple' | 'checkbox' | undefined; selectionMode?: HintedString<'single' | 'multiple' | 'checkbox'> | undefined;
/** /**
* 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. * 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. * On touch enabled devices, metaKeySelection is turned off automatically.
@ -279,7 +279,7 @@ export interface TreeProps {
* Loading mode display. * Loading mode display.
* @defaultValue mask * @defaultValue mask
*/ */
loadingMode?: 'mask' | 'icon' | undefined; loadingMode?: HintedString<'mask' | 'icon'> | undefined;
/** /**
* When specified, displays an input field to filter the items. * When specified, displays an input field to filter the items.
* @defaultValue false * @defaultValue false
@ -294,7 +294,7 @@ export interface TreeProps {
* Mode for filtering. * Mode for filtering.
* @defaultValue lenient * @defaultValue lenient
*/ */
filterMode?: 'lenient' | 'strict' | undefined; filterMode?: HintedString<'lenient' | 'strict'> | undefined;
/** /**
* Placeholder text to show when filter input is empty. * Placeholder text to show when filter input is empty.
*/ */

12
packages/primevue/src/treeselect/TreeSelect.d.ts vendored
View File

@ -210,7 +210,7 @@ export interface TreeSelectProps {
/** /**
* Defines the selection mode. * Defines the selection mode.
*/ */
selectionMode?: 'single' | 'multiple' | 'checkbox' | undefined; selectionMode?: HintedString<'single' | 'multiple' | 'checkbox'> | undefined;
/** /**
* Spans 100% width of the container when enabled. * Spans 100% width of the container when enabled.
* @defaultValue null * @defaultValue null
@ -225,7 +225,7 @@ export interface TreeSelectProps {
* Defines how the selected items are displayed. * Defines how the selected items are displayed.
* @defaultValue comma * @defaultValue comma
*/ */
display?: 'comma' | 'chip' | undefined; display?: HintedString<'comma' | 'chip'> | undefined;
/** /**
* Label to display after exceeding max selected labels. * Label to display after exceeding max selected labels.
* @defaultValue null * @defaultValue null
@ -254,7 +254,7 @@ export interface TreeSelectProps {
* Loading mode display. * Loading mode display.
* @defaultValue mask * @defaultValue mask
*/ */
loadingMode?: 'mask' | 'icon' | undefined; loadingMode?: HintedString<'mask' | 'icon'> | undefined;
/** /**
* When specified, displays an input field to filter the items. * When specified, displays an input field to filter the items.
* @defaultValue false * @defaultValue false
@ -269,7 +269,7 @@ export interface TreeSelectProps {
* Mode for filtering. * Mode for filtering.
* @defaultValue lenient * @defaultValue lenient
*/ */
filterMode?: 'lenient' | 'strict' | undefined; filterMode?: HintedString<'lenient' | 'strict'> | undefined;
/** /**
* Placeholder text to show when filter input is empty. * Placeholder text to show when filter input is empty.
*/ */
@ -290,7 +290,7 @@ export interface TreeSelectProps {
/** /**
* Defines the size of the component. * Defines the size of the component.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* When present, it specifies that the component should have invalid state style. * When present, it specifies that the component should have invalid state style.
* @defaultValue false * @defaultValue false
@ -305,7 +305,7 @@ export interface TreeSelectProps {
* Specifies the input variant of the component. * Specifies the input variant of the component.
* @defaultValue null * @defaultValue null
*/ */
variant?: 'outlined' | 'filled' | undefined | null; variant?: HintedString<'outlined' | 'filled'> | undefined | null;
/** /**
* Index of the element in tabbing order. * Index of the element in tabbing order.
*/ */

14
packages/primevue/src/treetable/TreeTable.d.ts vendored
View File

@ -457,7 +457,7 @@ export interface TreeTableProps {
/** /**
* Defines the selection mode. * Defines the selection mode.
*/ */
selectionMode?: 'single' | 'multiple' | 'checkbox' | undefined; selectionMode?: HintedString<'single' | 'multiple' | 'checkbox'> | undefined;
/** /**
* 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. * 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. * On touch enabled devices, metaKeySelection is turned off automatically.
@ -495,7 +495,7 @@ export interface TreeTableProps {
* Position of the paginator, options are 'top','bottom' or 'both'. * Position of the paginator, options are 'top','bottom' or 'both'.
* @defaultValue bottom * @defaultValue bottom
*/ */
paginatorPosition?: 'top' | 'bottom' | 'both' | undefined; paginatorPosition?: HintedString<'top' | 'bottom' | 'both'> | undefined;
/** /**
* Whether to show it even there is only one page. * Whether to show it even there is only one page.
* @defaultValue true * @defaultValue true
@ -557,7 +557,7 @@ export interface TreeTableProps {
* Loading mode display. * Loading mode display.
* @defaultValue mask * @defaultValue mask
*/ */
loadingMode?: 'mask' | 'icon' | undefined; loadingMode?: HintedString<'mask' | 'icon'> | undefined;
/** /**
* When enabled, background of the rows change on hover. * When enabled, background of the rows change on hover.
* @defaultValue false * @defaultValue false
@ -589,7 +589,7 @@ export interface TreeTableProps {
* Defines whether sorting works on single column or on multiple columns. * Defines whether sorting works on single column or on multiple columns.
* @defaultValue single * @defaultValue single
*/ */
sortMode?: 'single' | 'multiple' | undefined; sortMode?: HintedString<'single' | 'multiple'> | undefined;
/** /**
* When enabled, columns can have an un-sorted state. * When enabled, columns can have an un-sorted state.
* @defaultValue false * @defaultValue false
@ -604,7 +604,7 @@ export interface TreeTableProps {
* Mode for filtering. * Mode for filtering.
* @defaultValue lenient * @defaultValue lenient
*/ */
filterMode?: 'lenient' | 'strict' | undefined; filterMode?: HintedString<'lenient' | 'strict'> | undefined;
/** /**
* Locale to use in filtering. The default locale is the host environment's current locale. * Locale to use in filtering. The default locale is the host environment's current locale.
*/ */
@ -618,7 +618,7 @@ export interface TreeTableProps {
* Defines whether the overall table width should change on column resize. * Defines whether the overall table width should change on column resize.
* @defaultValue fit * @defaultValue fit
*/ */
columnResizeMode?: 'fit' | 'expand' | undefined; columnResizeMode?: HintedString<'fit' | 'expand'> | undefined;
/** /**
* Indentation factor as rem value for children nodes. * Indentation factor as rem value for children nodes.
* @defaultValue 1 * @defaultValue 1
@ -641,7 +641,7 @@ export interface TreeTableProps {
/** /**
* Defines the size of the table. * Defines the size of the table.
*/ */
size?: 'small' | 'large' | undefined; size?: HintedString<'small' | 'large'> | undefined;
/** /**
* Inline style of the table element. * Inline style of the table element.
*/ */

4
packages/primevue/src/virtualscroller/VirtualScroller.d.ts vendored
View File

@ -7,7 +7,7 @@
* @module virtualscroller * @module virtualscroller
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, HintedString, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue'; import { VNode } from 'vue';
@ -255,7 +255,7 @@ export interface VirtualScrollerProps {
* The orientation of scrollbar. * The orientation of scrollbar.
* @defaultValue vertical * @defaultValue vertical
*/ */
orientation?: 'vertical' | 'horizontal' | 'both' | undefined; orientation?: HintedString<'vertical' | 'horizontal' | 'both'> | undefined;
/** /**
* Determines how many additional elements to add to the DOM outside of the view. * Determines how many additional elements to add to the DOM outside of the view.
* According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. * According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number.

48
pnpm-lock.yaml
View File

@ -86,7 +86,7 @@ importers:
version: 15.15.0 version: 15.15.0
pnpm: pnpm:
specifier: ^9.6.0 specifier: ^9.6.0
version: 9.15.6 version: 9.15.7
prettier: prettier:
specifier: ^3.5.2 specifier: ^3.5.2
version: 3.5.3 version: 3.5.3
@ -247,10 +247,10 @@ importers:
version: 3.0.2 version: 3.0.2
tailwindcss: tailwindcss:
specifier: ^4 specifier: ^4
version: 4.0.10 version: 4.0.11
tailwindcss-primeui: tailwindcss-primeui:
specifier: 'catalog:' specifier: 'catalog:'
version: 0.5.1(tailwindcss@4.0.10) version: 0.5.1(tailwindcss@4.0.11)
typedoc: typedoc:
specifier: 0.27.9 specifier: 0.27.9
version: 0.27.9(typescript@5.7.3) version: 0.27.9(typescript@5.7.3)
@ -4748,8 +4748,8 @@ packages:
neo-async@2.6.2: neo-async@2.6.2:
resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==}
nitropack@2.11.2: nitropack@2.11.3:
resolution: {integrity: sha512-NyXw88hkrigXYo0iDodEbWdLyv8iF69LAj63eS+FDLg8+IDEKv1y58eMKmzk8vW/hwHoi2aimqHTfsZbqFAWrg==} resolution: {integrity: sha512-ArhXs3+39cXXJdgOhhKumEYtFK/n3b0MRWyU/ltDy8KGqke61rH+aoenK/WDlfNu4tX51Wi66/PUa+HMlWE0Sg==}
engines: {node: ^16.11.0 || >=17.0.0} engines: {node: ^16.11.0 || >=17.0.0}
hasBin: true hasBin: true
peerDependencies: peerDependencies:
@ -5059,8 +5059,8 @@ packages:
resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==} resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==}
engines: {node: '>=4'} engines: {node: '>=4'}
pnpm@9.15.6: pnpm@9.15.7:
resolution: {integrity: sha512-E5yrBo/fC3USaBeaxfkJtb5yr7SnXFE9GQXRUb78iXe1k9PPhnHtg9TWY3xclLmP+84QgSXeSlonoxIzYBqZ3g==} resolution: {integrity: sha512-7Zj5x0hEJnPEaWS3A0W9IoLJswXo6uU5s0qzHW7yTvjdWdi1XydGb3BVALAJ2cETRxz4flRPPVA2spczDCbplg==}
engines: {node: '>=18.12'} engines: {node: '>=18.12'}
hasBin: true hasBin: true
@ -6086,8 +6086,8 @@ packages:
engines: {node: '>=14.0.0'} engines: {node: '>=14.0.0'}
hasBin: true hasBin: true
tailwindcss@4.0.10: tailwindcss@4.0.11:
resolution: {integrity: sha512-Z8U/6E2BWSdDkt3IWPiphoV+8V6aNzRmu2SriSbuhm6i3QIcY3TdUJzUP5NX8M8MZuIl+v4/77Rer8u4YSrSsg==} resolution: {integrity: sha512-GZ6+tNwieqvpFLZfx2tkZpfOMAK7iumbOJOLmd6v8AcYuHbjUb+cmDRu6l+rFkIqarh5FfLbCSRJhegcVdoPng==}
tailwindcss@4.0.9: tailwindcss@4.0.9:
resolution: {integrity: sha512-12laZu+fv1ONDRoNR9ipTOpUD7RN9essRVkX36sjxuRUInpN7hIiHN4lBd/SIFjbISvnXzp8h/hXzmU8SQQYhw==} resolution: {integrity: sha512-12laZu+fv1ONDRoNR9ipTOpUD7RN9essRVkX36sjxuRUInpN7hIiHN4lBd/SIFjbISvnXzp8h/hXzmU8SQQYhw==}
@ -6107,8 +6107,8 @@ packages:
resolution: {integrity: sha512-5S7Va8hKfV7W5U6g3aYxXmlPoZVAwUMy9AOKyF2fVuZa2UD3qZjg578OrLRt8PcNN1PleVaL/5/yYATNL0ICUw==} resolution: {integrity: sha512-5S7Va8hKfV7W5U6g3aYxXmlPoZVAwUMy9AOKyF2fVuZa2UD3qZjg578OrLRt8PcNN1PleVaL/5/yYATNL0ICUw==}
engines: {node: '>=18'} engines: {node: '>=18'}
terser-webpack-plugin@5.3.13: terser-webpack-plugin@5.3.14:
resolution: {integrity: sha512-JG3pBixF6kx2o0Yfz2K6pqh72DpwTI08nooHd06tcj5WyIt5SsSiUYqRT+kemrGUNSuSzVhwfZ28aO8gogajNQ==} resolution: {integrity: sha512-vkZjpUjb6OMS7dhV+tILUW6BhpDR7P2L/aQSAv+Uwk+m8KATX9EccViHTJR2qDtACKPIYndLGCyl3FMo+r2LMw==}
engines: {node: '>= 10.13.0'} engines: {node: '>= 10.13.0'}
peerDependencies: peerDependencies:
'@swc/core': '*' '@swc/core': '*'
@ -7009,8 +7009,8 @@ packages:
resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==}
engines: {node: '>=10'} engines: {node: '>=10'}
yocto-queue@1.1.1: yocto-queue@1.2.0:
resolution: {integrity: sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==} resolution: {integrity: sha512-KHBC7z61OJeaMGnF3wqNZj+GGNXOyypZviiKpQeiHirG5Ib1ImwcLBH70rbMSkKfSmUNBsdf2PwaEJtKvgmkNw==}
engines: {node: '>=12.20'} engines: {node: '>=12.20'}
yoctocolors@2.1.1: yoctocolors@2.1.1:
@ -11933,7 +11933,7 @@ snapshots:
neo-async@2.6.2: {} neo-async@2.6.2: {}
nitropack@2.11.2(typescript@5.7.3): nitropack@2.11.3(typescript@5.7.3):
dependencies: dependencies:
'@cloudflare/kv-asset-handler': 0.3.4 '@cloudflare/kv-asset-handler': 0.3.4
'@netlify/functions': 3.0.0 '@netlify/functions': 3.0.0
@ -12130,7 +12130,7 @@ snapshots:
magic-string: 0.30.17 magic-string: 0.30.17
mlly: 1.7.4 mlly: 1.7.4
nanotar: 0.2.0 nanotar: 0.2.0
nitropack: 2.11.2(typescript@5.7.3) nitropack: 2.11.3(typescript@5.7.3)
nypm: 0.5.4 nypm: 0.5.4
ofetch: 1.4.1 ofetch: 1.4.1
ohash: 1.1.6 ohash: 1.1.6
@ -12252,7 +12252,7 @@ snapshots:
magic-string: 0.30.17 magic-string: 0.30.17
mlly: 1.7.4 mlly: 1.7.4
nanotar: 0.2.0 nanotar: 0.2.0
nitropack: 2.11.2(typescript@5.7.3) nitropack: 2.11.3(typescript@5.7.3)
nypm: 0.5.4 nypm: 0.5.4
ofetch: 1.4.1 ofetch: 1.4.1
ohash: 1.1.6 ohash: 1.1.6
@ -12430,7 +12430,7 @@ snapshots:
p-limit@4.0.0: p-limit@4.0.0:
dependencies: dependencies:
yocto-queue: 1.1.1 yocto-queue: 1.2.0
p-locate@5.0.0: p-locate@5.0.0:
dependencies: dependencies:
@ -12545,7 +12545,7 @@ snapshots:
pluralize@8.0.0: {} pluralize@8.0.0: {}
pnpm@9.15.6: {} pnpm@9.15.7: {}
postcss-calc@10.1.1(postcss@8.5.3): postcss-calc@10.1.1(postcss@8.5.3):
dependencies: dependencies:
@ -13560,9 +13560,9 @@ snapshots:
dependencies: dependencies:
tailwindcss: 3.4.17 tailwindcss: 3.4.17
tailwindcss-primeui@0.5.1(tailwindcss@4.0.10): tailwindcss-primeui@0.5.1(tailwindcss@4.0.11):
dependencies: dependencies:
tailwindcss: 4.0.10 tailwindcss: 4.0.11
tailwindcss@3.4.17: tailwindcss@3.4.17:
dependencies: dependencies:
@ -13591,7 +13591,7 @@ snapshots:
transitivePeerDependencies: transitivePeerDependencies:
- ts-node - ts-node
tailwindcss@4.0.10: {} tailwindcss@4.0.11: {}
tailwindcss@4.0.9: {} tailwindcss@4.0.9: {}
@ -13621,7 +13621,7 @@ snapshots:
mkdirp: 3.0.1 mkdirp: 3.0.1
yallist: 5.0.0 yallist: 5.0.0
terser-webpack-plugin@5.3.13(webpack@5.98.0): terser-webpack-plugin@5.3.14(webpack@5.98.0):
dependencies: dependencies:
'@jridgewell/trace-mapping': 0.3.25 '@jridgewell/trace-mapping': 0.3.25
jest-worker: 27.5.1 jest-worker: 27.5.1
@ -14541,7 +14541,7 @@ snapshots:
neo-async: 2.6.2 neo-async: 2.6.2
schema-utils: 4.3.0 schema-utils: 4.3.0
tapable: 2.2.1 tapable: 2.2.1
terser-webpack-plugin: 5.3.13(webpack@5.98.0) terser-webpack-plugin: 5.3.14(webpack@5.98.0)
watchpack: 2.4.2 watchpack: 2.4.2
webpack-sources: 3.2.3 webpack-sources: 3.2.3
transitivePeerDependencies: transitivePeerDependencies:
@ -14643,7 +14643,7 @@ snapshots:
yocto-queue@0.1.0: {} yocto-queue@0.1.0: {}
yocto-queue@1.1.1: {} yocto-queue@1.2.0: {}
yoctocolors@2.1.1: {} yoctocolors@2.1.1: {}