@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,497 @@
+[
+  {
+    "name": "useInputTags",
+    "source": "apps/showcase/assets/apidoc/useinputtags.json",
+    "data": {
+      "description": "The useInputTags manages the state and functionality of a tag-input component.",
+      "interfaces": {
+        "UseInputTagsValueChangeEvent": {
+          "description": "Custom change event for InputTags component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "string[]",
+              "default": "",
+              "description": "The new value of the items."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsAddEvent": {
+          "description": "Event fired when an item is added.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "The added item value."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsRemoveEvent": {
+          "description": "Event fired when an item is removed.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "The removed item value."
+            },
+            {
+              "name": "index",
+              "type": "number",
+              "default": "",
+              "description": "The index of the removed item."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsInputValueChangeEvent": {
+          "description": "Event fired when the 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 (query)."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsProps": {
+          "description": "Defines valid properties in useInputTags.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "string[]",
+              "default": "",
+              "description": "Controlled list of tag values."
+            },
+            {
+              "name": "defaultValue",
+              "type": "string[]",
+              "default": "",
+              "description": "Initial tag values for uncontrolled usage."
+            },
+            {
+              "name": "inputValue",
+              "type": "string",
+              "default": "",
+              "description": "Controlled value of the text-entry control."
+            },
+            {
+              "name": "defaultInputValue",
+              "type": "string",
+              "default": "",
+              "description": "Initial value of the text-entry control for uncontrolled usage."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name used by the hidden form input."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component is disabled."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "",
+              "description": "Maximum number of tags that can be added."
+            },
+            {
+              "name": "delimiter",
+              "type": "string | RegExp",
+              "default": "",
+              "description": "Delimiter used to split typed or pasted text into tags."
+            },
+            {
+              "name": "allowDuplicate",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether duplicate tag values are allowed."
+            },
+            {
+              "name": "addOnBlur",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the current input value should be added when the control loses focus."
+            },
+            {
+              "name": "addOnPaste",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether pasted text should be added as tags."
+            },
+            {
+              "name": "addOnTab",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the current input value should be added when tabbing away."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component is in an invalid state."
+            },
+            {
+              "name": "variant",
+              "type": "\"outlined\" | \"filled\"",
+              "default": "",
+              "description": "Visual variant of the field."
+            },
+            {
+              "name": "fluid",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should fill the width of its container."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseInputTagsValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the tag value list changes."
+            },
+            {
+              "name": "onAdd",
+              "type": "(event: UseInputTagsAddEvent) => void",
+              "default": "",
+              "description": "Callback fired after a tag is added."
+            },
+            {
+              "name": "onRemove",
+              "type": "(event: UseInputTagsRemoveEvent) => void",
+              "default": "",
+              "description": "Callback fired after a tag is removed."
+            },
+            {
+              "name": "onInputValueChange",
+              "type": "(event: UseInputTagsInputValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the text-entry value changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsState": {
+          "description": "Defines valid state in useInputTags.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "string[]",
+              "default": "",
+              "description": "Current tag values."
+            },
+            {
+              "name": "inputValue",
+              "type": "string",
+              "default": "",
+              "description": "Current text-entry value."
+            },
+            {
+              "name": "focusedItemIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index of the focused tag item, or -1 when no tag is focused."
+            },
+            {
+              "name": "focused",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the text-entry control is focused."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsControlProps": {
+          "description": "Props for the control element (the text-entry input).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputtags\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"control\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "ref",
+              "type": "RefObject<HTMLInputElement>",
+              "default": "",
+              "description": "Ref for the text-entry control."
+            },
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "Current text-entry value."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the control is disabled."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change handler for the text-entry control."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Keyboard handler for tag creation, navigation, and removal."
+            },
+            {
+              "name": "onPaste",
+              "type": "(event: ClipboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Paste handler used to add pasted text as tags."
+            },
+            {
+              "name": "onFocus",
+              "type": "() => void",
+              "default": "",
+              "description": "Focus handler for the text-entry control."
+            },
+            {
+              "name": "onBlur",
+              "type": "() => void",
+              "default": "",
+              "description": "Blur handler for the text-entry control."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsHiddenInputProps": {
+          "description": "Props for the hidden form input.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputtags\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"hidden-input\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "value",
+              "type": "string",
+              "default": "",
+              "description": "Serialized tag values submitted with the form."
+            },
+            {
+              "name": "type",
+              "type": "\"hidden\"",
+              "default": "",
+              "description": "Hidden input type."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Form field name."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsRootProps": {
+          "description": "Props for the root container element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"inputtags\"",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "role",
+              "type": "\"listbox\"",
+              "default": "",
+              "description": "ARIA role for the tag collection."
+            },
+            {
+              "name": "aria-orientation",
+              "type": "\"horizontal\"",
+              "default": "",
+              "description": "Orientation of the tag collection."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent) => void",
+              "default": "",
+              "description": "Click handler that keeps focus on the text-entry control when appropriate."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsItemProps": {
+          "description": "Props for an individual tag item (intended to be spread on the user-rendered chip).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "role",
+              "type": "\"option\"",
+              "default": "",
+              "description": "ARIA role for an individual tag item."
+            },
+            {
+              "name": "aria-selected",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the tag item is currently focused by keyboard navigation."
+            },
+            {
+              "name": "aria-setsize",
+              "type": "number",
+              "default": "",
+              "description": "Total number of tag items in the collection."
+            },
+            {
+              "name": "aria-posinset",
+              "type": "number",
+              "default": "",
+              "description": "One-based position of the tag item in the collection."
+            },
+            {
+              "name": "data-index",
+              "type": "number",
+              "default": "",
+              "description": "Zero-based index of the tag item."
+            },
+            {
+              "name": "data-selected",
+              "type": "string",
+              "default": "",
+              "description": "Empty string when the item is focused (so  `[data-selected]`  CSS selector matches),  `undefined`  otherwise."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Keyboard handler for item-level navigation and removal."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputTagsExposes": {
+          "description": "Defines the methods and properties exposed by useInputTags.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseInputTagsState",
+              "default": "",
+              "description": "Current state of the tag input."
+            },
+            {
+              "name": "inputRef",
+              "type": "RefObject<HTMLInputElement>",
+              "default": "",
+              "description": "Ref for the text-entry control."
+            },
+            {
+              "name": "itemRefs",
+              "type": "RefObject<Map<number, HTMLElement>>",
+              "default": "",
+              "description": "Refs for rendered tag items keyed by item index."
+            },
+            {
+              "name": "addItem",
+              "type": "(tags: string | string[]) => string[]",
+              "default": "",
+              "description": "Adds one or more tags and returns the accepted values. Accepts a single string or an array of strings."
+            },
+            {
+              "name": "removeItem",
+              "type": "(index: number) => void",
+              "default": "",
+              "description": "Removes the tag at the given index."
+            },
+            {
+              "name": "removeLast",
+              "type": "() => void",
+              "default": "",
+              "description": "Removes the last tag value."
+            },
+            {
+              "name": "removeAll",
+              "type": "() => void",
+              "default": "",
+              "description": "Removes all tag values."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseInputTagsRootProps",
+              "default": "",
+              "description": "Props for the root container element."
+            },
+            {
+              "name": "controlProps",
+              "type": "UseInputTagsControlProps",
+              "default": "",
+              "description": "Props for the text-entry control."
+            },
+            {
+              "name": "hiddenInputProps",
+              "type": "UseInputTagsHiddenInputProps",
+              "default": "",
+              "description": "Props for the hidden form input."
+            },
+            {
+              "name": "getItemProps",
+              "type": "(index: number) => UseInputTagsItemProps",
+              "default": "",
+              "description": "Returns props for a rendered tag item by index."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseInputTagsInstance": {
+          "description": "Instance of useInputTags headless.",
+          "values": "HeadlessInstance<UseInputTagsProps, UseInputTagsState, UseInputTagsExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]