From ce3dd4e9b27f4b1d719c5b51128d1120d695fcda Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 9 Jan 2024 20:40:15 +0000 Subject: [PATCH] Update API doc --- components/doc/common/apidoc/index.json | 575 ++++++++++++++++++++++-- 1 file changed, 549 insertions(+), 26 deletions(-) diff --git a/components/doc/common/apidoc/index.json b/components/doc/common/apidoc/index.json index 675463e1bf..5b2d0eb1d0 100644 --- a/components/doc/common/apidoc/index.json +++ b/components/doc/common/apidoc/index.json @@ -342,6 +342,12 @@ "optional": false, "readonly": false, "type": "AccordionPassThroughMethodOptions" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "AccordionContext" } ], "callbacks": [] @@ -416,6 +422,55 @@ ], "callbacks": [] }, + "AccordionContext": { + "description": "Defines current inline context in Accordion component.", + "relatedProp": "", + "props": [ + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "description": "Opened tab index." + }, + { + "name": "count", + "optional": false, + "readonly": false, + "type": "number", + "description": "Total number of tabs" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this the first tab?" + }, + { + "name": "last", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this the last tab?" + }, + { + "name": "selected", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this tab currently selected." + }, + { + "name": "disabled", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this tab currently disabled." + } + ], + "callbacks": [] + }, "AccordionPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", @@ -911,7 +966,8 @@ "returnType": "void", "description": "This method is used to change the theme dynamically." } - ] + ], + "extendedBy": "CascadeSelectContext" }, "PrimeReactPTOptions": { "description": "This option allows to direct implementation of all relevant attributes (e.g., style, classnames) within the respective HTML tag globally for all components.", @@ -4371,6 +4427,13 @@ "readonly": false, "type": "boolean", "description": "Current selection state of the item as a boolean." + }, + { + "name": "disabled", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Current disabled state of the item as a boolean." } ], "callbacks": [] @@ -9109,6 +9172,12 @@ "optional": false, "readonly": false, "type": "CascadeSelectState" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "CascadeSelectContext" } ], "callbacks": [] @@ -9119,28 +9188,285 @@ "props": [ { "name": "focused", - "optional": false, + "optional": true, "readonly": false, "type": "boolean", "description": "Current focused state as a boolean." }, { "name": "overlayVisible", - "optional": false, + "optional": true, "readonly": false, "type": "boolean", "description": "Current overlay visible state as a boolean." }, { "name": "attributeSelector", - "optional": false, + "optional": true, "readonly": false, "type": "string", "description": "Current overlay attributeSelector state as a string." + }, + { + "name": "selected", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "For items, this is the state of the item." + }, + { + "name": "grouped", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "For items, this is whether it is a group item or not." } ], "callbacks": [] }, + "CascadeSelectContext": { + "description": "Defines current inline context in CascadeSelect component.", + "relatedProp": "", + "props": [ + { + "name": "appendTo", + "optional": true, + "readonly": false, + "type": "AppendToType", + "description": "This option allows components with overlays like dropdowns or popups to be mounted into either the component or any DOM element, such as document body and self." + }, + { + "name": "styleContainer", + "optional": true, + "readonly": false, + "type": "StyleContainerType", + "description": "This option allows `useStyle` to insert dynamic CSS styles into a specific container. This is useful when styles need to be scoped such as in a Shadow DOM." + }, + { + "name": "autoZIndex", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. When autoZIndex is false, each group increments its zIndex within itself." + }, + { + "name": "cssTransition", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "PrimeReact components utilize \"react-transition-group\" internally to implement animations. Setting \"cssTransition\" to \"false\" disables all animations." + }, + { + "name": "filterMatchModeOptions", + "optional": true, + "readonly": false, + "type": "FilterMatchModeOptions", + "description": "Default filter modes to display on DataTable filter menus." + }, + { + "name": "hideOverlaysOnDocumentScrolling", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "Define behavior if the browser window is scrolled while displaying an overlay panel like a Dropdown or Calendar. Depending on your organization's accessibility needs some prefer panels to be closed on scrolling and some prefer the overlay follow the scroll." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "InputStyleType", + "description": "Input fields have two styles: default (outlined with borders) and filled (background-colored). Applying 'p-input-filled' to an input's ancestor enables the filled style." + }, + { + "name": "locale", + "optional": true, + "readonly": false, + "type": "string", + "description": "The locale configuration sets up the language and region specific preferences." + }, + { + "name": "nonce", + "optional": true, + "readonly": false, + "type": "string", + "description": "The nonce value to use on dynamically generated style elements." + }, + { + "name": "nullSortOrder", + "optional": true, + "readonly": false, + "type": "number", + "description": "Determines how null values are sorted." + }, + { + "name": "ripple", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "Ripple is an optional animation for the supported components such as buttons." + }, + { + "name": "zIndex", + "optional": true, + "readonly": false, + "type": "ZIndexOptions", + "description": "ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. When autoZIndex is false, each group increments its zIndex within itself." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "PrimeReactPTOptions", + "description": "This option allows to direct implementation of all relevant attributes (e.g., style, classnames) within the respective HTML tag." + }, + { + "name": "ptOptions", + "optional": true, + "readonly": false, + "type": "PassThroughOptions", + "description": "Used to configure passthrough(pt) options of the component." + }, + { + "name": "unstyled", + "optional": true, + "readonly": false, + "type": "boolean", + "description": "When enabled, it removes all of components styles in the core." + }, + { + "name": "setAppendTo", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"appendTo\" state of the context." + }, + { + "name": "setStyleContainer", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"styleContainer\" state of the context." + }, + { + "name": "setAutoZIndex", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"autoZIndex\" state of the context." + }, + { + "name": "setCssTransition", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"cssTransition\" state of the context." + }, + { + "name": "setFilterMatchModeOptions", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"filterMatchModeOptions\" state of the context." + }, + { + "name": "setHideOverlaysOnDocumentScrolling", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"hideOverlaysOnDocumentScrolling\" state of the context." + }, + { + "name": "setInputStyle", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"inputStyle\" state of the context." + }, + { + "name": "setLocale", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"locale\" state of the context." + }, + { + "name": "setNonce", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"nonce\" state of the context." + }, + { + "name": "setNullSortOrder", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"nullSortOrder\" state of the context." + }, + { + "name": "setRipple", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"ripple\" state of the context." + }, + { + "name": "setZIndex", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"zIndex\" state of the context." + }, + { + "name": "setPt", + "optional": true, + "readonly": false, + "type": "Dispatch>", + "description": "Sets the \"pt\" state of the context." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "string", + "description": "Label of the currently selected item" + } + ], + "callbacks": [ + { + "name": "changeTheme", + "parameters": [ + { + "name": "theme", + "optional": true, + "type": "string", + "description": "The name of the theme to be applied." + }, + { + "name": "newTheme", + "optional": true, + "type": "string", + "description": "The name of the new theme to be applied." + }, + { + "name": "linkElementId", + "optional": true, + "type": "string", + "description": "The id of the link element to be updated." + }, + { + "name": "callback", + "optional": true, + "type": "Function", + "description": "Callback to invoke when the theme change is completed." + } + ], + "returnType": "void", + "description": "This method is used to change the theme dynamically." + } + ], + "extendedTypes": "APIOptions" + }, "CascadeSelectPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "pt", @@ -9208,6 +9534,13 @@ "type": "CascadeSelectPassThroughType>", "description": "Uses to pass attributes to the item's DOM element." }, + { + "name": "sublist", + "optional": true, + "readonly": false, + "type": "CascadeSelectPassThroughType>", + "description": "Uses to pass attributes to the sub-list's DOM element." + }, { "name": "content", "optional": true, @@ -10085,12 +10418,37 @@ { "name": "event", "optional": false, - "type": "MouseEvent", - "description": "Browser event." + "type": "ChipRemoveEvent", + "description": "Custom remove event" } ], "returnType": "void", - "description": "Callback to invoke when a chip is removed." + "description": "Callback to invoke when a chip is removed.\n*" + } + ] + } + } + }, + "events": { + "description": "Defines the custom events used by the component's callbacks.", + "values": { + "ChipRemoveEvent": { + "description": "Custom remove event", + "relatedProp": "", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "SyntheticEvent", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "string", + "description": "Removed item value" } ] } @@ -14183,7 +14541,7 @@ "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": { - "ConfirmDialogThroughMethodOptions": { + "ConfirmDialogPassThroughMethodOptions": { "description": "Custom passthrough(pt) option method.", "relatedProp": "", "props": [ @@ -14296,6 +14654,13 @@ "readonly": false, "type": "ComponentHooks", "description": "Used to manage all lifecycle hooks" + }, + { + "name": "transition", + "optional": true, + "readonly": false, + "type": "ConfirmDialogPassThroughTransitionType", + "description": "Used to control React Transition API." } ], "callbacks": [] @@ -14421,7 +14786,10 @@ "description": "Defines the custom types used by the module.", "values": { "ConfirmDialogPassThroughType": { - "values": "PassThroughType" + "values": "PassThroughType" + }, + "ConfirmDialogPassThroughTransitionType": { + "values": "ReactCSSTransitionProps | Function | undefined" } } } @@ -15861,7 +16229,7 @@ "name": "columnResizeMode", "optional": true, "readonly": false, - "type": "\"fit\" | \"expand\"", + "type": "\"expand\" | \"fit\"", "default": "fit", "description": "Used to define the resize mode of the columns, valid values are \"fit\" and \"expand\"." }, @@ -16903,7 +17271,7 @@ } ], "returnType": "void", - "description": "Callback to invoke when the cancel icon is clicked on row editing mode." + "description": "Callback to invoke when the editing icon is clicked on row editing mode. Use in conjuction with editingRows value from the Datatable to programmatically control editing rows." }, { "name": "onRowEditComplete", @@ -18790,7 +19158,7 @@ "name": "columnResizeMode", "optional": true, "readonly": false, - "type": "\"fit\" | \"expand\"", + "type": "\"expand\" | \"fit\"", "description": "Used to define the resize mode of the columns, valid values are \"fit\" and \"expand\"." }, { @@ -19846,7 +20214,7 @@ } ], "returnType": "void", - "description": "Callback to invoke when the cancel icon is clicked on row editing mode." + "description": "Callback to invoke when the editing icon is clicked on row editing mode. Use in conjuction with editingRows value from the Datatable to programmatically control editing rows." }, { "name": "onRowEditComplete", @@ -26003,22 +26371,33 @@ "returnType": "boolean", "description": "Custom hook to detect if window size matches or not." }, - "useOnEscapeKey": { - "name": "useOnEscapeKey", + "useGlobalOnEscapeKey": { + "name": "useGlobalOnEscapeKey", "parameters": [ { - "name": "ref", - "type": "RefObject", - "description": "The ref of the element to detect escape button click." + "name": "props", + "type": "Object" + } + ], + "returnType": "void", + "description": "Custom hook to use detect global escape button click." + }, + "useDisplayOrder": { + "name": "useDisplayOrder", + "parameters": [ + { + "name": "group", + "type": "string", + "description": "" }, { - "name": "callback", - "type": "any", - "description": "The callback to run when escape button clicked." + "name": "isVisible", + "type": "boolean", + "description": "" } ], - "returnType": "void", - "description": "Custom hook to use detect escape button click." + "returnType": "number | undefined", + "description": "Custom hook to use display order of component of one and the same group" } } }, @@ -29665,6 +30044,14 @@ "default": "false", "description": "When present, it specifies that the element must be filled out before submitting the form." }, + { + "name": "roundingMode", + "optional": true, + "readonly": false, + "type": "RoundingMode", + "default": "halfExpand", + "description": "How decimals should be rounded. [further information](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#roundingmode)." + }, { "name": "showButtons", "optional": true, @@ -29992,6 +30379,9 @@ "types": { "description": "Defines the custom types used by the module.", "values": { + "RoundingMode": { + "values": "\"ceil\" | \"floor\" | \"expand\" | \"trunc\" | \"halfCeil\" | \"halfFloor\" | \"halfExpand\" | \"halfTrunc\" | \"halfEven\"" + }, "InputNumberPassThroughType": { "values": "PassThroughType" } @@ -31567,6 +31957,13 @@ "type": "boolean", "description": "Current selection state of the item as a boolean." }, + { + "name": "focused", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Current focused state of the item as a boolean." + }, { "name": "disabled", "optional": false, @@ -34953,6 +35350,13 @@ "type": "CheckboxPassThroughOptions", "description": "Uses to pass attributes to the header checkbox's DOM element." }, + { + "name": "headerCheckboxContainer", + "optional": true, + "readonly": false, + "type": "MultiSelectPassThroughType>", + "description": "Uses to pass attributes to the header checkbox's container DOM element." + }, { "name": "headerCheckboxIcon", "optional": true, @@ -42622,10 +43026,10 @@ "description": "Uses to pass attributes to the header's DOM element." }, { - "name": "closeButton", + "name": "closeButtonIcon", "optional": true, "readonly": false, - "type": "SidebarPassThroughType>", + "type": "SidebarPassThroughType>", "description": "Uses to pass attributes to the close button's DOM element." }, { @@ -45912,6 +46316,61 @@ "optional": false, "readonly": false, "type": "TabViewPassThroughMethodOptions" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "TabViewContext" + } + ], + "callbacks": [] + }, + "TabViewContext": { + "description": "Defines current inline context in Tabview component.", + "relatedProp": "", + "props": [ + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "description": "Opened tab index." + }, + { + "name": "count", + "optional": false, + "readonly": false, + "type": "number", + "description": "Total number of tabs" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this the first tab?" + }, + { + "name": "last", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this the last tab?" + }, + { + "name": "selected", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this tab currently selected." + }, + { + "name": "disabled", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Is this tab currently disabled." } ], "callbacks": [] @@ -48517,6 +48976,12 @@ "optional": false, "readonly": false, "type": "TooltipState" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "TooltipContext" } ], "callbacks": [] @@ -48556,6 +49021,41 @@ ], "callbacks": [] }, + "TooltipContext": { + "description": "Defines current inline context in Tooltip component.", + "relatedProp": "", + "props": [ + { + "name": "right", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Right aligned tooltip as a boolean." + }, + { + "name": "left", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Right aligned tooltip as a boolean." + }, + { + "name": "top", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Right aligned tooltip as a boolean." + }, + { + "name": "bottom", + "optional": false, + "readonly": false, + "type": "boolean", + "description": "Right aligned tooltip as a boolean." + } + ], + "callbacks": [] + }, "TooltipState": { "description": "Defines current inline state in Tooltip component.", "relatedProp": "", @@ -50666,6 +51166,22 @@ "default": "", "description": "Template of toggler element." }, + { + "name": "tooltip", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Content of the tooltip." + }, + { + "name": "tooltipOptions", + "optional": true, + "readonly": false, + "type": "TooltipOptions", + "default": "", + "description": "Configuration of the tooltip, refer to the tooltip documentation for more information." + }, { "name": "transitionOptions", "optional": true, @@ -51084,6 +51600,13 @@ "readonly": false, "type": "TreeSelectPassThroughTransitionType", "description": "Used to control React Transition API." + }, + { + "name": "tooltip", + "optional": true, + "readonly": false, + "type": "TooltipPassThroughOptions", + "description": "Uses to pass attributes to the Tooltip component." } ], "callbacks": [] @@ -51427,7 +51950,7 @@ "name": "columnResizeMode", "optional": true, "readonly": false, - "type": "\"fit\" | \"expand\"", + "type": "\"expand\" | \"fit\"", "default": "fit", "description": "Defines whether the overall table width should change on column resize, valid values are \"fit\" and \"expand\"." },