MUINumberInput

MUINumberInput is a TextField-based numeric input that enforces number-only entry with options for integers-only, non-negative values, a maximum number of decimal places, and keyboard step increments.

Usage#

import MUINumberInput, { MUINumberInputProps } from '@nish1896/mui-components/mui/number-input';

const [age, setAge] = useState<number | null>(null);

<MUINumberInput
  fieldName="age"
  value={age}
  onValueChange={({ newValue }) => setAge(newValue)}
  onlyIntegers
  nonNegative
/>

Props#

MUINumberInputProps also accepts the remaining TextFieldProps, except type, multiline and rows. Props marked with * are required.

Name	Type	Description
`fieldName`*	`string`	Name/path of the field. Used to derive the `id`, the default label, and the `name` attribute. This prop is required for all components.
`value`	`number \| null`	Current numeric value of the field. `undefined`/`null` render an empty input.
`onValueChange`*	`({ newValue, event }) => void`	Called on every accepted numeric change. `newValue` is `null` when the input is cleared.
`nonNegative`	`boolean`	When true, negative values cannot be entered.
`onlyIntegers`	`boolean`	When true, decimal input is not allowed. Cannot be combined with `maxDecimalPlaces`.
`maxDecimalPlaces`	`number`	Maximum number of decimal places accepted while typing.
`stepAmount`	`number`	Amount the value changes on Arrow Up/Down key presses.
`showMarkers`	`boolean`	When true, shows increment/decrement markers on the input.
`label`	`ReactNode`	Label displayed for the field. Defaults to a human-readable label derived from `fieldName`, e.g. `firstName` becomes `First Name`
`showLabelAboveFormField`	`boolean`	When true, renders the field label above the form field in the FormLabel component, instead of inside or beside it.
`formLabelProps`	FormLabelProps	FormLabelProps forwarded to the internal `FormLabel`. The `id` is managed by the component. Multiple fields can be configured using the `ConfigProvider` component.
`hideLabel`	`boolean`	When true, hides the rendered field label while preserving accessible labeling where possible.
`required`	`boolean`	Indicates that the field is mandatory by adding an asterisk symbol (*) to the form label and setting the relevant accessibility attributes.
`errorMessage`	`string \| string[]`	Validation error for the field — pass a single message `string`, or a `string[]` when the field can fail multiple rules at once (every message is shown together). A non-empty string or array puts the field in an error state; `undefined`/`''`/`[]` clear it. Normalize your form library's error shape to this at the call site (e.g. an RHF `FieldError` via its `.message`). Use `renderError` to customize how the message(s) are rendered.
`renderError`	`(errors: string[]) => ReactNode`	Custom renderer for the resolved error message(s), called only when the field is in an error state. Always receives a `string[]` — use `errors[0]` for the common single-message case, or map over `errors` when a field fails several rules. By default a single message renders as text and multiple messages render on separate lines.
`hideErrorMessage`	`boolean`	If true, hides the error message text while keeping the field in an error state.
`formHelperTextProps`	FormHelperTextProps	FormHelperTextProps forwarded to the internal `FormHelperText`. The `id` is managed by the component. Multiple fields can be configured using the `ConfigProvider` component.
`customIds`	`{ field, label, helperText, error }`	Overrides the default field, label, helper text, and error IDs used for accessibility.

Playground#

Integrated with TanStack Form — covers onlyIntegers, nonNegative, maxDecimalPlaces, stepAmount, showMarkers and showLabelAboveFormField, with validation surfaced through errorMessage.

Password Input

Tags Input