@primereact/mcp 11.0.0-rc.2

package/data/llms/styled/components/rating/api.json

@@ -0,0 +1,766 @@
+[
+  {
+    "name": "RatingOption",
+    "source": "apps/showcase/assets/apidoc/ratingoption.json",
+    "data": {
+      "description": "RatingOption is a component that wraps a single star slot in the Rating component.\nIt receives its index via props and renders sr-only radio inputs (half and full)\nfor keyboard accessibility.",
+      "interfaces": {
+        "RatingOptionPassThrough": {
+          "description": "Defines passthrough(pt) options of RatingOption component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "RatingOptionPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "RatingOptionProps": {
+          "description": "Defines valid properties in RatingOption component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<RatingOptionInstance, unknown, RatingOptionPassThrough>",
+          "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?: RatingOptionInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: RatingOptionInstance) => 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": "RatingOptionInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<RatingOptionPassThrough>",
+              "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: RatingOptionInstance) => 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": "index",
+              "type": "number",
+              "default": "",
+              "description": "The zero-based index of this option within the rating."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "RatingOptionState": {
+          "description": "Defines valid state in RatingOption component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "RatingOptionExposes": {
+          "description": "Defines the methods and properties exposed by RatingOption component.",
+          "relatedProp": "",
+          "extendedTypes": "UseRatingOptionExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseRatingOptionState",
+              "default": "",
+              "description": "Current state of this option."
+            },
+            {
+              "name": "optionRef",
+              "type": "RefObject<Element>",
+              "default": "",
+              "description": "Ref to the option's root DOM element, used internally for pointer position calculations."
+            },
+            {
+              "name": "optionProps",
+              "type": "Record<string, string | number>",
+              "default": "",
+              "description": "Pre-built data attribute props for the option element."
+            },
+            {
+              "name": "onIconProps",
+              "type": "{ onMouseDown: (e: MouseEvent) => void; onPointerMove: (e: PointerEvent) => void; onClick: (e: MouseEvent) => void }",
+              "default": "",
+              "description": "Pre-built interaction props for the on-icon element."
+            },
+            {
+              "name": "offIconProps",
+              "type": "{ onMouseDown: (e: MouseEvent) => void; onPointerMove: (e: PointerEvent) => void; onClick: (e: MouseEvent) => void }",
+              "default": "",
+              "description": "Pre-built interaction props for the off-icon element."
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(e: PointerEvent) => void",
+              "default": "",
+              "description": "Handle pointer move on On/Off elements (resolves half/full value and sets hovering value)."
+            },
+            {
+              "name": "onClick",
+              "type": "(e: MouseEvent) => void",
+              "default": "",
+              "description": "Handle click on On/Off elements (resolves half/full value and updates value)."
+            },
+            {
+              "name": "onMouseDown",
+              "type": "(e: MouseEvent) => void",
+              "default": "",
+              "description": "Prevent default on mouse down (avoids focus shift)."
+            },
+            {
+              "name": "halfInputProps",
+              "type": "InputHTMLAttributes<HTMLInputElement>",
+              "default": "",
+              "description": "Pre-built props for the half-value sr-only radio input. Null when allowHalf is false."
+            },
+            {
+              "name": "fullInputProps",
+              "type": "InputHTMLAttributes<HTMLInputElement>",
+              "default": "",
+              "description": "Pre-built props for the full-value sr-only radio input."
+            },
+            {
+              "name": "rating",
+              "type": "RatingRootInstance",
+              "default": "",
+              "description": "The parent Rating component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "RatingOptionPassThroughType": {
+          "description": "Defines passthrough(pt) options type in RatingOption component.",
+          "values": "PassThroughType<RatingOptionInstance, E>"
+        },
+        "RatingOptionInstance": {
+          "description": "Instance of RatingOption component.",
+          "values": "ComponentInstance<RatingOptionProps, RatingOptionState, RatingOptionExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "RatingRoot",
+    "source": "apps/showcase/assets/apidoc/ratingroot.json",
+    "data": {
+      "description": "Rating is a component that displays a rating value.",
+      "interfaces": {
+        "RatingRootValueChangeEvent": {
+          "description": "Event fired when the Rating component value changes.",
+          "relatedProp": "",
+          "extendedTypes": "UseRatingValueChangeEvent<React.SyntheticEvent>",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "SyntheticEvent",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The new rating value."
+            }
+          ],
+          "methods": []
+        },
+        "RatingRootPassThrough": {
+          "description": "Defines passthrough(pt) options of Rating component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "RatingRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "option",
+              "type": "RatingRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to each option element."
+            },
+            {
+              "name": "onIcon",
+              "type": "RatingRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the on-icon (filled) overlay element."
+            },
+            {
+              "name": "offIcon",
+              "type": "RatingRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the off-icon (empty) base element."
+            },
+            {
+              "name": "halfInput",
+              "type": "RatingRootPassThroughType<InputHTMLAttributes<HTMLInputElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the half-value sr-only radio input."
+            },
+            {
+              "name": "fullInput",
+              "type": "RatingRootPassThroughType<InputHTMLAttributes<HTMLInputElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the full-value sr-only radio input."
+            }
+          ],
+          "methods": []
+        },
+        "RatingRootProps": {
+          "description": "Defines valid properties in Rating component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<RatingRootInstance, UseRatingProps, RatingRootPassThrough>",
+          "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?: RatingRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: RatingRootInstance) => 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": "RatingRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<RatingRootPassThrough>",
+              "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: RatingRootInstance) => 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": "value",
+              "type": "number",
+              "default": "",
+              "description": "Value of the rating."
+            },
+            {
+              "name": "defaultValue",
+              "type": "number",
+              "default": "0",
+              "description": "The default value of the rating."
+            },
+            {
+              "name": "allowHalf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether to allow half stars."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name used for the hidden radio inputs. Auto-generated if not provided."
+            },
+            {
+              "name": "orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "'horizontal'",
+              "description": "The orientation of the rating."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that component is read-only."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseRatingValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the value changes."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "RatingRootState": {
+          "description": "Defines valid state in Rating component.",
+          "relatedProp": "",
+          "extendedTypes": "UseRatingState",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The current value of the rating."
+            },
+            {
+              "name": "hovering",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the rating is in a hover state."
+            },
+            {
+              "name": "hoveringValue",
+              "type": "number",
+              "default": "",
+              "description": "The value currently being hovered over."
+            }
+          ],
+          "methods": []
+        },
+        "RatingRootExposes": {
+          "description": "Defines the methods and properties exposed by Rating component.",
+          "relatedProp": "",
+          "extendedTypes": "UseRatingExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseRatingState",
+              "default": "",
+              "description": "Current state of the rating."
+            },
+            {
+              "name": "inputName",
+              "type": "string",
+              "default": "",
+              "description": "The computed name used for radio inputs (from props.name or auto-generated).\nNamed 'inputName' to avoid collision with withComponent's common.name."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element (data attributes + event handlers)."
+            },
+            {
+              "name": "updateValue",
+              "type": "(event: SyntheticEvent, value: number) => void",
+              "default": "",
+              "description": "Update the rating value."
+            },
+            {
+              "name": "setHoveringValue",
+              "type": "(value: number) => void",
+              "default": "",
+              "description": "Set the hover value (called by On/Off on pointer move)."
+            },
+            {
+              "name": "resolvePointerValue",
+              "type": "(e: MouseEvent<Element, MouseEvent> | PointerEvent<Element>, optionEl: Element, idx: number) => number",
+              "default": "",
+              "description": "Resolves the value to set from a pointer event, taking allowHalf and element position into account."
+            },
+            {
+              "name": "optionProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the option element."
+            },
+            {
+              "name": "onProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the on-icon element."
+            },
+            {
+              "name": "offProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the off-icon element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "RatingRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in Rating component.",
+          "values": "PassThroughType<RatingRootInstance, E>"
+        },
+        "RatingRootInstance": {
+          "description": "Instance of Rating component.",
+          "values": "ComponentInstance<RatingRootProps, RatingRootState, RatingRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "useRating",
+    "source": "apps/showcase/assets/apidoc/userating.json",
+    "data": {
+      "description": "The useRating manages the state and functionality of a rating component.",
+      "interfaces": {
+        "UseRatingValueChangeEvent": {
+          "description": "Event fired when the rating value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The new rating value."
+            }
+          ],
+          "methods": []
+        },
+        "UseRatingProps": {
+          "description": "Defines valid properties in useRating.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "Value of the rating."
+            },
+            {
+              "name": "defaultValue",
+              "type": "number",
+              "default": "0",
+              "description": "The default value of the rating."
+            },
+            {
+              "name": "allowHalf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether to allow half stars."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name used for the hidden radio inputs. Auto-generated if not provided."
+            },
+            {
+              "name": "orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "'horizontal'",
+              "description": "The orientation of the rating."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that component is read-only."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseRatingValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the value changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseRatingState": {
+          "description": "Defines valid state in useRating.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The current value of the rating."
+            },
+            {
+              "name": "hovering",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the rating is in a hover state."
+            },
+            {
+              "name": "hoveringValue",
+              "type": "number",
+              "default": "",
+              "description": "The value currently being hovered over."
+            }
+          ],
+          "methods": []
+        },
+        "UseRatingRootProps": {
+          "description": "Data attribute props shared by Rating elements.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Layout orientation."
+            },
+            {
+              "name": "[key: string]",
+              "type": "unknown",
+              "description": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseRatingExposes": {
+          "description": "Defines the methods and properties exposed by useRating.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseRatingState",
+              "default": "",
+              "description": "Current state of the rating."
+            },
+            {
+              "name": "inputName",
+              "type": "string",
+              "default": "",
+              "description": "The computed name used for radio inputs (from props.name or auto-generated).\nNamed 'inputName' to avoid collision with withComponent's common.name."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element (data attributes + event handlers)."
+            },
+            {
+              "name": "updateValue",
+              "type": "(event: SyntheticEvent, value: number) => void",
+              "default": "",
+              "description": "Update the rating value."
+            },
+            {
+              "name": "setHoveringValue",
+              "type": "(value: number) => void",
+              "default": "",
+              "description": "Set the hover value (called by On/Off on pointer move)."
+            },
+            {
+              "name": "resolvePointerValue",
+              "type": "(e: MouseEvent<Element, MouseEvent> | PointerEvent<Element>, optionEl: Element, idx: number) => number",
+              "default": "",
+              "description": "Resolves the value to set from a pointer event, taking allowHalf and element position into account."
+            },
+            {
+              "name": "optionProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the option element."
+            },
+            {
+              "name": "onProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the on-icon element."
+            },
+            {
+              "name": "offProps",
+              "type": "UseRatingRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the off-icon element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseRatingInstance": {
+          "description": "Instance of useRating headless.",
+          "values": "HeadlessInstance<UseRatingProps, UseRatingState, UseRatingExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]