From 1ecdf9b9671ff3b3cc2f8785d41737336429a2fa Mon Sep 17 00:00:00 2001
From: GitHub Actions Bot <>
Date: Tue, 24 Oct 2023 16:09:52 +0000
Subject: [PATCH] Update API doc
---
doc/common/apidoc/index.json | 427 +----------------------------------
1 file changed, 10 insertions(+), 417 deletions(-)
diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
index 37f34b3b3..18dd963e1 100644
--- a/doc/common/apidoc/index.json
+++ b/doc/common/apidoc/index.json
@@ -302,17 +302,16 @@
"description": "Default slot to detect AccordionTab components."
},
{
- "name": "togglericon",
- "parameters": [
- {
- "name": "scope",
- "optional": false,
- "type": "{\n \t index: number, // Current index of the tab\n \t isTabActive: (index: number) ⇒ void, // Whether the current tab is active\n}",
- "description": "togglericon slot's params."
- }
- ],
+ "name": "collapseicon",
+ "parameters": [],
"returnType": "VNode[]",
- "description": "Custom toggler icon template."
+ "description": "Custom collapse icon template."
+ },
+ {
+ "name": "expandicon",
+ "parameters": [],
+ "returnType": "VNode[]",
+ "description": "Custom expand icon template."
}
]
},
@@ -5238,7 +5237,7 @@
}
],
"methods": [],
- "extendedBy": "AccordionStyle,AccordionTabStyle,AnimateOnScrollStyle,AutoCompleteStyle,AvatarStyle,AvatarGroupStyle,BadgeStyle,BadgeDirectiveStyle,BaseComponentStyle,BaseIconStyle,BlockUIStyle,BreadcrumbStyle,ButtonStyle,CalendarStyle,CardStyle,CarouselStyle,CascadeSelectStyle,ChartStyle,CheckboxStyle,ChipStyle,ChipsStyle,ColorPickerStyle,ColumnStyle,ColumnGroupStyle,ConfirmDialogStyle,ConfirmPopupStyle,ContextMenuStyle,DataTableStyle,DataViewStyle,DataViewLayoutOptionsStyle,DeferredContentStyle,DialogStyle,DividerStyle,DockStyle,DropdownStyle,DynamicDialogStyle,EditorStyle,FieldsetStyle,AccordionStyle,FloatLabelStyle,FocusTrapStyle,GalleriaStyle,ImageStyle,InlineMessageStyle,InplaceStyle,InputGroupStyle,InputMaskStyle,InputNumberStyle,InputSwitchStyle,InputTextStyle,KnobStyle,ListboxStyle,MegaMenuStyle,MenuStyle,MenubarStyle,MessageStyle,MultiSelectStyle,OrderListStyle,OrganizationChartStyle,OverlayPanelStyle,PaginatorStyle,PanelStyle,PanelMenuStyle,PasswordStyle,PickListStyle,PortalStyle,ProgressBarStyle,ProgressSpinnerStyle,RadioButtonStyle,RatingStyle,AccordionStyle,RowStyle,ScrollPanelStyle,ScrollTopStyle,SelectButtonStyle,SidebarStyle,SkeletonStyle,SliderStyle,SpeedDialStyle,SplitButtonStyle,SplitterStyle,SplitterPanelStyle,StepsStyle,StyleClassStyle,TabMenuStyle,TabPanelStyle,TabViewStyle,TagStyle,TerminalStyle,TextareaStyle,TieredMenuStyle,TimelineStyle,ToastStyle,ToggleButtonStyle,ToolbarStyle,TooltipStyle,TreeStyle,TreeSelectStyle,TreeTableStyle,TriStateCheckboxStyle,VirtualScrollerStyle"
+ "extendedBy": "AccordionStyle,AccordionTabStyle,AnimateOnScrollStyle,AutoCompleteStyle,AvatarStyle,AvatarGroupStyle,BadgeStyle,BadgeDirectiveStyle,BaseComponentStyle,BaseIconStyle,BlockUIStyle,BreadcrumbStyle,ButtonStyle,CalendarStyle,CardStyle,CarouselStyle,CascadeSelectStyle,ChartStyle,CheckboxStyle,ChipStyle,ChipsStyle,ColorPickerStyle,ColumnStyle,ColumnGroupStyle,ConfirmDialogStyle,ConfirmPopupStyle,ContextMenuStyle,DataTableStyle,DataViewStyle,DataViewLayoutOptionsStyle,DeferredContentStyle,DialogStyle,DividerStyle,DockStyle,DropdownStyle,DynamicDialogStyle,EditorStyle,FieldsetStyle,AccordionStyle,FocusTrapStyle,GalleriaStyle,ImageStyle,InlineMessageStyle,InplaceStyle,InputMaskStyle,InputNumberStyle,InputSwitchStyle,InputTextStyle,KnobStyle,ListboxStyle,MegaMenuStyle,MenuStyle,MenubarStyle,MessageStyle,MultiSelectStyle,OrderListStyle,OrganizationChartStyle,OverlayPanelStyle,PaginatorStyle,PanelStyle,PanelMenuStyle,PasswordStyle,PickListStyle,PortalStyle,ProgressBarStyle,ProgressSpinnerStyle,RadioButtonStyle,RatingStyle,AccordionStyle,RowStyle,ScrollPanelStyle,ScrollTopStyle,SelectButtonStyle,SidebarStyle,SkeletonStyle,SliderStyle,SpeedDialStyle,SplitButtonStyle,SplitterStyle,SplitterPanelStyle,StepsStyle,StyleClassStyle,TabMenuStyle,TabPanelStyle,TabViewStyle,TagStyle,TerminalStyle,TextareaStyle,TieredMenuStyle,TimelineStyle,ToastStyle,ToggleButtonStyle,ToolbarStyle,TooltipStyle,TreeStyle,TreeSelectStyle,TreeTableStyle,TriStateCheckboxStyle,VirtualScrollerStyle"
}
}
}
@@ -26105,201 +26104,6 @@
}
}
},
- "floatlabel": {
- "description": "FloatLabel appears on top of the input field when focused.\n\n[Live Demo](https://www.primevue.org/floatlabel/)",
- "components": {
- "default": {
- "description": "FloatLabel appears on top of the input field when focused.",
- "methods": {
- "description": "Defines methods that can be accessed by the component's reference.",
- "values": []
- }
- }
- },
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "FloatLabelPassThroughMethodOptions": {
- "description": "Custom passthrough(pt) option method.",
- "relatedProp": "",
- "props": [
- {
- "name": "instance",
- "optional": false,
- "readonly": false,
- "type": "any",
- "default": "",
- "description": "Defines instance."
- },
- {
- "name": "global",
- "optional": false,
- "readonly": false,
- "type": "undefined | object",
- "default": "",
- "description": "Defines passthrough(pt) options in global config."
- }
- ],
- "methods": []
- },
- "FloatLabelPassThroughOptions": {
- "description": "Custom passthrough(pt) options.",
- "relatedProp": "FloatLabelProps.pt",
- "props": [
- {
- "name": "root",
- "optional": true,
- "readonly": false,
- "type": "FloatLabelPassThroughOptionType",
- "default": "",
- "description": "Used to pass attributes to the root's DOM element."
- },
- {
- "name": "hooks",
- "optional": true,
- "readonly": false,
- "type": "ComponentHooks",
- "default": "",
- "description": "Used to manage all lifecycle hooks"
- }
- ],
- "methods": []
- },
- "FloatLabelPassThroughAttributes": {
- "description": "Custom passthrough attributes for each DOM elements",
- "relatedProp": "",
- "props": [
- {
- "name": "[key: string]",
- "optional": false,
- "readonly": false,
- "type": "any"
- }
- ],
- "methods": []
- },
- "FloatLabelProps": {
- "description": "Defines valid properties in FloatLabel component.",
- "relatedProp": "",
- "props": [
- {
- "name": "pt",
- "optional": true,
- "readonly": false,
- "type": "PassThrough",
- "default": "",
- "description": "Used to pass attributes to DOM elements inside the component."
- },
- {
- "name": "ptOptions",
- "optional": true,
- "readonly": false,
- "type": "PassThroughOptions",
- "default": "",
- "description": "Used to configure passthrough(pt) options of the component."
- },
- {
- "name": "unstyled",
- "optional": true,
- "readonly": false,
- "type": "boolean",
- "default": "false",
- "description": "When enabled, it removes component related styles in the core."
- }
- ],
- "methods": []
- },
- "FloatLabelSlots": {
- "description": "Defines valid slots in FloatLabel slots.",
- "relatedProp": "",
- "props": [],
- "methods": [
- {
- "name": "default",
- "parameters": [],
- "returnType": "VNode[]",
- "description": "Default custom slot."
- }
- ]
- },
- "FloatLabelEmits": {
- "relatedProp": "",
- "props": [],
- "methods": []
- }
- }
- },
- "types": {
- "description": "Defines the custom types used by the module.",
- "values": {
- "FloatLabelPassThroughOptionType": {
- "values": "FloatLabelPassThroughAttributes | (options: FloatLabelPassThroughMethodOptions) => undefined | string | null | undefined"
- }
- }
- }
- },
- "floatlabel/style/FloatLabelStyle": {
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "FloatLabelStyle": {
- "relatedProp": "",
- "props": [
- {
- "name": "name",
- "optional": true,
- "readonly": false,
- "type": "string",
- "default": ""
- },
- {
- "name": "css",
- "optional": true,
- "readonly": false,
- "type": "string",
- "default": ""
- },
- {
- "name": "classes",
- "optional": true,
- "readonly": false,
- "type": "object",
- "default": ""
- },
- {
- "name": "inlineStyles",
- "optional": true,
- "readonly": false,
- "type": "object",
- "default": ""
- },
- {
- "name": "loadStyle",
- "optional": true,
- "readonly": false,
- "type": "Function",
- "default": ""
- },
- {
- "name": "getStyleSheet",
- "optional": true,
- "readonly": false,
- "type": "Function",
- "default": ""
- }
- ],
- "methods": [],
- "extendedTypes": "BaseStyle"
- }
- }
- }
- },
"focustrap": {
"description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n[Live Demo](https://primevue.org/focustrap)",
"interfaces": {
@@ -28618,217 +28422,6 @@
}
}
},
- "inputgroup": {
- "description": "InputGroup displays text, icon, buttons and other content can be grouped next to an input.\n\n[Live Demo](https://www.primevue.org/inputgroup/)",
- "components": {
- "default": {
- "description": "InputGroup displays text, icon, buttons and other content can be grouped next to an input.",
- "methods": {
- "description": "Defines methods that can be accessed by the component's reference.",
- "values": []
- }
- }
- },
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "InputGroupPassThroughMethodOptions": {
- "description": "Custom passthrough(pt) option method.",
- "relatedProp": "",
- "props": [
- {
- "name": "instance",
- "optional": false,
- "readonly": false,
- "type": "any",
- "default": "",
- "description": "Defines instance."
- },
- {
- "name": "global",
- "optional": false,
- "readonly": false,
- "type": "undefined | object",
- "default": "",
- "description": "Defines passthrough(pt) options in global config."
- }
- ],
- "methods": []
- },
- "InputGroupPassThroughOptions": {
- "description": "Custom passthrough(pt) options.",
- "relatedProp": "InputGroupProps.pt",
- "props": [
- {
- "name": "root",
- "optional": true,
- "readonly": false,
- "type": "InputGroupPassThroughOptionType",
- "default": "",
- "description": "Used to pass attributes to the root's DOM element."
- },
- {
- "name": "addon",
- "optional": true,
- "readonly": false,
- "type": "InputGroupPassThroughOptionType",
- "default": "",
- "description": "Used to pass attributes to the addon's DOM element."
- },
- {
- "name": "hooks",
- "optional": true,
- "readonly": false,
- "type": "ComponentHooks",
- "default": "",
- "description": "Used to manage all lifecycle hooks"
- }
- ],
- "methods": []
- },
- "InputGroupPassThroughAttributes": {
- "description": "Custom passthrough attributes for each DOM elements",
- "relatedProp": "",
- "props": [
- {
- "name": "[key: string]",
- "optional": false,
- "readonly": false,
- "type": "any"
- }
- ],
- "methods": []
- },
- "InputGroupProps": {
- "description": "Defines valid properties in InputGroup component.",
- "relatedProp": "",
- "props": [
- {
- "name": "pt",
- "optional": true,
- "readonly": false,
- "type": "PassThrough",
- "default": "",
- "description": "Used to pass attributes to DOM elements inside the component."
- },
- {
- "name": "ptOptions",
- "optional": true,
- "readonly": false,
- "type": "PassThroughOptions",
- "default": "",
- "description": "Used to configure passthrough(pt) options of the component."
- },
- {
- "name": "unstyled",
- "optional": true,
- "readonly": false,
- "type": "boolean",
- "default": "false",
- "description": "When enabled, it removes component related styles in the core."
- }
- ],
- "methods": []
- },
- "InputGroupSlots": {
- "description": "Defines valid slots in InputGroup component.",
- "relatedProp": "",
- "props": [
- {
- "name": "[key: string]",
- "optional": false,
- "readonly": false,
- "type": "Function"
- }
- ],
- "methods": [
- {
- "name": "default",
- "parameters": [],
- "returnType": "VNode[]",
- "description": "Custom default template."
- }
- ]
- },
- "InputGroupEmits": {
- "description": "Defines valid emits in InputGroup component.",
- "relatedProp": "",
- "props": [],
- "methods": []
- }
- }
- },
- "types": {
- "description": "Defines the custom types used by the module.",
- "values": {
- "InputGroupPassThroughOptionType": {
- "values": "InputGroupPassThroughAttributes | (options: InputGroupPassThroughMethodOptions) => undefined | string | null | undefined"
- }
- }
- }
- },
- "inputgroup/style/InputGroupStyle": {
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "InputGroupStyle": {
- "relatedProp": "",
- "props": [
- {
- "name": "name",
- "optional": true,
- "readonly": false,
- "type": "string",
- "default": ""
- },
- {
- "name": "css",
- "optional": true,
- "readonly": false,
- "type": "string",
- "default": ""
- },
- {
- "name": "classes",
- "optional": true,
- "readonly": false,
- "type": "object",
- "default": ""
- },
- {
- "name": "inlineStyles",
- "optional": true,
- "readonly": false,
- "type": "object",
- "default": ""
- },
- {
- "name": "loadStyle",
- "optional": true,
- "readonly": false,
- "type": "Function",
- "default": ""
- },
- {
- "name": "getStyleSheet",
- "optional": true,
- "readonly": false,
- "type": "Function",
- "default": ""
- }
- ],
- "methods": [],
- "extendedTypes": "BaseStyle"
- }
- }
- }
- },
"inputmask": {
"description": "InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.\n\n[Live Demo](https://www.primevue.org/inputmask/)",
"components": {