Skip to content


API docs for the Toolpad Studio TextField component.

The Material UI TextField component lets you input a text value.


Name Type Default Description
value string "" The value that is controlled by this text input.
defaultValue string "" A default value for when the input is still empty.
label string A label that describes the content of the text field, for example "First name".
variant string "outlined" One of the available Material UI TextField variants. Possible values are outlined, filled or standard
size string "small" The size of the input. One of small, or medium.
fullWidth boolean Whether the input should occupy all available horizontal space.
password boolean Masks the input to hide what's being typed.
placeholder string The short hint displayed in the input before the user enters a value.
disabled boolean Whether the input is disabled.
name string Name of this input. Used as a reference in form data.
isRequired boolean false Whether the input is required to have a value.
minLength number 0 Minimum value length.
maxLength number 0 Maximum value length.
sx object The sx prop is used for defining custom styles that have access to the theme. All MUI System properties are available via the sx prop. In addition, the sx prop allows you to specify any other CSS rules you may need.