@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,455 @@
+[
+  {
+    "name": "useToast",
+    "source": "apps/showcase/assets/apidoc/usetoast.json",
+    "data": {
+      "description": "The useToast manages the state and functionality of a toast item component.",
+      "interfaces": {
+        "UseToastProps": {
+          "description": "Defines valid properties in useToast.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "toast",
+              "type": "ToastType",
+              "default": "",
+              "description": "Toast data containing all toast information"
+            },
+            {
+              "name": "toaster",
+              "type": "ToasterRootInstance",
+              "default": "",
+              "description": "Reference to the parent Toaster instance"
+            }
+          ],
+          "methods": []
+        },
+        "UseToastState": {
+          "description": "Defines valid state in useToast.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "mounted",
+              "type": "boolean",
+              "default": "",
+              "description": "Indicates whether the toast is mounted"
+            },
+            {
+              "name": "swiping",
+              "type": "boolean",
+              "default": "",
+              "description": "Indicates whether the user is swiping the toast"
+            },
+            {
+              "name": "swipeOut",
+              "type": "boolean",
+              "default": "",
+              "description": "Indicates whether the toast has been swiped out (dismissed)"
+            },
+            {
+              "name": "swipeOutDirection",
+              "type": "ToastSwipeDirection",
+              "default": "",
+              "description": "Direction of swipe out animation"
+            },
+            {
+              "name": "swipeDirection",
+              "type": "ToastSwipeAxis",
+              "default": "",
+              "description": "Direction of swipe interaction"
+            },
+            {
+              "name": "initialHeight",
+              "type": "number",
+              "default": "",
+              "description": "Measured height of the toast content"
+            },
+            {
+              "name": "removed",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the toast has been removed from the stack"
+            },
+            {
+              "name": "isSwiped",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the toast has been swiped (even if not dismissed)"
+            },
+            {
+              "name": "offsetBeforeRemove",
+              "type": "number",
+              "default": "",
+              "description": "Offset that should be preserved while the toast exits"
+            }
+          ],
+          "methods": []
+        },
+        "UseToastActionProps": {
+          "description": "Pre-built props for the toast action element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastContentProps": {
+          "description": "Pre-built props for the toast body element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastMessageProps": {
+          "description": "Pre-built props for the toast content element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastCloseProps": {
+          "description": "Pre-built props for the toast close element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler that dismisses the toast."
+            }
+          ],
+          "methods": []
+        },
+        "UseToastDescriptionProps": {
+          "description": "Pre-built props for the toast description element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastIconProps": {
+          "description": "Pre-built props for the toast icon element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastTitleProps": {
+          "description": "Pre-built props for the toast title element.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "UseToastExposes": {
+          "description": "Defines the methods and properties exposed by useToast.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "offset",
+              "type": "number",
+              "default": "",
+              "description": "Vertical offset for stacking toasts"
+            },
+            {
+              "name": "offsetBeforeRemove",
+              "type": "number",
+              "default": "",
+              "description": "Offset snapshot used during removal transitions"
+            },
+            {
+              "name": "index",
+              "type": "number",
+              "default": "",
+              "description": "Index of the toast in the stack"
+            },
+            {
+              "name": "visibleIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index among currently visible toasts"
+            },
+            {
+              "name": "isVisible",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the toast is currently visible considering the limit"
+            },
+            {
+              "name": "isFront",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the toast is in the front-most position"
+            },
+            {
+              "name": "toaster",
+              "type": "ToasterRootInstance",
+              "default": "",
+              "description": "Reference to the parent Toaster instance"
+            },
+            {
+              "name": "rootProps",
+              "type": "Record<string, unknown>",
+              "default": "",
+              "description": "Pre-built props for the root element"
+            },
+            {
+              "name": "actionProps",
+              "type": "UseToastActionProps",
+              "default": "",
+              "description": "Pre-built props for the action element"
+            },
+            {
+              "name": "contentProps",
+              "type": "UseToastContentProps",
+              "default": "",
+              "description": "Pre-built props for the body element"
+            },
+            {
+              "name": "closeProps",
+              "type": "UseToastCloseProps",
+              "default": "",
+              "description": "Pre-built props for the close element"
+            },
+            {
+              "name": "messageProps",
+              "type": "UseToastMessageProps",
+              "default": "",
+              "description": "Pre-built props for the content element"
+            },
+            {
+              "name": "descriptionProps",
+              "type": "UseToastDescriptionProps",
+              "default": "",
+              "description": "Pre-built props for the description element"
+            },
+            {
+              "name": "iconProps",
+              "type": "UseToastIconProps",
+              "default": "",
+              "description": "Pre-built props for the icon element"
+            },
+            {
+              "name": "titleProps",
+              "type": "UseToastTitleProps",
+              "default": "",
+              "description": "Pre-built props for the title element"
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handler for pointer down events (swipe start)"
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Handler for pointer move events (swipe progress)"
+            },
+            {
+              "name": "onPointerUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for pointer up events (swipe end)"
+            },
+            {
+              "name": "onDragEnd",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for drag end events"
+            },
+            {
+              "name": "handleCloseOnClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for close button click"
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseToastInstance": {
+          "description": "Instance of useToast headless.",
+          "values": "HeadlessInstance<UseToastProps, UseToastState, UseToastExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "useToaster",
+    "source": "apps/showcase/assets/apidoc/usetoaster.json",
+    "data": {
+      "description": "The useToast manages the state and functionality of a toast component.",
+      "interfaces": {
+        "UseToasterProps": {
+          "description": "Defines valid properties in useToaster.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "position",
+              "type": "ToasterPosition",
+              "default": "'top-right'",
+              "description": "Position of the toaster container"
+            },
+            {
+              "name": "mode",
+              "type": "ToasterMode",
+              "default": "'stacked'",
+              "description": "Layout mode of the toaster."
+            },
+            {
+              "name": "limit",
+              "type": "number",
+              "default": "3",
+              "description": "Maximum number of toasts to be visible"
+            },
+            {
+              "name": "gap",
+              "type": "number",
+              "default": "14",
+              "description": "Gap between toasts in pixels"
+            },
+            {
+              "name": "timeout",
+              "type": "number",
+              "default": "6000",
+              "description": "Timeout for toast auto-dismiss (alias for duration)"
+            },
+            {
+              "name": "group",
+              "type": "string",
+              "default": "",
+              "description": "Group identifier for toast grouping"
+            }
+          ],
+          "methods": []
+        },
+        "UseToasterState": {
+          "description": "Defines valid state in useToaster.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "isExpanded",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the toaster container is expanded (showing all toasts).\nIn  `single`  mode this is always true; in  `stacked`  mode it follows hover/focus."
+            },
+            {
+              "name": "isHovered",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the user is currently hovering or has focus within the toast region.\nUsed to pause auto-dismiss timers independently of the visual expanded state."
+            },
+            {
+              "name": "isInteracting",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether user is currently interacting with toasts"
+            },
+            {
+              "name": "heights",
+              "type": "{ toastId: ToastId; height: number }[]",
+              "default": "",
+              "description": "Cached heights of rendered toasts for stacking calculations"
+            }
+          ],
+          "methods": []
+        },
+        "UseToasterExposes": {
+          "description": "Defines the methods and properties exposed by useToaster.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "toasts",
+              "type": "ToastType[]",
+              "default": "",
+              "description": "Array of filtered toasts for the current group"
+            },
+            {
+              "name": "rootProps",
+              "type": "Record<string, unknown>",
+              "default": "",
+              "description": "Pre-built props for the toaster root element"
+            },
+            {
+              "name": "regionProps",
+              "type": "Record<string, unknown>",
+              "default": "",
+              "description": "Pre-built props for the toaster region element"
+            },
+            {
+              "name": "onRegionMouseEnter",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for mouse enter on the toast region"
+            },
+            {
+              "name": "onRegionMouseMove",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for mouse move on the toast region"
+            },
+            {
+              "name": "onRegionMouseLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for mouse leave on the toast region"
+            },
+            {
+              "name": "onRegionDragEnd",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for drag end on the toast region"
+            },
+            {
+              "name": "onRegionPointerDown",
+              "type": "(event: PointerEvent) => void",
+              "default": "",
+              "description": "Handler for pointer down on the toast region"
+            },
+            {
+              "name": "onRegionPointerUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for pointer up on the toast region"
+            },
+            {
+              "name": "onRegionFocus",
+              "type": "(event: FocusEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handler for focus events within the toast region"
+            },
+            {
+              "name": "onRegionBlur",
+              "type": "(event: FocusEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Handler for blur events leaving the toast region"
+            },
+            {
+              "name": "setHeights",
+              "type": "Dispatch<SetStateAction<{ height: number; toastId: ToastId }[]>>",
+              "default": "",
+              "description": "Function to update the heights state"
+            },
+            {
+              "name": "removeFromQueue",
+              "type": "(id: ToastId) => void",
+              "default": "",
+              "description": "Marks a toast as removed in the toaster's local queue. Called by the\nper-toast hook after its exit animation completes; the toast is then\nfiltered out of the rendered list."
+            },
+            {
+              "name": "handleFocusManagement",
+              "type": "(toastElement: HTMLElement) => void",
+              "default": "",
+              "description": "Handler for managing focus when a toast is dismissed"
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseToasterInstance": {
+          "description": "Instance of useToast headless.",
+          "values": "HeadlessInstance<UseToasterProps, UseToasterState, UseToasterExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]