@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,322 @@
+[
+  {
+    "name": "IconFieldInset",
+    "source": "apps/showcase/assets/apidoc/iconfieldinset.json",
+    "data": {
+      "description": "IconFieldInset is a component that displays an icon inside an IconField.",
+      "interfaces": {
+        "IconFieldInsetPassThrough": {
+          "description": "Defines passthrough(pt) options of IconFieldInset component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "IconFieldInsetPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "IconFieldInsetProps": {
+          "description": "Defines valid properties in IconFieldInset component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<IconFieldInsetInstance, unknown, IconFieldInsetPassThrough>",
+          "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?: IconFieldInsetInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: IconFieldInsetInstance) => 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": "IconFieldInsetInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<IconFieldInsetPassThrough>",
+              "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: IconFieldInsetInstance) => 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": []
+        },
+        "IconFieldInsetState": {
+          "description": "Defines valid state in IconFieldInset component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "IconFieldInsetExposes": {
+          "description": "Defines the methods and properties exposed by IconFieldInset component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "iconfield",
+              "type": "IconFieldRootInstance",
+              "default": "",
+              "description": "The IconField component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "IconFieldInsetPassThroughType": {
+          "description": "Defines passthrough(pt) options type in IconFieldInset component.",
+          "values": "PassThroughType<IconFieldInsetInstance, E>"
+        },
+        "IconFieldInsetInstance": {
+          "description": "Instance of IconFieldInset component.",
+          "values": "ComponentInstance<IconFieldInsetProps, IconFieldInsetState, IconFieldInsetExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "IconFieldRoot",
+    "source": "apps/showcase/assets/apidoc/iconfieldroot.json",
+    "data": {
+      "description": "IconField wraps an input and an icon.",
+      "interfaces": {
+        "IconFieldRootPassThrough": {
+          "description": "Defines passthrough(pt) options of IconFieldRoot component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "IconFieldRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "inset",
+              "type": "IconFieldRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the inset's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "IconFieldRootProps": {
+          "description": "Defines valid properties in IconFieldRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<IconFieldRootInstance, UseIconFieldProps, IconFieldRootPassThrough>",
+          "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?: IconFieldRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: IconFieldRootInstance) => 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": "IconFieldRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<IconFieldRootPassThrough>",
+              "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: IconFieldRootInstance) => 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": []
+        },
+        "IconFieldRootState": {
+          "description": "Defines valid state in IconFieldRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseIconFieldState",
+          "props": [],
+          "methods": []
+        },
+        "IconFieldRootExposes": {
+          "description": "Defines the methods and properties exposed by IconFieldRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseIconFieldExposes",
+          "props": [
+            {
+              "name": "rootProps",
+              "type": "UseIconFieldRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "IconFieldRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in IconFieldRoot component.",
+          "values": "PassThroughType<IconFieldRootInstance, E>"
+        },
+        "IconFieldRootInstance": {
+          "description": "Instance of IconFieldRoot component.",
+          "values": "ComponentInstance<IconFieldRootProps, IconFieldRootState, IconFieldRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]

package/data/llms/primitive/components/iconfield.md

@@ -0,0 +1,53 @@
+# IconField
+
+An unstyled compound component that wraps an input together with an icon.
+
+<DocPrimitiveIntro description="Build inputs with embedded leading or trailing icons with complete control over layout and styling." />
+
+## Features
+
+- Compound component API with two sub-components: `Root`, `Inset`
+- `Inset` positions an icon inside the input boundary
+- Icons inside `Inset` can be interactive with event handlers like `onClick`
+- Compatible with the size setting of the input field
+
+## Usage
+
+```tsx
+import { IconField } from 'primereact/iconfield';
+import { InputText } from 'primereact/inputtext';
+```
+
+```tsx
+<IconField.Root>
+    <InputText />
+    <IconField.Inset>
+        <SearchIcon />
+    </IconField.Inset>
+</IconField.Root>
+```
+
+## API
+
+### IconFieldRoot
+
+<DocTable name="IconFieldRoot" category="api" />
+
+| Attribute    | Value         |
+| ------------ | ------------- |
+| `data-scope` | `"iconfield"` |
+| `data-part`  | `"root"`      |
+
+### IconFieldInset
+
+<DocTable name="IconFieldInset" category="api" />
+
+## Accessibility
+
+### Screen Reader
+
+IconField.Root and IconField.Inset do not require any roles and attributes.
+
+### Keyboard Support
+
+Component does not include any interactive elements.

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

@@ -0,0 +1,177 @@
+[
+  {
+    "name": "IftaLabel",
+    "source": "apps/showcase/assets/apidoc/iftalabel.json",
+    "data": {
+      "description": "IftaLabel is used to create infield top aligned labels.",
+      "interfaces": {
+        "IftaLabelPassThrough": {
+          "description": "Defines passthrough(pt) options of IftaLabel component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "IftaLabelPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "IftaLabelProps": {
+          "description": "Defines valid properties in IftaLabel component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<IftaLabelInstance, UseIftaLabelProps, IftaLabelPassThrough>",
+          "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?: IftaLabelInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: IftaLabelInstance) => 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": "IftaLabelInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<IftaLabelPassThrough>",
+              "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: IftaLabelInstance) => 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": []
+        },
+        "IftaLabelState": {
+          "description": "Defines valid state in IftaLabel component.",
+          "relatedProp": "",
+          "extendedTypes": "UseIftaLabelState",
+          "props": [],
+          "methods": []
+        },
+        "IftaLabelExposes": {
+          "description": "Defines the methods and properties exposed by IftaLabel component.",
+          "relatedProp": "",
+          "extendedTypes": "UseIftaLabelExposes",
+          "props": [
+            {
+              "name": "rootProps",
+              "type": "UseIftaLabelRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "IftaLabelPassThroughType": {
+          "description": "Defines passthrough(pt) options type in IftaLabel component.",
+          "values": "PassThroughType<IftaLabelInstance, E>"
+        },
+        "IftaLabelClassNamesType": {
+          "description": "Type representing the CSS class names used in the IftaLabel component.",
+          "values": "typeof IftaLabelClassNames[keyof typeof IftaLabelClassNames]"
+        },
+        "IftaLabelInstance": {
+          "description": "Instance of IftaLabel component.",
+          "values": "ComponentInstance<IftaLabelProps, IftaLabelState, IftaLabelExposes>"
+        }
+      },
+      "variables": {
+        "IftaLabelClassNames": {
+          "description": "Defines the CSS class names used in the IftaLabel component.",
+          "variables": [
+            {
+              "name": "root",
+              "value": "p-iftalabel",
+              "optional": false,
+              "readonly": true,
+              "description": "Class name of the root element"
+            }
+          ]
+        }
+      }
+    }
+  }
+]

package/data/llms/primitive/components/iftalabel.md

@@ -0,0 +1,47 @@
+# IftaLabel
+
+An unstyled wrapper that creates an infield top-aligned label for its form element.
+
+<DocPrimitiveIntro description="Build an infield top-aligned label positioned inside the input boundary with complete control over layout and styling." />
+
+## Features
+
+- Wraps a form element and its `Label` to create an infield top-aligned label
+- Label stays visible inside the input boundary, above the value
+- Works with any compatible input component
+
+## Usage
+
+```tsx
+import { IftaLabel } from 'primereact/iftalabel';
+import { InputText } from 'primereact/inputtext';
+import { Label } from 'primereact/label';
+```
+
+```tsx
+<IftaLabel>
+    <InputText id="username" />
+    <Label htmlFor="username">Username</Label>
+</IftaLabel>
+```
+
+## API
+
+### IftaLabel
+
+<DocTable name="IftaLabel" category="api" />
+
+| Attribute    | Value         |
+| ------------ | ------------- |
+| `data-scope` | `"iftalabel"` |
+| `data-part`  | `"root"`      |
+
+## Accessibility
+
+### Screen Reader
+
+IftaLabel does not require any roles and attributes.
+
+### Keyboard Support
+
+Component does not include any interactive elements.