Skip to content

TextInput

Single-line or multiline text input. Wraps a Shadcn <Input> or <Textarea> depending on multiline.

import { TextInput } from '@/components/admin';
<TextInput source="title" />
<TextInput source="description" multiline rows={4} />
PropRequiredTypeDefaultDescription
sourceRequiredstring-Field name
classNameOptionalstring-CSS classes
defaultValueOptionalboolean-Default value
disabledOptionalboolean-Disable input
formatOptionalfunction-Callback taking the value from the form state, and returning the input value.
helperTextOptionalReactNode-Help text
labelOptionalstring | falseInferredCustom / hide label
multilineOptionalbooleanfalseUse a <textarea>
parseOptional(value:string)=>number-Callback taking the value from the input, and returning the value to be stored in the form state.
 placeholderOptionalstring-Placeholder text
validateOptionalValidator | Validator[]-Validation

Additional props are passed to the underlying <input> or <textarea> element, e.g. type, rows, etc.

Warning: Do not use type="number", or you’ll receive a string as value (this is a known React bug). Instead, use <NumberInput>.