@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,626 @@
+[
+  {
+    "name": "useDialog",
+    "source": "apps/showcase/assets/apidoc/usedialog.json",
+    "data": {
+      "description": "The useDialog manages the state and functionality of a dialog component.",
+      "interfaces": {
+        "UseDialogChangeEvent": {
+          "description": "Event fired when the dialog's open state changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "boolean",
+              "default": "",
+              "description": "The value of the dialog."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogProps": {
+          "description": "Defines valid properties in useDialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "Specifies the visibility of the dialog."
+            },
+            {
+              "name": "defaultOpen",
+              "type": "boolean",
+              "default": "",
+              "description": "Specifies the default visibility of the dialog."
+            },
+            {
+              "name": "draggable",
+              "type": "boolean",
+              "default": "true",
+              "description": "Enables dragging to change the position using header."
+            },
+            {
+              "name": "keepInViewport",
+              "type": "boolean",
+              "default": "true",
+              "description": "Keeps dialog in the viewport."
+            },
+            {
+              "name": "minX",
+              "type": "number",
+              "default": "0",
+              "description": "Minimum value for the left coordinate of dialog in dragging."
+            },
+            {
+              "name": "minY",
+              "type": "number",
+              "default": "0",
+              "description": "Minimum value for the top coordinate of dialog in dragging."
+            },
+            {
+              "name": "trapped",
+              "type": "boolean",
+              "default": "true",
+              "description": "When enabled, focus is trapped within the dialog (modal behavior)."
+            },
+            {
+              "name": "modal",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the dialog is modal. When true, the positioner blocks pointer events behind it."
+            },
+            {
+              "name": "dismissable",
+              "type": "boolean",
+              "default": "false",
+              "description": "Specifies if clicking the modal background should hide the dialog."
+            },
+            {
+              "name": "closeOnEscape",
+              "type": "boolean",
+              "default": "true",
+              "description": "Specifies if pressing escape key should hide the dialog."
+            },
+            {
+              "name": "blockScroll",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether background scroll should be blocked when dialog is visible."
+            },
+            {
+              "name": "baseZIndex",
+              "type": "number",
+              "default": "0",
+              "description": "Base zIndex value to use in layering."
+            },
+            {
+              "name": "autoZIndex",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether to automatically manage layering."
+            },
+            {
+              "name": "appendTo",
+              "type": "\"body\" | HTMLElement | \"self\"",
+              "default": "body",
+              "description": "A valid query selector or an HTMLElement to specify where the dialog gets attached."
+            },
+            {
+              "name": "position",
+              "type": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"",
+              "default": "center",
+              "description": "Position of the dialog."
+            },
+            {
+              "name": "fullScreen",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the dialog should open in full screen (maximized) mode."
+            },
+            {
+              "name": "scrollBehavior",
+              "type": "\"outside\" | \"inside\"",
+              "default": "'inside'",
+              "description": "Defines the scroll behavior of the dialog.\nWhen set to 'inside', the dialog content area scrolls.\nWhen set to 'outside', the positioner scrolls allowing the entire dialog to scroll within the viewport."
+            },
+            {
+              "name": "onOpenChange",
+              "type": "(event: UseDialogChangeEvent) => void",
+              "default": "",
+              "description": "Callback function that is called when the trigger is clicked."
+            },
+            {
+              "name": "onExitComplete",
+              "type": "() => void",
+              "default": "",
+              "description": "Callback fired after the leave (exit) transition completes."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogState": {
+          "description": "Defines valid state in useDialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the dialog is currently open."
+            },
+            {
+              "name": "maximized",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the dialog is currently maximized."
+            },
+            {
+              "name": "trapped",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether focus is trapped within the dialog."
+            },
+            {
+              "name": "popupElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "Reference to the popup element."
+            },
+            {
+              "name": "positionerElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "Reference to the positioner element."
+            },
+            {
+              "name": "backdropElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "Reference to the backdrop element."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogTriggerProps": {
+          "description": "Props for the trigger element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "type",
+              "type": "\"button\"",
+              "default": "",
+              "description": "The button type."
+            },
+            {
+              "name": "aria-expanded",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the dialog is currently expanded/open."
+            },
+            {
+              "name": "aria-controls",
+              "type": "string",
+              "default": "",
+              "description": "The id of the dialog element this trigger controls."
+            },
+            {
+              "name": "data-open",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is open."
+            },
+            {
+              "name": "data-closed",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is closed."
+            },
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler to toggle the dialog open state."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogRootProps": {
+          "description": "Props for the root element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The id of the dialog root element."
+            },
+            {
+              "name": "data-open",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is open."
+            },
+            {
+              "name": "data-closed",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is closed."
+            },
+            {
+              "name": "data-maximized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is maximized."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogPositionerProps": {
+          "description": "Props for the positioner element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-position",
+              "type": "string",
+              "default": "",
+              "description": "The position of the dialog."
+            },
+            {
+              "name": "data-open",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is open."
+            },
+            {
+              "name": "data-closed",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is closed."
+            },
+            {
+              "name": "data-maximized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is maximized."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogBackdropProps": {
+          "description": "Props for the backdrop element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent) => void",
+              "default": "",
+              "description": "Handler for pointer down events on the backdrop."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for pointer up events on the backdrop."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogBackdropMotionProps": {
+          "description": "Component-only props for the backdrop element of the dialog (not safe for native HTML elements).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "visible",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the backdrop is visible."
+            },
+            {
+              "name": "motionProps",
+              "type": "{ name: string; appear: boolean }",
+              "default": "",
+              "description": "Motion transition properties."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogCloseProps": {
+          "description": "Props for the close button element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "ref",
+              "type": "(node: HTMLElement) => void",
+              "default": "",
+              "description": "Callback ref for the close button element."
+            },
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler to close the dialog."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogHeaderProps": {
+          "description": "Props for the header element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The id for the header element (used for aria-labelledby)."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent) => void",
+              "default": "",
+              "description": "Handler for pointer down events (drag support)."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogContentProps": {
+          "description": "Props for the content element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-maximized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is maximized."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogMaximizableProps": {
+          "description": "Props for the maximizable button element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-maximized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is maximized."
+            },
+            {
+              "name": "data-minimized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is minimized (not maximized)."
+            },
+            {
+              "name": "ref",
+              "type": "(node: HTMLElement) => void",
+              "default": "",
+              "description": "Callback ref for the maximizable button element."
+            },
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler to toggle the maximized state."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogPopupProps": {
+          "description": "Props for the popup element of the dialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The id of the dialog element."
+            },
+            {
+              "name": "ref",
+              "type": "(node: HTMLElement) => void",
+              "default": "",
+              "description": "Callback ref setter for the popup element."
+            },
+            {
+              "name": "role",
+              "type": "\"dialog\"",
+              "default": "",
+              "description": "The ARIA role for the dialog."
+            },
+            {
+              "name": "aria-labelledby",
+              "type": "string",
+              "default": "",
+              "description": "The id of the element that labels the dialog."
+            },
+            {
+              "name": "data-position",
+              "type": "string",
+              "default": "",
+              "description": "The position of the dialog."
+            },
+            {
+              "name": "data-open",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is open."
+            },
+            {
+              "name": "data-maximized",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the dialog is maximized."
+            }
+          ],
+          "methods": []
+        },
+        "UseDialogExposes": {
+          "description": "Defines the methods and properties exposed by useDialog.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseDialogState",
+              "default": "",
+              "description": "Current state of the dialog."
+            },
+            {
+              "name": "maskRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the mask element."
+            },
+            {
+              "name": "popupRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the popup element."
+            },
+            {
+              "name": "closeButtonRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the close button element."
+            },
+            {
+              "name": "maximizableButtonRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the maximizable button element."
+            },
+            {
+              "name": "triggerProps",
+              "type": "UseDialogTriggerProps",
+              "default": "",
+              "description": "Props for the trigger element."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseDialogRootProps",
+              "default": "",
+              "description": "Props for the root element."
+            },
+            {
+              "name": "positionerProps",
+              "type": "UseDialogPositionerProps",
+              "default": "",
+              "description": "Props for the positioner element."
+            },
+            {
+              "name": "backdropProps",
+              "type": "UseDialogBackdropProps",
+              "default": "",
+              "description": "Props for the backdrop element (HTML-safe)."
+            },
+            {
+              "name": "backdropMotionProps",
+              "type": "UseDialogBackdropMotionProps",
+              "default": "",
+              "description": "Component-only props for the backdrop element."
+            },
+            {
+              "name": "closeProps",
+              "type": "UseDialogCloseProps",
+              "default": "",
+              "description": "Props for the close button element."
+            },
+            {
+              "name": "headerProps",
+              "type": "UseDialogHeaderProps",
+              "default": "",
+              "description": "Props for the header element."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseDialogContentProps",
+              "default": "",
+              "description": "Props for the content element."
+            },
+            {
+              "name": "maximizableProps",
+              "type": "UseDialogMaximizableProps",
+              "default": "",
+              "description": "Props for the maximizable button element."
+            },
+            {
+              "name": "popupProps",
+              "type": "UseDialogPopupProps",
+              "default": "",
+              "description": "Props for the popup element."
+            },
+            {
+              "name": "onOpenStateChange",
+              "type": "() => void",
+              "default": "",
+              "description": "Method to change the open state of the dialog."
+            },
+            {
+              "name": "close",
+              "type": "() => void",
+              "default": "",
+              "description": "Method to close the dialog."
+            },
+            {
+              "name": "toggleMaximized",
+              "type": "() => void",
+              "default": "",
+              "description": "Method to toggle maximized state."
+            },
+            {
+              "name": "onMaskMouseDown",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Handler for mask mouse down events."
+            },
+            {
+              "name": "onMaskMouseUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for mask mouse up events."
+            },
+            {
+              "name": "onDragStart",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Handler for drag start events."
+            },
+            {
+              "name": "focusTrap",
+              "type": "UseFocusTrapExposes",
+              "default": "",
+              "description": "Focus trap exposes for sentinel rendering when trapped is true."
+            },
+            {
+              "name": "setRendered",
+              "type": "(rendered: boolean) => void",
+              "default": "",
+              "description": "Sets the rendered state of the dialog."
+            },
+            {
+              "name": "onOpenComplete",
+              "type": "() => void",
+              "default": "",
+              "description": "Callback to invoke after the dialog open animation completes.\nHandles focus behavior internally."
+            },
+            {
+              "name": "onCloseComplete",
+              "type": "() => void",
+              "default": "",
+              "description": "Callback to invoke after the dialog close animation completes."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseDialogInstance": {
+          "description": "Instance of useDialog headless.",
+          "values": "HeadlessInstance<UseDialogProps, UseDialogState, UseDialogExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]