@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,829 @@
+[
+  {
+    "name": "useSelect",
+    "source": "apps/showcase/assets/apidoc/useselect.json",
+    "data": {
+      "description": "The useSelect manages the state and functionality of a select component.",
+      "interfaces": {
+        "UseSelectRootProps": {
+          "description": "Props for the Select root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Unique ID of the root element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-disabled",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is in an invalid state."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectListProps": {
+          "description": "Props for the Select list element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Unique ID for the list element."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for the list element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"list\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "role",
+              "type": "\"listbox\"",
+              "default": "",
+              "description": "ARIA role for the list element."
+            },
+            {
+              "name": "aria-activedescendant",
+              "type": "string",
+              "default": "",
+              "description": "ID of the currently focused option for screen readers."
+            },
+            {
+              "name": "onFocus",
+              "type": "() => void",
+              "default": "",
+              "description": "Focus event handler for the list."
+            },
+            {
+              "name": "onBlur",
+              "type": "() => void",
+              "default": "",
+              "description": "Blur event handler for the list."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent) => void",
+              "default": "",
+              "description": "Keyboard event handler for the list."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectValueChangeEvent": {
+          "description": "Event fired when the select's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The selected value."
+            },
+            {
+              "name": "option",
+              "type": "unknown",
+              "default": "",
+              "description": "The selected option object."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectOpenChangeEvent": {
+          "description": "Event object for the onOpenChange callback.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "boolean",
+              "default": "",
+              "description": "The new value of the select's open state."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectFilterValueChangeEvent": {
+          "description": "Event fired when the select's filter value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "query",
+              "type": "string",
+              "default": "",
+              "description": "The current filter query."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectProps": {
+          "description": "Props for the useSelect hook.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current selected value of the select."
+            },
+            {
+              "name": "defaultValue",
+              "type": "unknown",
+              "default": "",
+              "description": "The default selected value when used in uncontrolled mode."
+            },
+            {
+              "name": "filterValue",
+              "type": "string",
+              "default": "",
+              "description": "The current filter text value (controlled)."
+            },
+            {
+              "name": "defaultFilterValue",
+              "type": "string",
+              "default": "",
+              "description": "The default filter text value when used in uncontrolled mode."
+            },
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "Controlled open state of the select overlay."
+            },
+            {
+              "name": "defaultOpen",
+              "type": "boolean",
+              "default": "",
+              "description": "Default open state for uncontrolled mode."
+            },
+            {
+              "name": "options",
+              "type": "unknown[]",
+              "default": "",
+              "description": "An array of options to display."
+            },
+            {
+              "name": "optionKey",
+              "type": "string",
+              "default": "",
+              "description": "Unique key for each option."
+            },
+            {
+              "name": "optionLabel",
+              "type": "string",
+              "default": "",
+              "description": "Label field for each option."
+            },
+            {
+              "name": "optionValue",
+              "type": "string",
+              "default": "",
+              "description": "Value field for each option."
+            },
+            {
+              "name": "optionDisabled",
+              "type": "string",
+              "default": "",
+              "description": "Field to check if an option is disabled."
+            },
+            {
+              "name": "optionGroupLabel",
+              "type": "string",
+              "default": "",
+              "description": "Label field for option groups."
+            },
+            {
+              "name": "optionGroupChildren",
+              "type": "string",
+              "default": "",
+              "description": "Field that contains the children options in a group."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component should be disabled."
+            },
+            {
+              "name": "locale",
+              "type": "string",
+              "default": "",
+              "description": "The locale to use for localization."
+            },
+            {
+              "name": "autoOptionFocus",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, the focused option is automatically highlighted."
+            },
+            {
+              "name": "selectOnFocus",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, the focused option is automatically selected."
+            },
+            {
+              "name": "focusOnHover",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, the focused option changes on hover."
+            },
+            {
+              "name": "metaKeySelection",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, requires holding the meta key to select/deselect."
+            },
+            {
+              "name": "multiple",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, allows multiple items to be selected."
+            },
+            {
+              "name": "filter",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, displays a filter input in the dropdown."
+            },
+            {
+              "name": "filterMatchMode",
+              "type": "\"endsWith\" | \"startsWith\" | \"contains\" | \"equals\"",
+              "default": "",
+              "description": "Defines how the filter should match options."
+            },
+            {
+              "name": "appendTo",
+              "type": "\"body\" | HTMLElement | \"self\"",
+              "default": "",
+              "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index of the element in tabbing order."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component is in an invalid state."
+            },
+            {
+              "name": "ariaLabel",
+              "type": "string",
+              "default": "",
+              "description": "Used to define a string that labels the input element."
+            },
+            {
+              "name": "ariaLabelledBy",
+              "type": "string",
+              "default": "",
+              "description": "Identifier of the underlying input element."
+            },
+            {
+              "name": "closeOnEscape",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, the overlay closes when Escape key is pressed."
+            },
+            {
+              "name": "autoFocus",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, the overlay receives focus automatically when opened."
+            },
+            {
+              "name": "trapped",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, focus is trapped within the overlay."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseSelectValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when the selected value changes."
+            },
+            {
+              "name": "onFilterValueChange",
+              "type": "(event: UseSelectFilterValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback when the filter value changes."
+            },
+            {
+              "name": "onOpenChange",
+              "type": "(event: UseSelectOpenChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when the open state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectState": {
+          "description": "Defines valid state in useSelect.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current selected value."
+            },
+            {
+              "name": "opened",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the overlay is open."
+            },
+            {
+              "name": "focused",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the trigger is focused."
+            },
+            {
+              "name": "focusedOptionIndex",
+              "type": "number",
+              "default": "",
+              "description": "The index of the currently focused option. -1 if no option is focused."
+            },
+            {
+              "name": "anchorElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "The anchor (trigger) element."
+            },
+            {
+              "name": "positionerElement",
+              "type": "HTMLDivElement",
+              "default": "",
+              "description": "The positioner element."
+            },
+            {
+              "name": "popupElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "The popup element."
+            },
+            {
+              "name": "arrowElement",
+              "type": "HTMLDivElement",
+              "default": "",
+              "description": "The arrow element."
+            },
+            {
+              "name": "rendered",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the overlay has been rendered (mounted to DOM)."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectTriggerProps": {
+          "description": "Props for the Select trigger element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"trigger\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation. -1 when disabled."
+            },
+            {
+              "name": "role",
+              "type": "\"combobox\"",
+              "default": "",
+              "description": "ARIA role for the trigger."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the trigger is disabled."
+            },
+            {
+              "name": "aria-haspopup",
+              "type": "\"listbox\"",
+              "default": "",
+              "description": "Indicates the trigger has a listbox popup."
+            },
+            {
+              "name": "aria-multiselectable",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether multiple selection is enabled."
+            },
+            {
+              "name": "aria-expanded",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the popup is expanded."
+            },
+            {
+              "name": "aria-controls",
+              "type": "string",
+              "default": "",
+              "description": "ID of the controlled listbox element."
+            },
+            {
+              "name": "aria-activedescendant",
+              "type": "string",
+              "default": "",
+              "description": "ID of the currently focused option."
+            },
+            {
+              "name": "aria-invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is in an invalid state."
+            },
+            {
+              "name": "aria-disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the trigger is disabled."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click handler that toggles the overlay."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLElement>) => void",
+              "default": "",
+              "description": "Key down handler for keyboard navigation."
+            },
+            {
+              "name": "onFocus",
+              "type": "() => void",
+              "default": "",
+              "description": "Focus event handler."
+            },
+            {
+              "name": "onBlur",
+              "type": "() => void",
+              "default": "",
+              "description": "Blur event handler."
+            },
+            {
+              "name": "data-positioner-open",
+              "type": "string",
+              "default": "",
+              "description": "Present when the positioner overlay is open."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectFilterProps": {
+          "description": "Props for the Select filter input element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"filter\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "role",
+              "type": "\"searchbox\"",
+              "default": "",
+              "description": "ARIA role for the filter input."
+            },
+            {
+              "name": "autoComplete",
+              "type": "\"off\"",
+              "default": "",
+              "description": "Disables browser autocomplete."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the filter is disabled."
+            },
+            {
+              "name": "aria-owns",
+              "type": "string",
+              "default": "",
+              "description": "ID of the owned listbox element."
+            },
+            {
+              "name": "aria-activedescendant",
+              "type": "string",
+              "default": "",
+              "description": "ID of the currently focused option."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent) => void",
+              "default": "",
+              "description": "Blur event handler."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change event handler for filter input."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Key down handler for filter keyboard navigation."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectIndicatorProps": {
+          "description": "Props for the Select indicator element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"indicator\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "aria-hidden",
+              "type": "true",
+              "default": "",
+              "description": "Hidden from screen readers as it is decorative."
+            },
+            {
+              "name": "data-open",
+              "type": "string",
+              "default": "",
+              "description": "Present when the popup is open."
+            },
+            {
+              "name": "data-closed",
+              "type": "string",
+              "default": "",
+              "description": "Present when the popup is closed."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectClearProps": {
+          "description": "Props for the Select clear button element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"clear\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "aria-label",
+              "type": "string",
+              "default": "",
+              "description": "Accessible label for the clear button."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation. -1 when disabled."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent<HTMLButtonElement>) => void",
+              "default": "",
+              "description": "Click handler that clears the value."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLButtonElement>) => void",
+              "default": "",
+              "description": "Key down handler for keyboard activation."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectPopupProps": {
+          "description": "Props for the Select popup element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"select\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"popup\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-open",
+              "type": "string",
+              "default": "",
+              "description": "Present when the popup is open."
+            }
+          ],
+          "methods": []
+        },
+        "UseSelectExposes": {
+          "description": "Defines the methods and properties exposed by useSelect.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseSelectState",
+              "default": "",
+              "description": "The state of the useSelect."
+            },
+            {
+              "name": "listbox",
+              "type": "UseListboxInstance",
+              "default": "",
+              "description": "The listbox instance used internally for option management."
+            },
+            {
+              "name": "setRendered",
+              "type": "(value: boolean) => void",
+              "default": "",
+              "description": "Sets the rendered state."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseSelectRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element.\nIncludes id and data attributes."
+            },
+            {
+              "name": "listProps",
+              "type": "UseSelectListProps",
+              "default": "",
+              "description": "Pre-built props for the list element.\nIncludes id, tabIndex, role, ARIA attributes, and event handlers."
+            },
+            {
+              "name": "triggerProps",
+              "type": "UseSelectTriggerProps",
+              "default": "",
+              "description": "Pre-built props for the trigger element.\nIncludes role, ARIA attributes, event handlers, and data attributes."
+            },
+            {
+              "name": "filterProps",
+              "type": "UseSelectFilterProps",
+              "default": "",
+              "description": "Pre-built props for the filter input element.\nIncludes role, ARIA attributes, and event handlers."
+            },
+            {
+              "name": "indicatorProps",
+              "type": "UseSelectIndicatorProps",
+              "default": "",
+              "description": "Pre-built props for the indicator element."
+            },
+            {
+              "name": "clearProps",
+              "type": "UseSelectClearProps",
+              "default": "",
+              "description": "Pre-built props for the clear button element."
+            },
+            {
+              "name": "popupProps",
+              "type": "UseSelectPopupProps",
+              "default": "",
+              "description": "Pre-built props for the popup element."
+            },
+            {
+              "name": "getSelectedOptionLabel",
+              "type": "() => unknown",
+              "default": "",
+              "description": "Gets the label of the currently selected option."
+            },
+            {
+              "name": "hasValue",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Checks if there is a selected value."
+            },
+            {
+              "name": "show",
+              "type": "() => void",
+              "default": "",
+              "description": "Shows the overlay."
+            },
+            {
+              "name": "hide",
+              "type": "() => void",
+              "default": "",
+              "description": "Hides the overlay."
+            },
+            {
+              "name": "toggle",
+              "type": "() => void",
+              "default": "",
+              "description": "Toggles the overlay visibility."
+            },
+            {
+              "name": "focus",
+              "type": "() => void",
+              "default": "",
+              "description": "Moves focus to the trigger element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseSelectInstance": {
+          "description": "Instance of useSelect headless.",
+          "values": "HeadlessInstance<UseSelectProps, UseSelectState, UseSelectExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]