From 1bdab8ed453b469660f3f5eb8403b39e921da278 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 17 Sep 2024 10:03:29 +0000 Subject: [PATCH] Update API doc --- apps/showcase/doc/common/apidoc/index.json | 245 +++++++++++++++++++++ 1 file changed, 245 insertions(+) diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index f1a30414a..8d5de38ce 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -29457,6 +29457,251 @@ } } }, + "iftalabel": { + "description": "FloatLabel appears on top of the input field when focused.\n\n[Live Demo](https://www.primevue.org/iftalabel/)", + "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": { + "IftaLabelPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "instance", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines instance." + }, + { + "name": "props", + "optional": false, + "readonly": false, + "type": "IftaLabelProps", + "default": "", + "description": "Defines valid properties." + }, + { + "name": "attrs", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines valid attributes." + }, + { + "name": "parent", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines parent options." + }, + { + "name": "global", + "optional": false, + "readonly": false, + "type": "undefined | object", + "default": "", + "description": "Defines passthrough(pt) options in global config." + } + ], + "methods": [] + }, + "IftaLabelPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "IftaLabelProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "IftaLabelPassThroughOptionType", + "default": "", + "description": "Used to pass attributes to the root's DOM element." + }, + { + "name": "hooks", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Used to manage all lifecycle hooks." + } + ], + "methods": [] + }, + "IftaLabelPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "IftaLabelProps": { + "description": "Defines valid properties in IftaLabel component.", + "relatedProp": "", + "props": [ + { + "name": "dt", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "It generates scoped CSS variables using design tokens for the component." + }, + { + "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": "any", + "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": [] + }, + "IftaLabelSlots": { + "description": "Defines valid slots in IftaLabel component.", + "relatedProp": "", + "props": [ + { + "name": "default", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [] + }, + "IftaLabelEmitsOptions": { + "description": "Defines valid emits in IftaLabel component.", + "relatedProp": "", + "props": [], + "methods": [] + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "IftaLabelPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "props": [] + }, + "IftaLabelPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "props": [] + }, + "IftaLabelPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "props": [] + }, + "IftaLabelProps": { + "description": "Defines valid properties in IftaLabel component.", + "props": [] + }, + "IftaLabelSlots": { + "description": "Defines valid slots in IftaLabel component.", + "props": [] + }, + "IftaLabelEmitsOptions": { + "description": "Defines valid emits in IftaLabel component.", + "props": [] + } + } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "IftaLabelPassThroughOptionType": { + "values": "IftaLabelPassThroughAttributes | (options: IftaLabelPassThroughMethodOptions) => undefined | string | null | undefined" + }, + "IftaLabelPassThroughTransitionType": { + "values": "TransitionProps | (options: IftaLabelPassThroughMethodOptions) => TransitionProps | undefined" + }, + "IftaLabelEmits": { + "values": "EmitFn" + } + } + } + }, + "iftalabelstyle": { + "description": "FloatLabel appears on top of the input field when focused.\n\n[Live Demo](https://www.primevue.org/floatlabel/)", + "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": { + "IftaLabelStyle": { + "relatedProp": "", + "props": [], + "methods": [], + "extendedTypes": "default" + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "IftaLabelStyle": { + "props": [] + } + } + }, + "enumerations": { + "values": { + "IftaLabelClasses": { + "members": [ + { + "name": "root", + "optional": false, + "readonly": false, + "value": "\"p-iftalabel\"", + "description": "Class name of the root element" + } + ] + } + } + } + }, "image": { "description": "Displays an image with preview and tranformation options. For multiple image, see Galleria.\n\n[Live Demo](https://www.primevue.org/image/)", "components": {