From 71f268ffecf0ebf544abeb1239f7fcd1b19deea9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tu=C4=9F=C3=A7e=20K=C3=BC=C3=A7=C3=BCko=C4=9Flu?= Date: Tue, 24 Oct 2023 16:54:13 +0300 Subject: [PATCH] Update index.json --- doc/common/apidoc/index.json | 442 +++++++++++++++++++++++++++++++++-- 1 file changed, 424 insertions(+), 18 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 5ceb6410b..37f34b3b3 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -849,16 +849,16 @@ } } }, - "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)", + "animateonscroll": { + "description": "AnimateOnScroll manages PrimeFlex CSS classes declaratively to during enter/leave animations on scroll or on page load.\n\n[Live Demo](https://primevue.org/animateonscroll)", "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.", + "AnimateOnScrollOptions": { + "description": "Defines options of AnimateOnScroll.", "relatedProp": "", "props": [ { @@ -867,7 +867,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Animate scroll to add when item begins to get displayed." + "description": "AnimateOnScroll scroll to add when item begins to get displayed." }, { "name": "leaveClass", @@ -875,13 +875,13 @@ "readonly": false, "type": "string", "default": "", - "description": "Animate scroll to add when item begins to get hidden." + "description": "AnimateOnScroll scroll to add when item begins to get hidden." }, { "name": "pt", "optional": true, "readonly": false, - "type": "PassThrough", + "type": "PassThrough", "default": "", "description": "Used to pass attributes to DOM elements inside the component." }, @@ -896,7 +896,7 @@ ], "methods": [] }, - "AnimateDirectivePassThroughOptions": { + "AnimateOnScrollDirectivePassThroughOptions": { "description": "Custom passthrough(pt) directive options.", "relatedProp": "", "props": [ @@ -911,8 +911,8 @@ ], "methods": [] }, - "AnimateDirectiveModifiers": { - "description": "Defines modifiers of Animate.", + "AnimateOnScrollDirectiveModifiers": { + "description": "Defines modifiers of AnimateOnScroll.", "relatedProp": "", "props": [ { @@ -926,23 +926,23 @@ ], "methods": [] }, - "AnimateDirectiveBinding": { - "description": "Binding of Animate directive.", + "AnimateOnScrollDirectiveBinding": { + "description": "Binding of AnimateOnScroll directive.", "relatedProp": "", "props": [ { "name": "value", "optional": true, "readonly": false, - "type": "AnimateOptions", + "type": "AnimateOnScrollOptions", "default": "", - "description": "Value of the Animate." + "description": "Value of the AnimateOnScroll." }, { "name": "modifiers", "optional": true, "readonly": false, - "type": "AnimateDirectiveModifiers", + "type": "AnimateOnScrollDirectiveModifiers", "default": "", "description": "Modifiers of the tooltip." } @@ -953,14 +953,14 @@ } } }, - "animate/style/AnimateStyle": { + "animateonscroll/style/AnimateOnScrollStyle": { "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": { + "AnimateOnScrollStyle": { "relatedProp": "", "props": [ { @@ -5238,7 +5238,7 @@ } ], "methods": [], - "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" + "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" } } } @@ -26105,6 +26105,201 @@ } } }, + "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": { @@ -28423,6 +28618,217 @@ } } }, + "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": {