{
"hookDescription": "",
"parametersDescriptions": {
"componentName": {
"description": "The name of the component using useNumberInput. For debugging purposes."
},
"defaultValue": {
"description": "The default value. Use when the component is not controlled."
},
"disabled": {
"description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component."
},
"error": {
"description": "If true, the input will indicate an error by setting the aria-invalid attribute. The prop defaults to the value (false) inherited from the parent FormControl component."
},
"inputId": { "description": "The id attribute of the input element." },
"inputRef": { "description": "The ref of the input element." },
"max": { "description": "The maximum value." },
"min": { "description": "The minimum value." },
"onChange": {
"description": "Callback fired after the value is clamped and changes - when the input is blurred or when the stepper buttons are triggered. Called with undefined when the value is unset."
},
"onInputChange": {
"description": "Callback fired when the input value changes after each keypress, before clamping is applied. Note that event.target.value may contain values that fall outside of min and max or are otherwise "invalid"."
},
"readOnly": {
"description": "If true, the input element becomes read-only. The stepper buttons remain active, with the addition that they are now keyboard focusable."
},
"required": {
"description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component."
},
"shiftMultiplier": {
"description": "Multiplier applied to step if the shift key is held while incrementing or decrementing the value. Defaults to 10."
},
"step": { "description": "The amount that the value changes on each increment or decrement." },
"value": { "description": "The current value. Use when the component is controlled." }
},
"returnValueDescriptions": {
"disabled": { "description": "If true, the component will be disabled." },
"error": {
"description": "If true, the input will indicate an error by setting the aria-invalid attribute."
},
"focused": { "description": "If true, the input will be focused." },
"formControlContext": {
"description": "Return value from the useFormControlContext hook."
},
"getDecrementButtonProps": {
"description": "Resolver for the decrement button slot's props."
},
"getIncrementButtonProps": {
"description": "Resolver for the increment button slot's props."
},
"getInputProps": { "description": "Resolver for the input slot's props." },
"getRootProps": { "description": "Resolver for the root slot's props." },
"inputValue": {
"description": "The dirty value of the input element when it is in focus."
},
"isDecrementDisabled": {
"description": "If true, the decrement button will be disabled. e.g. when the value is already at min"
},
"isIncrementDisabled": {
"description": "If true, the increment button will be disabled. e.g. when the value is already at max"
},
"required": {
"description": "If true, the input will indicate that it's required."
},
"value": { "description": "The clamped value of the input element." }
}
}