@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,793 @@
+[
+  {
+    "name": "useCarousel",
+    "source": "apps/showcase/assets/apidoc/usecarousel.json",
+    "data": {
+      "description": "The useCarousel manages the state and functionality of a Carousel component.",
+      "interfaces": {
+        "UseCarouselChangeEvent": {
+          "description": "Event fired when the carousel's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "Event | SyntheticEvent<Element, Event>",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "string | number",
+              "default": "",
+              "description": "The value of the carousel."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselProps": {
+          "description": "Defines valid properties in useCarousel.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "autoSize",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the carousel should auto size."
+            },
+            {
+              "name": "orientation",
+              "type": "\"horizontal\" | \"vertical\"",
+              "default": "'horizontal'",
+              "description": "Orientation of the carousel."
+            },
+            {
+              "name": "align",
+              "type": "\"center\" | \"start\" | \"end\"",
+              "default": "'center'",
+              "description": "Alignment of the carousel items."
+            },
+            {
+              "name": "loop",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the carousel should loop."
+            },
+            {
+              "name": "snapType",
+              "type": "\"mandatory\" | \"proximity\"",
+              "default": "'mandatory'",
+              "description": "Scroll snap type applied to the track."
+            },
+            {
+              "name": "spacing",
+              "type": "number",
+              "default": "16",
+              "description": "Spacing between carousel items."
+            },
+            {
+              "name": "slidesPerPage",
+              "type": "number",
+              "default": "1",
+              "description": "How many slides are visible per page. Supports fractions (e.g. 1.5)."
+            },
+            {
+              "name": "page",
+              "type": "number",
+              "default": "undefined",
+              "description": "Index of the active slide."
+            },
+            {
+              "name": "defaultPage",
+              "type": "number",
+              "default": "0",
+              "description": "Default index of the active slide."
+            },
+            {
+              "name": "slide",
+              "type": "number",
+              "default": "undefined",
+              "description": "Index of the active slide."
+            },
+            {
+              "name": "onPageChange",
+              "type": "(event: UseCarouselChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the carousel's page changes."
+            },
+            {
+              "name": "onSlideChange",
+              "type": "(event: UseCarouselChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the active slide (by value) changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselState": {
+          "description": "Defines valid state in useCarousel.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "isPrevDisabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the \"previous\" navigation button should be disabled."
+            },
+            {
+              "name": "isNextDisabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the \"next\" navigation button should be disabled."
+            },
+            {
+              "name": "snapPoints",
+              "type": "Set<number>",
+              "default": "",
+              "description": "The snap points of the carousel."
+            },
+            {
+              "name": "page",
+              "type": "number",
+              "default": "",
+              "description": "The current page of the carousel."
+            },
+            {
+              "name": "swiping",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the user is currently swiping the carousel by touch."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselRootProps": {
+          "description": "Pre-built props for the carousel root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "role",
+              "type": "\"region\"",
+              "default": "",
+              "description": "ARIA role — a labelled carousel is a  `region`  landmark."
+            },
+            {
+              "name": "aria-roledescription",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Describes the region as a carousel to assistive technology."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard focus."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent) => void",
+              "default": "",
+              "description": "Keydown handler for carousel navigation."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "data-autosize",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when auto size is enabled."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselContentCSSProperties": {
+          "description": "CSS custom properties set on the content element's style.\n\nThese variables are consumed by item elements for sizing and layout.",
+          "relatedProp": "",
+          "extendedTypes": "CSSProperties",
+          "props": [
+            {
+              "name": "--px-slides-per-page",
+              "type": "number",
+              "default": "",
+              "description": "Number of slides visible per page. Used by items to calculate their flex-basis."
+            },
+            {
+              "name": "--px-spacing-items",
+              "type": "string",
+              "default": "",
+              "description": "Spacing between carousel items in pixels. Used for gap and item size calculations."
+            },
+            {
+              "name": "--px-scroll-snap-type",
+              "type": "string",
+              "default": "",
+              "description": "The resolved scroll-snap-type value based on orientation and snap behavior."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselContentProps": {
+          "description": "Pre-built props for the carousel content (track) element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"content\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-autosize",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when auto size is enabled."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer down handler for the content element."
+            },
+            {
+              "name": "onPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer move handler for the content element."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Pointer up handler for the content element."
+            },
+            {
+              "name": "onWheel",
+              "type": "(event: WheelEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Wheel handler for the content element."
+            },
+            {
+              "name": "style",
+              "type": "UseCarouselContentCSSProperties",
+              "default": "",
+              "description": "Structural style including CSS custom properties for layout."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselItemProps": {
+          "description": "Pre-built props for a carousel item element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "role",
+              "type": "\"group\"",
+              "default": "",
+              "description": "ARIA role for the slide."
+            },
+            {
+              "name": "aria-roledescription",
+              "type": "\"slide\"",
+              "default": "",
+              "description": "Describes the element as a slide to assistive technology."
+            },
+            {
+              "name": "aria-label",
+              "type": "string",
+              "default": "",
+              "description": "Positional accessible name (e.g. \"2 / 5\") when index/total are provided."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"item\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "data-value",
+              "type": "unknown",
+              "default": "",
+              "description": "Data attribute for the item's value/identifier."
+            },
+            {
+              "name": "data-item",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute marking this element as a carousel item."
+            },
+            {
+              "name": "data-inview",
+              "type": "\"false\"",
+              "default": "",
+              "description": "Data attribute indicating whether the item is currently in view."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "data-autosize",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when auto size is enabled."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Structural style for the item element (sizing and layout)."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselNextProps": {
+          "description": "Pre-built props for the carousel next navigation button.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"next\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "type",
+              "type": "\"button\"",
+              "default": "",
+              "description": "Button type."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the button is disabled."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click handler to navigate to the next page."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselPrevProps": {
+          "description": "Pre-built props for the carousel previous navigation button.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"prev\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "type",
+              "type": "\"button\"",
+              "default": "",
+              "description": "Button type."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the button is disabled."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Data attribute when disabled."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click handler to navigate to the previous page."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselIndicatorProps": {
+          "description": "Pre-built props for a carousel indicator element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"indicator\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "type",
+              "type": "\"button\"",
+              "default": "",
+              "description": "Button type."
+            },
+            {
+              "name": "aria-current",
+              "type": "true",
+              "default": "",
+              "description": "Marks the indicator of the current page."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-active",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the indicator is active."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click handler to navigate to the indicator's page."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselIndicatorsProps": {
+          "description": "Pre-built props for the carousel indicators container element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"carousel\"",
+              "default": "",
+              "description": "Data attribute for scope identification."
+            },
+            {
+              "name": "data-part",
+              "type": "\"indicators\"",
+              "default": "",
+              "description": "Data attribute for part identification."
+            },
+            {
+              "name": "data-orientation",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for orientation."
+            },
+            {
+              "name": "data-align",
+              "type": "string",
+              "default": "",
+              "description": "Data attribute for alignment."
+            },
+            {
+              "name": "data-page",
+              "type": "number",
+              "default": "",
+              "description": "Data attribute for the current page index."
+            },
+            {
+              "name": "data-swiping",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when the user is swiping."
+            }
+          ],
+          "methods": []
+        },
+        "UseCarouselExposes": {
+          "description": "Defines the methods and properties exposed by useCarousel.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseCarouselState",
+              "default": "",
+              "description": "The state of the useCarousel."
+            },
+            {
+              "name": "slidesPerPage",
+              "type": "number",
+              "default": "",
+              "description": "Number of slides displayed per page."
+            },
+            {
+              "name": "prev",
+              "type": "(originalEvent?: Event | SyntheticEvent<Element, Event>) => void",
+              "default": "",
+              "description": "Navigates to the previous slide."
+            },
+            {
+              "name": "next",
+              "type": "(originalEvent?: Event | SyntheticEvent<Element, Event>) => void",
+              "default": "",
+              "description": "Navigates to the next slide."
+            },
+            {
+              "name": "scrollTo",
+              "type": "(value: number) => void",
+              "default": "",
+              "description": "Scrolls to the specified value."
+            },
+            {
+              "name": "scrollToPage",
+              "type": "(page: number) => void",
+              "default": "",
+              "description": "Scrolls to the specified page."
+            },
+            {
+              "name": "scrollToSlide",
+              "type": "(slide: number) => void",
+              "default": "",
+              "description": "Scrolls to the specified slide value."
+            },
+            {
+              "name": "setToClosest",
+              "type": "() => void",
+              "default": "",
+              "description": "Scrolls to the closest snap point."
+            },
+            {
+              "name": "onContentPointerDown",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Event handler for content pointer down."
+            },
+            {
+              "name": "onContentPointerMove",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Event handler for content pointer move."
+            },
+            {
+              "name": "onContentPointerUp",
+              "type": "(event: PointerEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Event handler for content pointer up."
+            },
+            {
+              "name": "onContentWheel",
+              "type": "(event: WheelEvent<HTMLDivElement>) => void",
+              "default": "",
+              "description": "Event handler for content wheel."
+            },
+            {
+              "name": "resolveSnapType",
+              "type": "() => string",
+              "default": "",
+              "description": "Computes the appropriate CSS  `scroll-snap-type`  value\nbased on orientation and snapping behavior."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseCarouselRootProps",
+              "default": "",
+              "description": "Props for the root element."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseCarouselContentProps",
+              "default": "",
+              "description": "Props for the content (track) element."
+            },
+            {
+              "name": "indicatorsProps",
+              "type": "UseCarouselIndicatorsProps",
+              "default": "",
+              "description": "Props for the indicators container element."
+            },
+            {
+              "name": "getItemProps",
+              "type": "(value: unknown, index?: number, total?: number) => UseCarouselItemProps",
+              "default": "",
+              "description": "Returns props for an individual carousel item."
+            },
+            {
+              "name": "getNextProps",
+              "type": "(disabled: boolean) => UseCarouselNextProps",
+              "default": "",
+              "description": "Returns props for the next navigation button."
+            },
+            {
+              "name": "getPrevProps",
+              "type": "(disabled: boolean) => UseCarouselPrevProps",
+              "default": "",
+              "description": "Returns props for the prev navigation button."
+            },
+            {
+              "name": "getIndicatorProps",
+              "type": "(page: number) => UseCarouselIndicatorProps",
+              "default": "",
+              "description": "Returns props for an individual indicator button."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseCarouselInstance": {
+          "description": "Instance of useCarousel headless.",
+          "values": "HeadlessInstance<UseCarouselProps, UseCarouselState, UseCarouselExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]