@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,582 @@
+[
+  {
+    "name": "useSplitter",
+    "source": "apps/showcase/assets/apidoc/usesplitter.json",
+    "data": {
+      "description": "The useSplitter manages the functionality of a splitter component.",
+      "interfaces": {
+        "UseSplitterPanelInfo": {
+          "description": "Information about a registered panel in the splitter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The unique identifier of the panel element."
+            },
+            {
+              "name": "index",
+              "type": "number",
+              "default": "",
+              "description": "The index of the panel."
+            },
+            {
+              "name": "minSize",
+              "type": "number",
+              "default": "",
+              "description": "Minimum size of the panel relative to 100%."
+            },
+            {
+              "name": "maxSize",
+              "type": "number",
+              "default": "",
+              "description": "Maximum size of the panel relative to 100%."
+            },
+            {
+              "name": "collapsible",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the panel can be collapsed."
+            },
+            {
+              "name": "collapsedSize",
+              "type": "number",
+              "default": "",
+              "description": "Size of the panel when collapsed, relative to 100%."
+            },
+            {
+              "name": "collapsed",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the panel is currently collapsed."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterRegisterPanelProps": {
+          "description": "Props accepted by registerPanel to capture panel configuration.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The unique identifier of the panel element."
+            },
+            {
+              "name": "minSize",
+              "type": "number",
+              "default": "",
+              "description": "Minimum size of the panel relative to 100%."
+            },
+            {
+              "name": "maxSize",
+              "type": "number",
+              "default": "",
+              "description": "Maximum size of the panel relative to 100%."
+            },
+            {
+              "name": "collapsible",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the panel can be collapsed when resized below minSize."
+            },
+            {
+              "name": "collapsedSize",
+              "type": "number",
+              "default": "",
+              "description": "Size of the panel when collapsed, relative to 100%."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterResizeEvent": {
+          "description": "Event data passed to splitter resize callbacks.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "sizes",
+              "type": "number[]",
+              "default": "",
+              "description": "Array of panel sizes as percentages."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterCollapseEvent": {
+          "description": "Event data passed to splitter collapse callbacks.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "index",
+              "type": "number",
+              "default": "",
+              "description": "Index of the panel that collapsed or expanded."
+            },
+            {
+              "name": "collapsed",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the panel is now collapsed."
+            },
+            {
+              "name": "sizes",
+              "type": "number[]",
+              "default": "",
+              "description": "Array of panel sizes as percentages."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterPanelConfig": {
+          "description": "Declarative panel configuration for headless usage.\nWhen provided via the  `panels`  prop, eliminates the need for  `registerPanel` .",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "minSize",
+              "type": "number",
+              "default": "0",
+              "description": "Minimum size of the panel relative to 100%."
+            },
+            {
+              "name": "maxSize",
+              "type": "number",
+              "default": "100",
+              "description": "Maximum size of the panel relative to 100%."
+            },
+            {
+              "name": "collapsible",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the panel can be collapsed when resized below minSize."
+            },
+            {
+              "name": "collapsedSize",
+              "type": "number",
+              "default": "0",
+              "description": "Size of the panel when collapsed, relative to 100%."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterProps": {
+          "description": "Defines valid properties in useSplitter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "panels",
+              "type": "UseSplitterPanelConfig[]",
+              "default": "",
+              "description": "Declarative panel configuration array. When provided, the hook auto-registers\npanels from this config — no  `registerPanel`  calls needed.\nEach entry defines constraints for the panel at that index."
+            },
+            {
+              "name": "sizes",
+              "type": "number[]",
+              "default": "",
+              "description": "Controlled panel sizes as percentages (must sum to ~100).\nWhen provided, the splitter operates in controlled mode — sizes are driven by this prop\nand should be updated via onResize or onResizeEnd callbacks."
+            },
+            {
+              "name": "defaultSizes",
+              "type": "number[]",
+              "default": "",
+              "description": "Default initial panel sizes as percentages (must sum to ~100).\nUsed for uncontrolled mode — sets the initial sizes on mount, after which internal state takes over."
+            },
+            {
+              "name": "orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "horizontal",
+              "description": "Orientation of the panels."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When true, disables all resize interactions."
+            },
+            {
+              "name": "step",
+              "type": "number",
+              "default": "5",
+              "description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys."
+            },
+            {
+              "name": "onResizeStart",
+              "type": "(event: UseSplitterResizeEvent) => void",
+              "default": "",
+              "description": "Callback invoked when resize starts."
+            },
+            {
+              "name": "onResize",
+              "type": "(event: UseSplitterResizeEvent) => void",
+              "default": "",
+              "description": "Callback invoked during resize with current panel sizes."
+            },
+            {
+              "name": "onResizeEnd",
+              "type": "(event: UseSplitterResizeEvent) => void",
+              "default": "",
+              "description": "Callback invoked when resize ends."
+            },
+            {
+              "name": "onCollapse",
+              "type": "(event: UseSplitterCollapseEvent) => void",
+              "default": "",
+              "description": "Callback invoked when a panel collapses or expands."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterState": {
+          "description": "Defines valid state in useSplitter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "resizing",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the splitter is currently being resized."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterExposes": {
+          "description": "Defines the methods and properties exposed by useSplitter.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseSplitterState",
+              "default": "",
+              "description": "The state of the useSplitter."
+            },
+            {
+              "name": "registerPanel",
+              "type": "(index: number, panelProps: UseSplitterRegisterPanelProps) => number",
+              "default": "",
+              "description": "Registers a new panel or updates an existing one."
+            },
+            {
+              "name": "panelCounter",
+              "type": "RefObject<number>",
+              "default": "",
+              "description": "Counter tracking the number of registered panels."
+            },
+            {
+              "name": "panelRegistry",
+              "type": "RefObject<UseSplitterPanelInfo[]>",
+              "default": "",
+              "description": "Registry of panel info objects."
+            },
+            {
+              "name": "panelSizes",
+              "type": "number[]",
+              "default": "",
+              "description": "Array storing the current size of each panel as percentages."
+            },
+            {
+              "name": "onResizeStart",
+              "type": "(event: KeyboardEvent | PointerEvent<Element>, index: number, isKeyDown?: boolean) => void",
+              "default": "",
+              "description": "Handler for resize start events."
+            },
+            {
+              "name": "onResize",
+              "type": "(event: KeyboardEvent | PointerEvent<Element>, step?: number, isKeyDown?: boolean) => void",
+              "default": "",
+              "description": "Handler for resize events."
+            },
+            {
+              "name": "onResizeEnd",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for resize end events."
+            },
+            {
+              "name": "onGutterPointerDown",
+              "type": "(event: PointerEvent, index: number, gutterDisabled?: boolean) => void",
+              "default": "",
+              "description": "Handler for pointer down events on gutters."
+            },
+            {
+              "name": "onGutterKeyUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for key up events on gutters."
+            },
+            {
+              "name": "onGutterKeyDown",
+              "type": "(event: KeyboardEvent, index: number, gutterDisabled?: boolean) => void",
+              "default": "",
+              "description": "Handler for key down events on gutters."
+            },
+            {
+              "name": "registerGutter",
+              "type": "() => number",
+              "default": "",
+              "description": "Registers a new gutter and returns its index.\nUsed internally by compound components. Guard with a ref to prevent double-registration in StrictMode."
+            },
+            {
+              "name": "getGutterProps",
+              "type": "(index: number, options?: { id?: string; disabled?: boolean }) => UseSplitterGutterProps",
+              "default": "",
+              "description": "Returns pre-built props for a gutter element."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseSplitterRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            },
+            {
+              "name": "getPanelProps",
+              "type": "(index: number) => UseSplitterPanelProps",
+              "default": "",
+              "description": "Returns pre-built data attribute and style props for a panel element.\nFlex grow is computed internally from panelSizes."
+            },
+            {
+              "name": "handleProps",
+              "type": "UseSplitterHandleProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the handle element."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterRootProps": {
+          "description": "Pre-built data attribute props for the splitter root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLDivElement>",
+              "default": "",
+              "description": "Ref callback for the root element."
+            },
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-resizing",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the splitter is being resized."
+            },
+            {
+              "name": "data-disabled",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the splitter is disabled."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterPanelProps": {
+          "description": "Pre-built data attribute props for a splitter panel element.",
+          "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": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-index",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for panel index."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style containing the flex grow value."
+            },
+            {
+              "name": "data-resizing",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the splitter is being resized."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterHandleProps": {
+          "description": "Pre-built data attribute props for a splitter handle element.",
+          "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": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-resizing",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the splitter is being resized."
+            }
+          ],
+          "methods": []
+        },
+        "UseSplitterGutterProps": {
+          "description": "Pre-built props for a splitter gutter element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Optional element id."
+            },
+            {
+              "name": "role",
+              "type": "\"separator\"",
+              "default": "",
+              "description": "ARIA role for the gutter separator."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index (0 when active, -1 when disabled)."
+            },
+            {
+              "name": "aria-valuenow",
+              "type": "number",
+              "default": "",
+              "description": "Current panel size as a percentage."
+            },
+            {
+              "name": "aria-valuemin",
+              "type": "number",
+              "default": "",
+              "description": "Minimum panel size as a percentage."
+            },
+            {
+              "name": "aria-valuemax",
+              "type": "number",
+              "default": "",
+              "description": "Maximum panel size as a percentage."
+            },
+            {
+              "name": "aria-controls",
+              "type": "string",
+              "default": "",
+              "description": "Space-separated panel ids this gutter controls."
+            },
+            {
+              "name": "aria-disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the gutter is disabled."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Base layout styles for the gutter element."
+            },
+            {
+              "name": "data-orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-resizing",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the splitter is being resized."
+            },
+            {
+              "name": "data-disabled",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the gutter is disabled."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent) => void",
+              "default": "",
+              "description": "Pointer down handler."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent) => void",
+              "default": "",
+              "description": "Key down handler."
+            },
+            {
+              "name": "onKeyUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Key up handler."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseSplitterInstance": {
+          "description": "Instance of useSplitter headless.",
+          "values": "HeadlessInstance<UseSplitterProps, UseSplitterState, UseSplitterExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]