Update API doc

pull/4572/head
GitHub Actions Bot 2023-10-13 10:30:17 +00:00
parent 8e302a7eb7
commit 8ae55214d8
2 changed files with 144 additions and 4 deletions

View File

@ -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<AnimateDirectivePassThroughOptions>",
"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<any, any>",
"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<DirectiveBinding, \"modifiers\" | \"value\">"
}
}
}
},
"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": { "api/Api": {
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
@ -5062,7 +5202,7 @@
} }
], ],
"methods": [], "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"
} }
} }
} }

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "primevue", "name": "primevue",
"version": "3.36.1-SNAPSHOT", "version": "3.36.1",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "primevue", "name": "primevue",
"version": "3.36.1-SNAPSHOT", "version": "3.36.1",
"hasInstallScript": true, "hasInstallScript": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {