@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,787 @@
+[
+  {
+    "name": "useAutoComplete",
+    "source": "apps/showcase/assets/apidoc/useautocomplete.json",
+    "data": {
+      "description": "The useAutoComplete manages the state and functionality of an autocomplete component.",
+      "interfaces": {
+        "UseAutoCompleteValueChangeEvent": {
+          "description": "Event fired when the autocomplete's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "The selected value."
+            },
+            {
+              "name": "option",
+              "type": "unknown",
+              "default": "",
+              "description": "The selected option object."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteInputValueChangeEvent": {
+          "description": "Event fired when the autocomplete's input 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 input value."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteCompleteEvent": {
+          "description": "Event fired when the autocomplete triggers a search/complete action.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the complete."
+            },
+            {
+              "name": "query",
+              "type": "string",
+              "default": "",
+              "description": "The current query string."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteOpenChangeEvent": {
+          "description": "Event object for the onOpenChange callback.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "boolean",
+              "default": "",
+              "description": "The new value of the autocomplete's open state."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteProps": {
+          "description": "Props for the useAutoComplete hook.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current selected value of the autocomplete."
+            },
+            {
+              "name": "defaultValue",
+              "type": "unknown",
+              "default": "",
+              "description": "The default selected value when used in uncontrolled mode."
+            },
+            {
+              "name": "inputValue",
+              "type": "string",
+              "default": "",
+              "description": "The current input text value (controlled)."
+            },
+            {
+              "name": "defaultInputValue",
+              "type": "string",
+              "default": "",
+              "description": "The default input text value when used in uncontrolled mode."
+            },
+            {
+              "name": "open",
+              "type": "boolean",
+              "default": "",
+              "description": "Controlled open state of the input tags 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": "multiple",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, allows selecting multiple options."
+            },
+            {
+              "name": "metaKeySelection",
+              "type": "boolean",
+              "default": "",
+              "description": "When enabled, requires holding the meta key to select/deselect."
+            },
+            {
+              "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": "minLength",
+              "type": "number",
+              "default": "",
+              "description": "Minimum number of characters to initiate a search."
+            },
+            {
+              "name": "delay",
+              "type": "number",
+              "default": "",
+              "description": "Delay between keystrokes to wait before sending a query."
+            },
+            {
+              "name": "forceSelection",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that an input field must be filled out before submitting the form."
+            },
+            {
+              "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": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name of the input element."
+            },
+            {
+              "name": "required",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that an input field is required."
+            },
+            {
+              "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: UseAutoCompleteValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when the selected value changes."
+            },
+            {
+              "name": "onInputValueChange",
+              "type": "(event: UseAutoCompleteInputValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback when the input value changes."
+            },
+            {
+              "name": "onComplete",
+              "type": "(event: UseAutoCompleteCompleteEvent) => void",
+              "default": "",
+              "description": "Callback to invoke to search for suggestions."
+            },
+            {
+              "name": "onOpenChange",
+              "type": "(event: UseAutoCompleteOpenChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when the open state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteState": {
+          "description": "Defines valid state in useAutoComplete.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current selected value."
+            },
+            {
+              "name": "inputValue",
+              "type": "string",
+              "default": "",
+              "description": "The current input text value."
+            },
+            {
+              "name": "opened",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the overlay is open."
+            },
+            {
+              "name": "focused",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is focused."
+            },
+            {
+              "name": "focusedOptionIndex",
+              "type": "number",
+              "default": "",
+              "description": "The index of the currently focused option. -1 if no option is focused."
+            },
+            {
+              "name": "searching",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether a search is in progress."
+            },
+            {
+              "name": "anchorElement",
+              "type": "HTMLElement",
+              "default": "",
+              "description": "The anchor (input) 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 at least once."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteTriggerProps": {
+          "description": "Props for the AutoComplete trigger element (dropdown button).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "type",
+              "type": "\"button\"",
+              "default": "",
+              "description": "Button type attribute."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation. -1 when disabled."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the trigger is disabled."
+            },
+            {
+              "name": "aria-label",
+              "type": "string",
+              "default": "",
+              "description": "Accessible label for the trigger button."
+            },
+            {
+              "name": "aria-haspopup",
+              "type": "\"listbox\"",
+              "default": "",
+              "description": "Indicates the trigger has a listbox popup."
+            },
+            {
+              "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": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler that toggles the overlay."
+            },
+            {
+              "name": "data-positioner-open",
+              "type": "string",
+              "default": "",
+              "description": "Present when the positioner overlay is open."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteInputProps": {
+          "description": "Props for the AutoComplete input element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation. -1 when disabled."
+            },
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "The current input value."
+            },
+            {
+              "name": "autoComplete",
+              "type": "\"off\"",
+              "default": "",
+              "description": "Disables browser autocomplete."
+            },
+            {
+              "name": "role",
+              "type": "\"combobox\"",
+              "default": "",
+              "description": "ARIA role for the input."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name attribute of the input element."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is disabled."
+            },
+            {
+              "name": "aria-autocomplete",
+              "type": "\"list\"",
+              "default": "",
+              "description": "Indicates the autocomplete behavior for the input."
+            },
+            {
+              "name": "aria-haspopup",
+              "type": "\"listbox\"",
+              "default": "",
+              "description": "Indicates the input has a listbox popup."
+            },
+            {
+              "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": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change handler for the input."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Focus handler for the input."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Blur handler for the input."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Key down handler for keyboard navigation."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteIndicatorProps": {
+          "description": "Props for the AutoComplete indicator element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "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": []
+        },
+        "UseAutoCompleteClearProps": {
+          "description": "Props for the AutoComplete clear button element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "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."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompletePopupProps": {
+          "description": "Props for the AutoComplete popup element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-open",
+              "type": "string",
+              "default": "",
+              "description": "Present when the popup is open."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteRootProps": {
+          "description": "Props for the AutoComplete root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The unique identifier for the root element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"autocomplete\"",
+              "default": "",
+              "description": "The scope data attribute for the autocomplete."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "The part data attribute for the root element."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteListProps": {
+          "description": "Props for the AutoComplete list element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The unique identifier for the list element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"autocomplete\"",
+              "default": "",
+              "description": "The scope data attribute for the autocomplete."
+            },
+            {
+              "name": "data-part",
+              "type": "\"list\"",
+              "default": "",
+              "description": "The part data attribute for the list element."
+            },
+            {
+              "name": "[key: string]",
+              "type": "unknown",
+              "description": "Additional props spread from the internal listbox."
+            }
+          ],
+          "methods": []
+        },
+        "UseAutoCompleteExposes": {
+          "description": "Defines the methods and properties exposed by useAutoComplete.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseAutoCompleteState",
+              "default": "",
+              "description": "The state of the useAutoComplete."
+            },
+            {
+              "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": "hasValue",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Returns whether the autocomplete has a selected value."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseAutoCompleteRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element.\nIncludes id and data attributes."
+            },
+            {
+              "name": "listProps",
+              "type": "UseAutoCompleteListProps",
+              "default": "",
+              "description": "Pre-built props for the list element.\nIncludes id, ARIA attributes, and data attributes."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseAutoCompleteInputProps",
+              "default": "",
+              "description": "Pre-built props for the input element.\nIncludes ARIA attributes, form attributes, event handlers, and data attributes."
+            },
+            {
+              "name": "triggerProps",
+              "type": "UseAutoCompleteTriggerProps",
+              "default": "",
+              "description": "Pre-built props for the trigger element (non-editable mode).\nIncludes role, ARIA attributes, event handlers, and data attributes."
+            },
+            {
+              "name": "indicatorProps",
+              "type": "UseAutoCompleteIndicatorProps",
+              "default": "",
+              "description": "Pre-built props for the indicator element."
+            },
+            {
+              "name": "clearProps",
+              "type": "UseAutoCompleteClearProps",
+              "default": "",
+              "description": "Pre-built props for the clear button element."
+            },
+            {
+              "name": "popupProps",
+              "type": "UseAutoCompletePopupProps",
+              "default": "",
+              "description": "Pre-built props for the popup element."
+            },
+            {
+              "name": "setAnchorRef",
+              "type": "(node: HTMLElement) => void",
+              "default": "",
+              "description": "Ref setter for the popover anchor element."
+            },
+            {
+              "name": "setPositionerRef",
+              "type": "(node: HTMLDivElement) => void",
+              "default": "",
+              "description": "Ref setter for the popover positioner element."
+            },
+            {
+              "name": "setPopupRef",
+              "type": "(node: HTMLElement) => void",
+              "default": "",
+              "description": "Ref setter for the popover popup element."
+            },
+            {
+              "name": "setArrowRef",
+              "type": "(node: HTMLDivElement) => void",
+              "default": "",
+              "description": "Ref setter for the popover arrow element."
+            },
+            {
+              "name": "getSelectedOptionLabel",
+              "type": "() => unknown",
+              "default": "",
+              "description": "Gets the label of the currently selected option."
+            },
+            {
+              "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 input element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseAutoCompleteInstance": {
+          "description": "Instance of useAutoComplete headless.",
+          "values": "HeadlessInstance<UseAutoCompleteProps, UseAutoCompleteState, UseAutoCompleteExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]