@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,559 @@
+[
+  {
+    "name": "useSlider",
+    "source": "apps/showcase/assets/apidoc/useslider.json",
+    "data": {
+      "description": "The useSlider manages the state and functionality of a slider component.",
+      "interfaces": {
+        "UseSliderChangeEvent": {
+          "description": "Event fired when the Slider's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "number | number[]",
+              "default": "",
+              "description": "The pressed state of the ToggleButton."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderProps": {
+          "description": "Defines valid properties in useSlider.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number | number[]",
+              "default": "",
+              "description": "Value of the component."
+            },
+            {
+              "name": "defaultValue",
+              "type": "number | number[]",
+              "default": "",
+              "description": "The default value for the input when not controlled by  `value` ."
+            },
+            {
+              "name": "min",
+              "type": "number",
+              "default": "0",
+              "description": "Mininum boundary value."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "100",
+              "description": "Maximum boundary value."
+            },
+            {
+              "name": "orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "horizontal",
+              "description": "Orientation of the slider."
+            },
+            {
+              "name": "step",
+              "type": "number",
+              "default": "1",
+              "description": "Step factor to increment/decrement the value."
+            },
+            {
+              "name": "minStepsBetweenHandles",
+              "type": "number",
+              "default": "0",
+              "description": "Minimum steps between handles."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseSliderChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the ToggleButton's pressed state changes."
+            },
+            {
+              "name": "onValueChangeEnd",
+              "type": "(event: UseSliderChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the pointer interaction ends."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component is disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component is read-only."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be invalid."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback to invoke when a handle input receives focus."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback to invoke when a handle input loses focus."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderState": {
+          "description": "Defines valid state in useSlider.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number | number[]",
+              "default": "",
+              "description": "Value of the component."
+            },
+            {
+              "name": "isDragging",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the slider is being dragged."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderRootProps": {
+          "description": "Pre-built props for the slider root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "ref",
+              "type": "(node: HTMLDivElement) => void",
+              "default": "",
+              "description": "Ref callback for the root element."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down handler for the track."
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer move handler for the track."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer up handler for the track."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            },
+            {
+              "name": "data-dragging",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when dragging."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Structural style for the root element."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderTrackProps": {
+          "description": "Pre-built props for the slider track element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            },
+            {
+              "name": "data-dragging",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when dragging."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Structural style for the track element."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderRangeProps": {
+          "description": "Pre-built props for the slider range element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            },
+            {
+              "name": "data-dragging",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when dragging."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Computed style for the range element (position and size)."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderHandleProps": {
+          "description": "Pre-built props for a slider handle element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down handler for the handle."
+            },
+            {
+              "name": "data-index",
+              "type": "number",
+              "default": "",
+              "description": "The handle index."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            },
+            {
+              "name": "data-dragging",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute when dragging."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Computed style for the handle element (position)."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderHiddenInputProps": {
+          "description": "Pre-built props for a visually hidden slider input element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"slider\"",
+              "default": ""
+            },
+            {
+              "name": "data-part",
+              "type": "\"hidden-input\"",
+              "default": ""
+            },
+            {
+              "name": "type",
+              "type": "\"range\"",
+              "default": "",
+              "description": "Input type."
+            },
+            {
+              "name": "min",
+              "type": "number",
+              "default": "",
+              "description": "Minimum value."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "",
+              "description": "Maximum value."
+            },
+            {
+              "name": "step",
+              "type": "number",
+              "default": "",
+              "description": "Step value."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "Current value."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is read-only."
+            },
+            {
+              "name": "aria-valuemin",
+              "type": "number",
+              "default": "",
+              "description": "Minimum ARIA value."
+            },
+            {
+              "name": "aria-valuemax",
+              "type": "number",
+              "default": "",
+              "description": "Maximum ARIA value."
+            },
+            {
+              "name": "aria-valuenow",
+              "type": "number",
+              "default": "",
+              "description": "Current ARIA value."
+            },
+            {
+              "name": "aria-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "ARIA orientation."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "SR-only style to visually hide the input while keeping it accessible."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change handler."
+            },
+            {
+              "name": "onInput",
+              "type": "(event: FormEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Input handler."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Focus handler."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Blur handler."
+            }
+          ],
+          "methods": []
+        },
+        "UseSliderExposes": {
+          "description": "Defines the methods and properties exposed by useSlider.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseSliderState",
+              "default": "",
+              "description": "The state of the useSlider."
+            },
+            {
+              "name": "range",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Determines if the slider is in range mode."
+            },
+            {
+              "name": "getHandleValue",
+              "type": "(index: number) => number",
+              "default": "",
+              "description": "Returns the value for a specific handle."
+            },
+            {
+              "name": "getValuePercent",
+              "type": "(value: number) => number",
+              "default": "",
+              "description": "Returns the percentage (0-100) for a given value within the slider's min/max range."
+            },
+            {
+              "name": "setRootRef",
+              "type": "(node: HTMLDivElement) => void",
+              "default": "",
+              "description": "Sets the root element ref."
+            },
+            {
+              "name": "onTrackPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer handlers for the root element."
+            },
+            {
+              "name": "onTrackPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer handlers for the root element."
+            },
+            {
+              "name": "onTrackPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer handlers for the root element."
+            },
+            {
+              "name": "updateValueFromPointer",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Updates value from a pointer position without dragging."
+            },
+            {
+              "name": "onHandlePointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>, index: number) => void",
+              "default": "",
+              "description": "Pointer handlers for handles."
+            },
+            {
+              "name": "onInputChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>, index: number) => void",
+              "default": "",
+              "description": "Input change handler for handles."
+            },
+            {
+              "name": "onInputFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>, index: number) => void",
+              "default": "",
+              "description": "Input focus handler for handles."
+            },
+            {
+              "name": "onInputBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>, index: number) => void",
+              "default": "",
+              "description": "Input blur handler for handles."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseSliderRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "trackProps",
+              "type": "UseSliderTrackProps",
+              "default": "",
+              "description": "Pre-built props for the track element."
+            },
+            {
+              "name": "getRangeProps",
+              "type": "() => UseSliderRangeProps",
+              "default": "",
+              "description": "Returns pre-built props for the range element."
+            },
+            {
+              "name": "getHandleProps",
+              "type": "(index: number) => UseSliderHandleProps",
+              "default": "",
+              "description": "Returns pre-built props for a handle element at the given index."
+            },
+            {
+              "name": "getHiddenInputProps",
+              "type": "(index: number) => UseSliderHiddenInputProps",
+              "default": "",
+              "description": "Returns pre-built props for a visually hidden input element at the given index."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseSliderInstance": {
+          "description": "Instance of useSlider headless.",
+          "values": "HeadlessInstance<UseSliderProps, UseSliderState, UseSliderExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]