@primereact/mcp 11.0.0-rc.2

package/data/llms/primitive/components/inplace/api.json

@@ -0,0 +1,783 @@
+[
+  {
+    "name": "InplaceClose",
+    "source": "apps/showcase/assets/apidoc/inplaceclose.json",
+    "data": {
+      "description": "InplaceClose component is a part of the PrimeReact library.",
+      "interfaces": {
+        "InplaceClosePassThrough": {
+          "description": "Defines passthrough(pt) options of InplaceClose component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "InplaceClosePassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceCloseProps": {
+          "description": "Defines valid properties in InplaceClose component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<InplaceCloseInstance, unknown, InplaceClosePassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: InplaceCloseInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: InplaceCloseInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "InplaceCloseInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<InplaceClosePassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: InplaceCloseInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "InplaceCloseState": {
+          "description": "Defines valid state in InplaceClose component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "InplaceCloseExposes": {
+          "description": "Defines the methods and properties exposed by InplaceClose component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "inplace",
+              "type": "InplaceRootInstance",
+              "default": "",
+              "description": "The Inplace component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "InplaceClosePassThroughType": {
+          "description": "Defines passthrough(pt) options type in InplaceClose component.",
+          "values": "PassThroughType<InplaceCloseInstance, E>"
+        },
+        "InplaceCloseInstance": {
+          "description": "Instance of InplaceClose component.",
+          "values": "ComponentInstance<InplaceCloseProps, InplaceCloseState, InplaceCloseExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "InplaceContent",
+    "source": "apps/showcase/assets/apidoc/inplacecontent.json",
+    "data": {
+      "description": "InplaceContent component is a part of the PrimeReact library.",
+      "interfaces": {
+        "InplaceContentPassThrough": {
+          "description": "Defines passthrough(pt) options of InplaceContent component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "InplaceContentPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceContentProps": {
+          "description": "Defines valid properties in InplaceContent component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<InplaceContentInstance, unknown, InplaceContentPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: InplaceContentInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: InplaceContentInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "InplaceContentInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<InplaceContentPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: InplaceContentInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "InplaceContentState": {
+          "description": "Defines valid state in InplaceContent component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "InplaceContentExposes": {
+          "description": "Defines the methods and properties exposed by InplaceContent component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "inplace",
+              "type": "InplaceRootInstance",
+              "default": "",
+              "description": "The Inplace component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "InplaceContentPassThroughType": {
+          "description": "Defines passthrough(pt) options type in InplaceContent component.",
+          "values": "PassThroughType<InplaceContentInstance, E>"
+        },
+        "InplaceContentInstance": {
+          "description": "Instance of InplaceContent component.",
+          "values": "ComponentInstance<InplaceContentProps, InplaceContentState, InplaceContentExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "InplaceDisplay",
+    "source": "apps/showcase/assets/apidoc/inplacedisplay.json",
+    "data": {
+      "description": "InplaceDisplay component is a part of the PrimeReact library.",
+      "interfaces": {
+        "InplaceDisplayPassThrough": {
+          "description": "Defines passthrough(pt) options of InplaceDisplay component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "InplaceDisplayPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceDisplayProps": {
+          "description": "Defines valid properties in InplaceDisplay component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<InplaceDisplayInstance, unknown, InplaceDisplayPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: InplaceDisplayInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: InplaceDisplayInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "InplaceDisplayInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<InplaceDisplayPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: InplaceDisplayInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "InplaceDisplayState": {
+          "description": "Defines valid state in InplaceDisplay component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "InplaceDisplayExposes": {
+          "description": "Defines the methods and properties exposed by InplaceDisplay component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "inplace",
+              "type": "InplaceRootInstance",
+              "default": "",
+              "description": "The Inplace component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "InplaceDisplayPassThroughType": {
+          "description": "Defines passthrough(pt) options type in InplaceDisplay component.",
+          "values": "PassThroughType<InplaceDisplayInstance, E>"
+        },
+        "InplaceDisplayInstance": {
+          "description": "Instance of InplaceDisplay component.",
+          "values": "ComponentInstance<InplaceDisplayProps, InplaceDisplayState, InplaceDisplayExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "InplaceRoot",
+    "source": "apps/showcase/assets/apidoc/inplaceroot.json",
+    "data": {
+      "description": "Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.",
+      "interfaces": {
+        "InplaceRootPassThrough": {
+          "description": "Defines passthrough(pt) options of Inplace component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "InplaceRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "content",
+              "type": "InplaceRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the content's DOM element."
+            },
+            {
+              "name": "display",
+              "type": "InplaceRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the display's DOM element."
+            },
+            {
+              "name": "close",
+              "type": "InplaceRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the close's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceRootOpenChangeEvent": {
+          "description": "Event fired when the Inplace's open state changes.",
+          "relatedProp": "",
+          "extendedTypes": "UseInplaceOpenChangeEvent",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "SyntheticEvent<Element, Event>",
+              "default": "",
+              "description": "The original event that triggered the change, if any."
+            },
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "The open state of the inplace."
+            },
+            {
+              "name": "active",
+              "type": "boolean",
+              "default": "",
+              "description": "The open state of the inplace.",
+              "deprecated": "Use "
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the Inplace."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceRootProps": {
+          "description": "Defines valid properties in Inplace component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<InplaceRootInstance, Omit<UseInplaceProps, \"onOpenChange\" | \"onActiveChange\">, InplaceRootPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: InplaceRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: InplaceRootInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "InplaceRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<InplaceRootPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: InplaceRootInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the content is displayed or not."
+            },
+            {
+              "name": "defaultOpen",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the content is displayed or not in uncontrolled mode."
+            },
+            {
+              "name": "active",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the content is displayed or not.",
+              "deprecated": "Use "
+            },
+            {
+              "name": "defaultActive",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the content is displayed or not in uncontrolled mode.",
+              "deprecated": "Use "
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "name": "onOpenChange",
+              "type": "(event: InplaceRootOpenChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the Inplace's open state changes."
+            },
+            {
+              "name": "onActiveChange",
+              "type": "(event: InplaceRootOpenChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the Inplace's open state changes.",
+              "deprecated": "Use "
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "InplaceRootState": {
+          "description": "Defines valid state in Inplace component.",
+          "relatedProp": "",
+          "extendedTypes": "UseInplaceState",
+          "props": [
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "The open state of the useInplace."
+            }
+          ],
+          "methods": []
+        },
+        "InplaceRootExposes": {
+          "description": "Defines the methods and properties exposed by Inplace component.",
+          "relatedProp": "",
+          "extendedTypes": "UseInplaceExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseInplaceState",
+              "default": "",
+              "description": "The state of the useInplace."
+            },
+            {
+              "name": "open",
+              "type": "(originalEvent?: SyntheticEvent) => void",
+              "default": "",
+              "description": "Method to open the inplace."
+            },
+            {
+              "name": "close",
+              "type": "(originalEvent?: SyntheticEvent) => void",
+              "default": "",
+              "description": "Method to close the inplace."
+            },
+            {
+              "name": "onDisplayKeyDown",
+              "type": "(event: KeyboardEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Keydown event handler for the display."
+            },
+            {
+              "name": "onContentKeyDown",
+              "type": "(event: KeyboardEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Keydown event handler for the content (editor) — closes on Escape."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseInplaceRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "displayProps",
+              "type": "UseInplaceDisplayProps",
+              "default": "",
+              "description": "Pre-built props for the display element."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseInplaceContentProps",
+              "default": "",
+              "description": "Pre-built props for the content (editor) element."
+            },
+            {
+              "name": "closeProps",
+              "type": "UseInplaceCloseProps",
+              "default": "",
+              "description": "Pre-built props for the close element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "InplaceRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in Inplace component.",
+          "values": "PassThroughType<InplaceRootInstance, E>"
+        },
+        "InplaceRootChangeEvent": {
+          "description": "Event fired when the Inplace's open state changes.",
+          "values": "InplaceRootOpenChangeEvent"
+        },
+        "InplaceRootInstance": {
+          "description": "Instance of Inplace component.",
+          "values": "ComponentInstance<InplaceRootProps, InplaceRootState, InplaceRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]