@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,814 @@
+[
+  {
+    "name": "useListbox",
+    "source": "apps/showcase/assets/apidoc/uselistbox.json",
+    "data": {
+      "description": "The useListbox manages the state and functionality of a listbox component.",
+      "interfaces": {
+        "UseListboxValueChangeEvent": {
+          "description": "Event fired when the listbox's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "SyntheticEvent",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The value state of the listbox. Type depends on optionValue configuration."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxProps": {
+          "description": "Props for the useListbox hook.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current value of the listbox. For single selection, this is a single value. For multiple selection, this is an array of values."
+            },
+            {
+              "name": "defaultValue",
+              "type": "unknown",
+              "default": "",
+              "description": "The default value of the listbox when used in uncontrolled mode."
+            },
+            {
+              "name": "options",
+              "type": "T[]",
+              "default": "",
+              "description": "An array of options to display in the listbox."
+            },
+            {
+              "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 listbox should be disabled."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "locale",
+              "type": "string",
+              "default": "",
+              "description": "The locale to use for localization. Used for accessibility labels."
+            },
+            {
+              "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 (Ctrl/Cmd) to select/deselect items in multiple selection mode."
+            },
+            {
+              "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": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index of the element in tabbing order."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseListboxValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when the value changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxState": {
+          "description": "Defines valid state in useListbox.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The current value(s) selected in the listbox. Type depends on optionValue configuration."
+            },
+            {
+              "name": "focused",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the listbox is currently focused."
+            },
+            {
+              "name": "focusedOptionIndex",
+              "type": "number",
+              "default": "",
+              "description": "The index of the currently focused option. -1 if no option is focused."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxListElementProps": {
+          "description": "Props for the Listbox list element.\nIncludes role, tabIndex, ARIA, and keyboard/focus event handlers.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Unique ID for the list element."
+            },
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLUListElement>",
+              "default": "",
+              "description": "Ref for the list element."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for the list element."
+            },
+            {
+              "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": []
+        },
+        "UseListboxFilterElementProps": {
+          "description": "Props for the Listbox filter element.\nIncludes role, ARIA, and keyboard/focus event handlers.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "role",
+              "type": "\"searchbox\"",
+              "default": "",
+              "description": "ARIA role for the filter element."
+            },
+            {
+              "name": "autoComplete",
+              "type": "\"off\"",
+              "default": "",
+              "description": "Autocomplete attribute for the filter input."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the filter is disabled."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index of the element in tabbing order."
+            },
+            {
+              "name": "aria-owns",
+              "type": "string",
+              "default": "",
+              "description": "ID of the list element owned by this filter."
+            },
+            {
+              "name": "aria-activedescendant",
+              "type": "string",
+              "default": "",
+              "description": "ID of the currently focused option for screen readers."
+            },
+            {
+              "name": "onBlur",
+              "type": "() => void",
+              "default": "",
+              "description": "Blur event handler for the filter."
+            },
+            {
+              "name": "onChange",
+              "type": "() => void",
+              "default": "",
+              "description": "Change event handler for the filter."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent) => void",
+              "default": "",
+              "description": "Keyboard event handler for the filter."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxRootElementProps": {
+          "description": "Props for the Listbox root element.\nIncludes id, data attributes, and blur event handler.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Unique ID for the root element."
+            },
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent) => void",
+              "default": "",
+              "description": "Blur event handler for focus-out tracking."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxOptionElementProps": {
+          "description": "Props for a Listbox option element.\nIncludes id, role, ARIA attributes, data attributes, and mouse/touch event handlers.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "Unique ID for the option element."
+            },
+            {
+              "name": "role",
+              "type": "\"option\"",
+              "default": "",
+              "description": "ARIA role for the option."
+            },
+            {
+              "name": "aria-selected",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is currently selected."
+            },
+            {
+              "name": "aria-disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is disabled."
+            },
+            {
+              "name": "aria-setsize",
+              "type": "number",
+              "default": "",
+              "description": "Total number of selectable options for ARIA."
+            },
+            {
+              "name": "aria-posinset",
+              "type": "number",
+              "default": "",
+              "description": "Position of this option in the set for ARIA."
+            },
+            {
+              "name": "data-selected",
+              "type": "string",
+              "default": "",
+              "description": "Present when the option is selected."
+            },
+            {
+              "name": "data-unselected",
+              "type": "string",
+              "default": "",
+              "description": "Present when the option is not selected."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the option is disabled."
+            },
+            {
+              "name": "data-focused",
+              "type": "string",
+              "default": "",
+              "description": "Present when the option is focused."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click event handler for option selection."
+            },
+            {
+              "name": "onMouseDown",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Mouse down event handler for focus change."
+            },
+            {
+              "name": "onMouseMove",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Mouse move event handler for hover focus."
+            },
+            {
+              "name": "onTouchEnd",
+              "type": "() => void",
+              "default": "",
+              "description": "Touch end event handler."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxHiddenFocusableProps": {
+          "description": "Props for a hidden focusable sentinel element used by the listbox for focus management.\nIncludes role, ARIA, data attributes, and focus event handler.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "role",
+              "type": "\"presentation\"",
+              "default": "",
+              "description": "ARIA role for the hidden element."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Ref for the hidden focusable sentinel element."
+            },
+            {
+              "name": "aria-hidden",
+              "type": "true",
+              "default": "",
+              "description": "Hides the element from assistive technologies."
+            },
+            {
+              "name": "data-focus-guard",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute marking the element as a focus guard sentinel."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent) => void",
+              "default": "",
+              "description": "Focus event handler for the hidden element."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxExposes": {
+          "description": "Defines the methods and properties exposed by useListbox.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseListboxState",
+              "default": "",
+              "description": "The state of the useListbox."
+            },
+            {
+              "name": "listRef",
+              "type": "RefObject<HTMLUListElement>",
+              "default": "",
+              "description": "Reference to the list element of the listbox."
+            },
+            {
+              "name": "firstHiddenElementRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the first hidden focusable element for accessibility."
+            },
+            {
+              "name": "lastHiddenElementRef",
+              "type": "RefObject<HTMLElement>",
+              "default": "",
+              "description": "Reference to the last hidden focusable element for accessibility."
+            },
+            {
+              "name": "getOptions",
+              "type": "() => T[]",
+              "default": "",
+              "description": "Gets the list of options for the listbox."
+            },
+            {
+              "name": "getOptionId",
+              "type": "(index: number) => string",
+              "default": "",
+              "description": "Gets the unique ID for an option at a given index."
+            },
+            {
+              "name": "getOptionLabel",
+              "type": "(option: T) => string",
+              "default": "",
+              "description": "Gets the label for a given option."
+            },
+            {
+              "name": "getOptionValue",
+              "type": "(option: T) => unknown",
+              "default": "",
+              "description": "Gets the value for a given option. Return type depends on optionValue configuration."
+            },
+            {
+              "name": "isOptionDisabled",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if a given option is disabled."
+            },
+            {
+              "name": "isOptionGroup",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if a given option is a group header."
+            },
+            {
+              "name": "getOptionGroupLabel",
+              "type": "(optionGroup: T) => string",
+              "default": "",
+              "description": "Gets the label for a given option group."
+            },
+            {
+              "name": "getOptionGroupChildren",
+              "type": "(optionGroup: T) => T[]",
+              "default": "",
+              "description": "Gets the children options for a given option group."
+            },
+            {
+              "name": "getFocusedOptionId",
+              "type": "() => string",
+              "default": "",
+              "description": "Gets the ID of the currently focused option."
+            },
+            {
+              "name": "firstHiddenProps",
+              "type": "UseListboxHiddenFocusableProps",
+              "default": "",
+              "description": "Pre-built props for the first hidden focusable sentinel element.\nIncludes role, ARIA, data attributes, and focus event handler."
+            },
+            {
+              "name": "lastHiddenProps",
+              "type": "UseListboxHiddenFocusableProps",
+              "default": "",
+              "description": "Pre-built props for the last hidden focusable sentinel element.\nIncludes role, ARIA, data attributes, and focus event handler."
+            },
+            {
+              "name": "onOptionSelect",
+              "type": "(event: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>, option: T, index?: number) => void",
+              "default": "",
+              "description": "Callback when an option is selected."
+            },
+            {
+              "name": "onOptionTouchEnd",
+              "type": "() => void",
+              "default": "",
+              "description": "Callback when touch ends on an option."
+            },
+            {
+              "name": "onClearClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Callback when the clear button is clicked."
+            },
+            {
+              "name": "isOptionMatched",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if an option matches the search value."
+            },
+            {
+              "name": "isValidOption",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if an option is valid (not disabled and not a group)."
+            },
+            {
+              "name": "isValidSelectedOption",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if an option is valid for selection."
+            },
+            {
+              "name": "isSelected",
+              "type": "(option: T) => boolean",
+              "default": "",
+              "description": "Checks if an option is currently selected."
+            },
+            {
+              "name": "changeFocusedOptionIndex",
+              "type": "(event: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>, index?: number) => void",
+              "default": "",
+              "description": "Changes the focused option index."
+            },
+            {
+              "name": "findSelectedOptionIndex",
+              "type": "() => number",
+              "default": "",
+              "description": "Finds the index of the selected option."
+            },
+            {
+              "name": "findFirstFocusedOptionIndex",
+              "type": "() => number",
+              "default": "",
+              "description": "Finds the index of the first focused option."
+            },
+            {
+              "name": "scrollInView",
+              "type": "(index?: number) => void",
+              "default": "",
+              "description": "Scrolls the option at the given index into view."
+            },
+            {
+              "name": "updateModel",
+              "type": "(event: SyntheticEvent, value: unknown) => void",
+              "default": "",
+              "description": "Updates the listbox model with a new value."
+            },
+            {
+              "name": "autoUpdateModel",
+              "type": "() => void",
+              "default": "",
+              "description": "Automatically updates the model based on option selection."
+            },
+            {
+              "name": "equalityKey",
+              "type": "string",
+              "default": "",
+              "description": "Property name used for equality comparison."
+            },
+            {
+              "name": "hasValue",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Checks if the listbox has a value."
+            },
+            {
+              "name": "isEquals",
+              "type": "(value1: unknown, value2: unknown) => boolean",
+              "default": "",
+              "description": "Checks if two values are equal using the equality key."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseListboxRootElementProps",
+              "default": "",
+              "description": "Pre-built props for the root element.\nIncludes id, data attributes, and blur event handler."
+            },
+            {
+              "name": "listProps",
+              "type": "UseListboxListElementProps",
+              "default": "",
+              "description": "Pre-built props for the list element.\nIncludes role, tabIndex, ARIA attributes, and keyboard/focus event handlers."
+            },
+            {
+              "name": "filterProps",
+              "type": "UseListboxFilterElementProps",
+              "default": "",
+              "description": "Pre-built props for the filter element.\nIncludes role, ARIA attributes, and keyboard/focus event handlers."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseListboxInstance": {
+          "description": "Instance of useListbox headless.",
+          "values": "HeadlessInstance<UseListboxProps<T>, UseListboxState, UseListboxExposes<T>>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "useListboxOption",
+    "source": "apps/showcase/assets/apidoc/uselistboxoption.json",
+    "data": {
+      "description": "The useListboxOption manages the state and functionality of a Listbox option.",
+      "interfaces": {
+        "UseListboxOptionProps": {
+          "description": "Defines valid properties in useListboxOption.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "option",
+              "type": "unknown",
+              "default": "",
+              "description": "The option data object."
+            },
+            {
+              "name": "index",
+              "type": "number",
+              "default": "",
+              "description": "The index of the option in the list."
+            },
+            {
+              "name": "group",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the option is a group header."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the option is disabled."
+            },
+            {
+              "name": "context",
+              "type": "UseListboxInstance",
+              "default": "",
+              "description": "The parent listbox instance providing state and methods."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxOptionState": {
+          "description": "Defines valid state in useListboxOption.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "selected",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is currently selected."
+            },
+            {
+              "name": "focused",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is currently focused."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is disabled."
+            },
+            {
+              "name": "group",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the option is a group header."
+            }
+          ],
+          "methods": []
+        },
+        "UseListboxOptionExposes": {
+          "description": "Defines the methods and properties exposed by useListboxOption.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "optionProps",
+              "type": "UseListboxOptionElementProps",
+              "default": "",
+              "description": "Pre-built props for a non-group option element.\nIncludes id, role, ARIA attributes, data attributes, and mouse/touch event handlers."
+            },
+            {
+              "name": "groupProps",
+              "type": "{ data-scope: string; data-part: string }",
+              "default": "",
+              "description": "Pre-built props for a group option element.\nIncludes data-scope and data-part attributes."
+            },
+            {
+              "name": "optionIndicatorProps",
+              "type": "{ data-scope: string; data-part: string; data-selected?: string; data-unselected?: string }",
+              "default": "",
+              "description": "Pre-built props for the option indicator element.\nIncludes data-scope, data-part, and data-selected/data-unselected attributes."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseListboxOptionInstance": {
+          "description": "Instance of useListboxOption headless.",
+          "values": "HeadlessInstance<UseListboxOptionProps, UseListboxOptionState, UseListboxOptionExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]