@primereact/mcp 11.0.0-rc.2

package/data/llms/headless/components/inputcolor/api.json

@@ -0,0 +1,469 @@
+[
+  {
+    "name": "useInputColor",
+    "source": "apps/showcase/assets/apidoc/useinputcolor.json",
+    "data": {
+      "description": "The useInputColor manages the state and functionality of a color picker component.",
+      "interfaces": {
+        "UseInputColorChangeEvent": {
+          "description": "Event fired when the color picker's color is changed.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "color",
+              "type": "string",
+              "default": "",
+              "description": "The color of the color picker."
+            },
+            {
+              "name": "value",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The value of the color picker."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorProps": {
+          "description": "Defines valid properties in useInputColor.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The value of the color picker."
+            },
+            {
+              "name": "defaultValue",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The default value of the color picker."
+            },
+            {
+              "name": "format",
+              "type": "ColorSpace",
+              "default": "",
+              "description": "The format of the color picker."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the color picker is disabled."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseInputColorChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the color picker's value is changed."
+            },
+            {
+              "name": "onValueChangeEnd",
+              "type": "(event: UseInputColorChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the pointer interaction ends."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorState": {
+          "description": "Defines valid state in useInputColor.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The color of the color picker."
+            },
+            {
+              "name": "isAreaDragging",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the color picker area is dragging."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorRootProps": {
+          "description": "Pre-built props for the root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": ""
+            },
+            {
+              "name": "data-disabled",
+              "type": "\"\"",
+              "default": ""
+            },
+            {
+              "name": "data-dragging",
+              "type": "\"\"",
+              "default": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorAreaProps": {
+          "description": "Props returned by the area prop getter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"area\"",
+              "default": ""
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Style object containing CSS variables:  `--area-background` ,  `--area-gradient` ,  `--handle-background` ,  `--handle-position-top` ,  `--handle-position-left` ."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": ""
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": ""
+            },
+            {
+              "name": "onPointerUp",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorAreaHandleProps": {
+          "description": "Props returned by the area handle prop getter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"area-handle\"",
+              "default": ""
+            },
+            {
+              "name": "role",
+              "type": "\"slider\"",
+              "default": ""
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": ""
+            },
+            {
+              "name": "aria-disabled",
+              "type": "boolean",
+              "default": ""
+            },
+            {
+              "name": "aria-valuemin",
+              "type": "number",
+              "default": ""
+            },
+            {
+              "name": "aria-valuemax",
+              "type": "number",
+              "default": ""
+            },
+            {
+              "name": "aria-valuenow",
+              "type": "number",
+              "default": ""
+            },
+            {
+              "name": "aria-label",
+              "type": "string",
+              "default": ""
+            },
+            {
+              "name": "aria-roledescription",
+              "type": "string",
+              "default": ""
+            },
+            {
+              "name": "aria-valuetext",
+              "type": "string",
+              "default": ""
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLElement>) => void",
+              "default": ""
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLElement>) => void",
+              "default": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorEyeDropperProps": {
+          "description": "Props returned by the eye dropper prop getter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"eye-dropper\"",
+              "default": ""
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": ""
+            },
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorSliderHandleProps": {
+          "description": "Props returned by the slider handle prop getter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"slider-handle\"",
+              "default": ""
+            },
+            {
+              "name": "role",
+              "type": "\"slider\"",
+              "default": ""
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": ""
+            },
+            {
+              "name": "aria-disabled",
+              "type": "boolean",
+              "default": ""
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorSwatchProps": {
+          "description": "Props returned by the swatch prop getter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputcolor\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"swatch\"",
+              "default": ""
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Style object containing CSS variable:  `--swatch-background` ."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputColorExposes": {
+          "description": "Defines the methods and properties exposed by useInputColor.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseInputColorState",
+              "default": "",
+              "description": "The state of the useInputColor."
+            },
+            {
+              "name": "value",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The current color value."
+            },
+            {
+              "name": "areaValue",
+              "type": "ColorInstance",
+              "default": "",
+              "description": "The area value of the color picker."
+            },
+            {
+              "name": "areaChannels",
+              "type": "Color2DAxes",
+              "default": "",
+              "description": "The channels of the area of the color picker."
+            },
+            {
+              "name": "setValue",
+              "type": "(value: unknown) => void",
+              "default": "",
+              "description": "Sets the value of the color picker."
+            },
+            {
+              "name": "handleAreaPointerDown",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handles the area pointer down event."
+            },
+            {
+              "name": "handleAreaPointerMove",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handles the area pointer move event."
+            },
+            {
+              "name": "handleAreaPointerUp",
+              "type": "(event: PointerEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handles the area pointer up event."
+            },
+            {
+              "name": "handleAreaBlur",
+              "type": "(event: FocusEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handles the area blur event."
+            },
+            {
+              "name": "handleAreaKeyDown",
+              "type": "(event: KeyboardEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handles the area key down event."
+            },
+            {
+              "name": "areaStyles",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "The styles of the area of the color picker."
+            },
+            {
+              "name": "swatchStyles",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "The styles of the swatch of the color picker."
+            },
+            {
+              "name": "openEyeDropper",
+              "type": "() => void",
+              "default": "",
+              "description": "Opens the eye dropper."
+            },
+            {
+              "name": "syncChannelInputs",
+              "type": "(color?: ColorInstance) => void",
+              "default": "",
+              "description": "Syncs the channel inputs."
+            },
+            {
+              "name": "registerInputEl",
+              "type": "(el: { elementRef: RefObject<HTMLInputElement> }) => void",
+              "default": "",
+              "description": "Registers an input element."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseInputColorRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "areaProps",
+              "type": "UseInputColorAreaProps",
+              "default": "",
+              "description": "Pre-built props for the area element."
+            },
+            {
+              "name": "areaHandleProps",
+              "type": "UseInputColorAreaHandleProps",
+              "default": "",
+              "description": "Pre-built props for the area handle element."
+            },
+            {
+              "name": "eyeDropperProps",
+              "type": "UseInputColorEyeDropperProps",
+              "default": "",
+              "description": "Pre-built props for the eye dropper button element."
+            },
+            {
+              "name": "sliderHandleProps",
+              "type": "UseInputColorSliderHandleProps",
+              "default": "",
+              "description": "Pre-built props for the slider handle element."
+            },
+            {
+              "name": "swatchProps",
+              "type": "UseInputColorSwatchProps",
+              "default": "",
+              "description": "Pre-built props for the swatch element."
+            },
+            {
+              "name": "getInputProps",
+              "type": "(options?: { channel?: ColorInputChannel; disabled?: boolean }) => { data-scope: \"inputcolor\"; data-part: \"input\"; type: \"number\" | \"text\"; spellCheck: boolean; autoComplete: \"off\"; disabled: boolean; data-channel: ColorInputChannel; aria-label: ColorInputChannel; min: number; max: number; step: number; channelValue: string | number; onChange: (event: ChangeEvent<HTMLInputElement>) => void; onBlur: (event: FocusEvent<HTMLInputElement>) => void; onKeyDown: (event: KeyboardEvent<HTMLInputElement>) => void }",
+              "default": "",
+              "description": "Provides input props for a color channel."
+            },
+            {
+              "name": "getSliderProps",
+              "type": "(options?: { channel?: ColorSliderChannel; orientation?: \"horizontal\" | \"vertical\"; disabled?: boolean }) => { data-scope: \"inputcolor\"; data-part: \"slider\"; data-orientation: \"horizontal\" | \"vertical\"; data-channel: ColorSliderChannel; orientation: \"horizontal\" | \"vertical\"; style: CSSProperties; value: number; min: number; max: number; step: number; disabled?: boolean; onValueChange: (event: UseSliderChangeEvent) => void; onValueChangeEnd: (event: UseSliderChangeEvent) => void }",
+              "default": "",
+              "description": "Provides slider props and styles for a color channel.\nThe returned  `style`  object contains CSS variables:  `--slider-background`  and  `--slider-handle-background` ."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseInputColorInstance": {
+          "description": "Instance of useInputColor headless.",
+          "values": "HeadlessInstance<UseInputColorProps, UseInputColorState, UseInputColorExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]