@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,730 @@
+[
+  {
+    "name": "useScrollArea",
+    "source": "apps/showcase/assets/apidoc/usescrollarea.json",
+    "data": {
+      "description": "The useScrollArea manages the state and functionality of a scrollarea component.",
+      "interfaces": {
+        "UseScrollAreaProps": {
+          "description": "Defines valid properties in useScrollArea.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "step",
+              "type": "number",
+              "default": "5",
+              "description": "Step factor to scroll the content while pressing the arrow keys."
+            },
+            {
+              "name": "variant",
+              "type": "\"hidden\" | \"auto\" | \"always\" | \"scroll\" | \"hover\"",
+              "default": "'auto'",
+              "description": "Controls scrollbar visibility behavior."
+            },
+            {
+              "name": "mask",
+              "type": "boolean",
+              "default": "false",
+              "description": "When enabled, a fade mask is applied to the viewport edges to indicate overflow."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "0",
+              "description": "Tab index for the viewport element to make it keyboard focusable."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaHiddenState": {
+          "description": "Defines the hidden state of scrollbar axes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "x",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the horizontal scrollbar is hidden (no horizontal overflow)."
+            },
+            {
+              "name": "y",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the vertical scrollbar is hidden (no vertical overflow)."
+            },
+            {
+              "name": "corner",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the corner element is hidden (at least one axis has no overflow)."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaState": {
+          "description": "Defines valid state in useScrollArea.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "hovering",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the pointer is hovering over the scroll area."
+            },
+            {
+              "name": "scrollingX",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the content is actively scrolling horizontally."
+            },
+            {
+              "name": "scrollingY",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the content is actively scrolling vertically."
+            },
+            {
+              "name": "scrolling",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the content is actively scrolling in any direction."
+            },
+            {
+              "name": "touchModality",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether touch input modality is active."
+            },
+            {
+              "name": "hasOverflowX",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the content overflows the viewport horizontally."
+            },
+            {
+              "name": "hasOverflowY",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the content overflows the viewport vertically."
+            },
+            {
+              "name": "scrollXBefore",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the viewport is scrolled past the left edge."
+            },
+            {
+              "name": "scrollXAfter",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether content remains to the right of the viewport."
+            },
+            {
+              "name": "scrollYBefore",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the viewport is scrolled past the top edge."
+            },
+            {
+              "name": "scrollYAfter",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether content remains below the viewport."
+            },
+            {
+              "name": "cornerHidden",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the corner element is hidden."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaRootProps": {
+          "description": "Pre-built props for the root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref to the root DOM element."
+            },
+            {
+              "name": "role",
+              "type": "\"presentation\"",
+              "default": "",
+              "description": "ARIA role for the root element."
+            },
+            {
+              "name": "onPointerEnter",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer enter event handler for hover detection."
+            },
+            {
+              "name": "onPointerLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer leave event handler for hover detection."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down event handler for touch modality detection."
+            },
+            {
+              "name": "data-variant",
+              "type": "string",
+              "default": "",
+              "description": "Current scrollbar visibility variant."
+            },
+            {
+              "name": "data-mask",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the mask prop is enabled."
+            },
+            {
+              "name": "data-scrolling",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content is actively scrolling."
+            },
+            {
+              "name": "data-has-overflow-x",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows horizontally."
+            },
+            {
+              "name": "data-has-overflow-y",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows vertically."
+            },
+            {
+              "name": "data-scroll-x-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the left edge."
+            },
+            {
+              "name": "data-scroll-x-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains to the right of the viewport."
+            },
+            {
+              "name": "data-scroll-y-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the top edge."
+            },
+            {
+              "name": "data-scroll-y-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains below the viewport."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style with position and CSS custom properties for corner dimensions."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaViewportProps": {
+          "description": "Pre-built props for the viewport element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"viewport\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref to the viewport DOM element."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation. Undefined when there is no overflow."
+            },
+            {
+              "name": "onScroll",
+              "type": "() => void",
+              "default": "",
+              "description": "Scroll event handler that updates handle position and scroll state."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style for native scrollbar suppression and overflow."
+            },
+            {
+              "name": "data-scrolling",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content is actively scrolling."
+            },
+            {
+              "name": "data-has-overflow-x",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows horizontally."
+            },
+            {
+              "name": "data-has-overflow-y",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows vertically."
+            },
+            {
+              "name": "data-scroll-x-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the left edge."
+            },
+            {
+              "name": "data-scroll-x-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains to the right of the viewport."
+            },
+            {
+              "name": "data-scroll-y-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the top edge."
+            },
+            {
+              "name": "data-scroll-y-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains below the viewport."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaContentProps": {
+          "description": "Pre-built props for the content element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"content\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style with min-width / min-height for overflowing content."
+            },
+            {
+              "name": "data-scrolling",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content is actively scrolling."
+            },
+            {
+              "name": "data-has-overflow-x",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows horizontally."
+            },
+            {
+              "name": "data-has-overflow-y",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows vertically."
+            },
+            {
+              "name": "data-scroll-x-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the left edge."
+            },
+            {
+              "name": "data-scroll-x-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains to the right of the viewport."
+            },
+            {
+              "name": "data-scroll-y-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the top edge."
+            },
+            {
+              "name": "data-scroll-y-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains below the viewport."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaScrollbarProps": {
+          "description": "Pre-built props for a scrollbar element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"scrollbar-y\" | \"scrollbar-x\"",
+              "default": "",
+              "description": "Component part identifier based on orientation."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Scrollbar orientation."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref to the scrollbar DOM element."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down event handler for track click scrolling."
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer move event handler for drag scrolling."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer up event handler that ends drag scrolling."
+            },
+            {
+              "name": "onWheel",
+              "type": "(event: WheelEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Wheel event handler for scrolling via mouse wheel on the scrollbar."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style with absolute positioning and pointer/selection behavior."
+            },
+            {
+              "name": "data-hovering",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the pointer is hovering over the scroll area."
+            },
+            {
+              "name": "data-scrolling",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content is actively scrolling."
+            },
+            {
+              "name": "data-has-overflow-x",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows horizontally."
+            },
+            {
+              "name": "data-has-overflow-y",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the content overflows vertically."
+            },
+            {
+              "name": "data-scroll-x-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the left edge."
+            },
+            {
+              "name": "data-scroll-x-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains to the right of the viewport."
+            },
+            {
+              "name": "data-scroll-y-before",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the viewport is scrolled past the top edge."
+            },
+            {
+              "name": "data-scroll-y-after",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when content remains below the viewport."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaHandleProps": {
+          "description": "Pre-built props for a handle element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"handle-y\" | \"handle-x\"",
+              "default": "",
+              "description": "Component part identifier based on orientation."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Handle orientation."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref to the handle DOM element."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down event handler that initiates handle dragging."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style with size and transform driven by CSS custom properties."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaCornerProps": {
+          "description": "Pre-built props for the corner element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"scrollarea\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"corner\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref to the corner DOM element."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style with absolute positioning at the scrollbar intersection."
+            }
+          ],
+          "methods": []
+        },
+        "UseScrollAreaExposes": {
+          "description": "Defines the methods and properties exposed by useScrollArea.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseScrollAreaState",
+              "default": "",
+              "description": "The reactive state of the scroll area."
+            },
+            {
+              "name": "cornerSize",
+              "type": "{ width: number; height: number }",
+              "default": "",
+              "description": "Measured dimensions of the corner area where both scrollbars intersect."
+            },
+            {
+              "name": "hiddenState",
+              "type": "UseScrollAreaHiddenState",
+              "default": "",
+              "description": "Boolean flags indicating whether each scrollbar and the corner should be rendered."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseScrollAreaRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element.\nIncludes ref callback, ARIA role, pointer event handlers, data attributes, and corner CSS variables."
+            },
+            {
+              "name": "viewportProps",
+              "type": "UseScrollAreaViewportProps",
+              "default": "",
+              "description": "Pre-built props for the viewport element.\nIncludes ref callback, tabIndex, scroll handler, and data attributes."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseScrollAreaContentProps",
+              "default": "",
+              "description": "Pre-built props for the content element.\nIncludes data attributes for scroll position and overflow state."
+            },
+            {
+              "name": "scrollbarYProps",
+              "type": "UseScrollAreaScrollbarProps",
+              "default": "",
+              "description": "Pre-built props for the vertical scrollbar element."
+            },
+            {
+              "name": "scrollbarXProps",
+              "type": "UseScrollAreaScrollbarProps",
+              "default": "",
+              "description": "Pre-built props for the horizontal scrollbar element."
+            },
+            {
+              "name": "handleYProps",
+              "type": "UseScrollAreaHandleProps",
+              "default": "",
+              "description": "Pre-built props for the vertical handle element."
+            },
+            {
+              "name": "handleXProps",
+              "type": "UseScrollAreaHandleProps",
+              "default": "",
+              "description": "Pre-built props for the horizontal handle element."
+            },
+            {
+              "name": "cornerProps",
+              "type": "UseScrollAreaCornerProps",
+              "default": "",
+              "description": "Pre-built props for the corner element.\nIncludes ref callback and data attributes."
+            },
+            {
+              "name": "computeHandle",
+              "type": "() => void",
+              "default": "",
+              "description": "Recalculates handle size and position based on current scroll state."
+            },
+            {
+              "name": "handleScroll",
+              "type": "() => void",
+              "default": "",
+              "description": "Handles scroll events to update handle offset and scroll position state."
+            },
+            {
+              "name": "handleScrollbarPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>, orientation: \"horizontal\" | \"vertical\") => void",
+              "default": "",
+              "description": "Handles pointer down on the scrollbar track to jump-scroll to the clicked position."
+            },
+            {
+              "name": "handleScrollbarPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handles pointer move during scrollbar drag interaction."
+            },
+            {
+              "name": "handleScrollbarPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handles pointer up to end scrollbar drag interaction."
+            },
+            {
+              "name": "handleScrollbarWheel",
+              "type": "(event: WheelEvent<HTMLDivElement>, orientation: \"horizontal\" | \"vertical\") => void",
+              "default": "",
+              "description": "Handles wheel events on the scrollbar element."
+            },
+            {
+              "name": "handleHandlePointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>, orientation: \"horizontal\" | \"vertical\") => void",
+              "default": "",
+              "description": "Handles pointer down on the handle to initiate drag scrolling."
+            },
+            {
+              "name": "onRootPointerEnter",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handles pointer enter on the root element for hover state tracking."
+            },
+            {
+              "name": "onRootPointerLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Handles pointer leave on the root element for hover state tracking."
+            },
+            {
+              "name": "onRootPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handles pointer down on the root element for touch modality detection."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseScrollAreaInstance": {
+          "description": "Instance of useScrollArea headless.",
+          "values": "HeadlessInstance<UseScrollAreaProps, UseScrollAreaState, UseScrollAreaExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]