From 8ae55214d8d29d6f64ec7f7d6a19360eb8cb648a Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 13 Oct 2023 10:30:17 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 144 ++++++++++++++++++++++++++++++++++- package-lock.json | 4 +- 2 files changed, 144 insertions(+), 4 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 55902e824..85c0ec693 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -836,6 +836,146 @@ } } }, + "animate": { + "description": "Animate manages PrimeFlex CSS classes declaratively to during enter/leave animations on scroll or on page load.\n\n[Live Demo](https://primevue.org/animate)", + "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": { + "AnimateOptions": { + "description": "Defines options of Animate.", + "relatedProp": "", + "props": [ + { + "name": "enterClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Animate scroll to add when item begins to get displayed." + }, + { + "name": "leaveClass", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Animate scroll to add when item begins to get hidden." + }, + { + "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." + } + ], + "methods": [] + }, + "AnimateDirectivePassThroughOptions": { + "description": "Custom passthrough(pt) directive options.", + "relatedProp": "", + "props": [ + { + "name": "hooks", + "optional": true, + "readonly": false, + "type": "DirectiveHooks", + "default": "", + "description": "Used to manage all lifecycle hooks" + } + ], + "methods": [] + }, + "AnimateDirectiveBinding": { + "description": "Binding of Animate directive.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "AnimateOptions", + "default": "", + "description": "Value of the Animate." + } + ], + "methods": [], + "extendedTypes": "Omit" + } + } + } + }, + "animate/style/AnimateStyle": { + "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": { + "AnimateStyle": { + "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" + } + } + } + }, "api/Api": { "interfaces": { "description": "Defines the custom interfaces used by the module.", @@ -5062,7 +5202,7 @@ } ], "methods": [], - "extendedBy": "AccordionStyle,AccordionTabStyle,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" + "extendedBy": "AccordionStyle,AccordionTabStyle,AnimateStyle,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" } } } @@ -55628,4 +55768,4 @@ } } } -} +} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 6ff652b39..c467b7041 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "primevue", - "version": "3.36.1-SNAPSHOT", + "version": "3.36.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "primevue", - "version": "3.36.1-SNAPSHOT", + "version": "3.36.1", "hasInstallScript": true, "license": "MIT", "dependencies": {