@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,554 @@
+[
+  {
+    "name": "useInputNumber",
+    "source": "apps/showcase/assets/apidoc/useinputnumber.json",
+    "data": {
+      "description": "The useInputNumber manages the state and functionality of an input number component.",
+      "interfaces": {
+        "UseInputNumberValueChangeEvent": {
+          "description": "Custom value change event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "PointerEvent<HTMLButtonElement> | ChangeEvent<HTMLInputElement, Element> | KeyboardEvent<HTMLInputElement> | FormEvent<HTMLInputElement> | MouseEvent<HTMLInputElement, MouseEvent>",
+              "default": "",
+              "description": "Original browser event."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "New value."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberProps": {
+          "description": "Defines valid properties in useInputNumber.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "Specifies whether a inputnumber should be checked or not."
+            },
+            {
+              "name": "defaultValue",
+              "type": "number",
+              "default": "",
+              "description": "Specifies whether a inputnumber should be checked or not."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "The name attribute for the element, typically used in form submissions."
+            },
+            {
+              "name": "format",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether to format the value."
+            },
+            {
+              "name": "locale",
+              "type": "string",
+              "default": "",
+              "description": "Locale to be used in formatting."
+            },
+            {
+              "name": "localeMatcher",
+              "type": "\"lookup\" | \"best fit\"",
+              "default": "'best fit'",
+              "description": "The locale matching algorithm to use. Possible values are 'lookup' and 'best fit'; the default is 'best fit'.\nSee [Locale Negotation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation) for details."
+            },
+            {
+              "name": "mode",
+              "type": "\"decimal\" | \"currency\"",
+              "default": "decimal",
+              "description": "Defines the behavior of the component."
+            },
+            {
+              "name": "prefix",
+              "type": "string",
+              "default": "",
+              "description": "Text to display before the value."
+            },
+            {
+              "name": "suffix",
+              "type": "string",
+              "default": "",
+              "description": "Text to display after the value."
+            },
+            {
+              "name": "currency",
+              "type": "string",
+              "default": "",
+              "description": "The currency to use in currency formatting. Possible values are the [ISO 4217 currency codes](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency), such as 'USD' for the US dollar, 'EUR' for the euro, or 'CNY' for the Chinese RMB.\nThere is no default value; if the style is 'currency', the currency property must be provided."
+            },
+            {
+              "name": "currencyDisplay",
+              "type": "\"symbol\" | \"code\" | \"name\" | \"narrowSymbol\"",
+              "default": "",
+              "description": "How to display the currency in currency formatting. Possible values are 'symbol' to use a localized currency symbol such as €, 'code' to use the ISO currency code, 'name' to use a localized currency name such as 'dollar'."
+            },
+            {
+              "name": "useGrouping",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators."
+            },
+            {
+              "name": "minFractionDigits",
+              "type": "number",
+              "default": "",
+              "description": "The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0;\nthe default for currency formatting is the number of minor unit digits provided by the [ISO 4217 currency code](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) list (2 if the list doesn't provide that information)."
+            },
+            {
+              "name": "maxFractionDigits",
+              "type": "number",
+              "default": "",
+              "description": "The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3;\nthe default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the [ISO 4217 currency code](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) list (2 if the list doesn't provide that information)."
+            },
+            {
+              "name": "roundingMode",
+              "type": "\"expand\" | \"ceil\" | \"floor\" | \"trunc\" | \"halfCeil\" | \"halfFloor\" | \"halfExpand\" | \"halfTrunc\" | \"halfEven\"",
+              "default": "",
+              "description": "How decimals should be rounded.\n[further information](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#roundingmode)."
+            },
+            {
+              "name": "min",
+              "type": "number",
+              "default": "",
+              "description": "Minimum boundary value."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "",
+              "description": "Maximum boundary value."
+            },
+            {
+              "name": "step",
+              "type": "number",
+              "default": "1",
+              "description": "Step factor to increment/decrement the value."
+            },
+            {
+              "name": "allowEmpty",
+              "type": "boolean",
+              "default": "true",
+              "description": "Determines whether the input field is empty."
+            },
+            {
+              "name": "highlightOnFocus",
+              "type": "boolean",
+              "default": "false",
+              "description": "Highlights automatically the input value."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should be disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that an input field is read-only."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: UseInputNumberValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when value changes."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseInputNumberValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke after validation check and value change."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberState": {
+          "description": "Defines valid state in useInputNumber.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "Current value."
+            },
+            {
+              "name": "formattedValue",
+              "type": "string",
+              "default": "",
+              "description": "Formatted value."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberRootProps": {
+          "description": "Pre-built props for the root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "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 invalid state."
+            },
+            {
+              "name": "data-readonly",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is read-only."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberInputProps": {
+          "description": "Pre-built props for the input element.",
+          "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": "\"spinbutton\"",
+              "default": "",
+              "description": "Role attribute for spinbutton behavior."
+            },
+            {
+              "name": "aria-valuemin",
+              "type": "number",
+              "default": "",
+              "description": "Minimum ARIA value."
+            },
+            {
+              "name": "aria-valuemax",
+              "type": "number",
+              "default": "",
+              "description": "Maximum ARIA value."
+            },
+            {
+              "name": "aria-valuenow",
+              "type": "number",
+              "default": "",
+              "description": "Current ARIA value."
+            },
+            {
+              "name": "inputMode",
+              "type": "\"numeric\" | \"decimal\"",
+              "default": "",
+              "description": "Input mode for virtual keyboard."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Native disabled attribute mirroring the disabled prop."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "",
+              "description": "Native readOnly attribute mirroring the readOnly prop."
+            },
+            {
+              "name": "data-disabled",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is in invalid state."
+            },
+            {
+              "name": "data-readonly",
+              "type": "\"\"",
+              "default": "",
+              "description": "Present when the component is read-only."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change event handler."
+            },
+            {
+              "name": "onInput",
+              "type": "(event: FormEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Input event handler."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Key down event handler."
+            },
+            {
+              "name": "onKeyPress",
+              "type": "(event: KeyboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Key press event handler."
+            },
+            {
+              "name": "onClick",
+              "type": "(event: MouseEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Click event handler."
+            },
+            {
+              "name": "onPaste",
+              "type": "(event: ClipboardEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Paste event handler."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Focus event handler."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Blur event handler."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberIncrementProps": {
+          "description": "Pre-built event handler props for the increment button.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Disabled when the component is disabled or the max boundary is reached."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for the button."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer down event handler to start incrementing."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer up event handler to stop spinning."
+            },
+            {
+              "name": "onPointerLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer leave event handler to stop spinning."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLButtonElement>) => void",
+              "default": "",
+              "description": "Key down event handler for keyboard support (Enter/Space)."
+            },
+            {
+              "name": "onKeyUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Key up event handler to stop spinning."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberDecrementProps": {
+          "description": "Pre-built event handler props for the decrement button.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Disabled when the component is disabled or the min boundary is reached."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for the button."
+            },
+            {
+              "name": "onPointerDown",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer down event handler to start decrementing."
+            },
+            {
+              "name": "onPointerUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer up event handler to stop spinning."
+            },
+            {
+              "name": "onPointerLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Pointer leave event handler to stop spinning."
+            },
+            {
+              "name": "onKeyDown",
+              "type": "(event: KeyboardEvent<HTMLButtonElement>) => void",
+              "default": "",
+              "description": "Key down event handler for keyboard support (Enter/Space)."
+            },
+            {
+              "name": "onKeyUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Key up event handler to stop spinning."
+            }
+          ],
+          "methods": []
+        },
+        "UseInputNumberExposes": {
+          "description": "Defines the methods and properties exposed by useInputNumber.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseInputNumberState",
+              "default": "",
+              "description": "State of the input number."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseInputNumberRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseInputNumberInputProps",
+              "default": "",
+              "description": "Pre-built props for the input element."
+            },
+            {
+              "name": "incrementProps",
+              "type": "UseInputNumberIncrementProps",
+              "default": "",
+              "description": "Pre-built event handler props for the increment button."
+            },
+            {
+              "name": "decrementProps",
+              "type": "UseInputNumberDecrementProps",
+              "default": "",
+              "description": "Pre-built event handler props for the decrement button."
+            },
+            {
+              "name": "maxBoundry",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Checks if the maximum boundary is reached."
+            },
+            {
+              "name": "minBoundry",
+              "type": "() => boolean",
+              "default": "",
+              "description": "Checks if the minimum boundary is reached."
+            },
+            {
+              "name": "increment",
+              "type": "(event: PointerEvent<HTMLButtonElement> | KeyboardEvent<HTMLInputElement> | MouseEvent<HTMLInputElement, MouseEvent>, dir: number) => void",
+              "default": "",
+              "description": "Increments the input number value (requires event from input element)."
+            },
+            {
+              "name": "decrement",
+              "type": "(event: PointerEvent<HTMLButtonElement> | KeyboardEvent<HTMLInputElement> | MouseEvent<HTMLInputElement, MouseEvent>, dir: number) => void",
+              "default": "",
+              "description": "Decrements the input number value (requires event from input element)."
+            },
+            {
+              "name": "stepUp",
+              "type": "() => void",
+              "default": "",
+              "description": "Increments the input number value without requiring an event. Use this for external buttons."
+            },
+            {
+              "name": "stepDown",
+              "type": "() => void",
+              "default": "",
+              "description": "Decrements the input number value without requiring an event. Use this for external buttons."
+            },
+            {
+              "name": "stopSpin",
+              "type": "() => void",
+              "default": "",
+              "description": "Stops the spinning/repeating increment/decrement actions."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseInputNumberInstance": {
+          "description": "Instance of useInputNumber headless.",
+          "values": "HeadlessInstance<UseInputNumberProps, UseInputNumberState, UseInputNumberExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]