Text Fields

Text fields let users enter and edit text.

Text fields allow users to enter text into a UI. They typically appear in forms and dialogs.

TextField

The TextField wrapper component is a complete form control including a label, input and help text.

Note: This version of the text field is no longer documented in the Material Design guidelines, but Material-UI will continue to support it.

Outlined

TextField supports outlined styling.

Filled

TextField supports filled styling.

Components

TextField is composed of smaller components ( FormControl, Input, FilledInput, InputLabel, OutlinedInput, and FormHelperText ) that you can leverage directly to significantly customize your form inputs.

You might also have noticed that some native HTML input properties are missing from the TextField component. This is on purpose. The component takes care of the most used properties, then it's up to the user to use the underlying component shown in the following demo. Still, you can use inputProps (and InputProps, InputLabelProps properties) if you want to avoid some boilerplate.

Inputs

Customized inputs

Here are some examples of customizing the component. You can learn more about this in the overrides documentation page.

Customization does not stop at CSS, you can use composition to build custom components and give your app a unique feel. Below is an example using the InputBase component, inspired by Google Maps.

<Paper className={classes.root}>
  <IconButton className={classes.iconButton} aria-label="menu">
    <MenuIcon />
  </IconButton>
  <InputBase
    className={classes.input}
    placeholder="Search Google Maps"
    inputProps={{ 'aria-label': 'search google maps' }}
  />
  <IconButton className={classes.iconButton} aria-label="search">
    <SearchIcon />
  </IconButton>
  <Divider className={classes.divider} orientation="vertical" />
  <IconButton color="primary" className={classes.iconButton} aria-label="directions">
    <DirectionsIcon />
  </IconButton>
</Paper>

Input Adornments

Input allows the provision of InputAdornment. These can be used to add a prefix, a suffix or an action to an input. For instance, you can use an icon button to hide or reveal the password.

With icon

Icons can be specified as prepended or appended.

Filled Input Adornments

Outlined Input Adornments

Layout

TextField, FormControl allow the specification of margin to alter the vertical spacing of inputs. Using none (default) will not apply margins to the FormControl, whereas dense and normal will as well as alter other styles to meet the specification.

Limitations

Shrink

The input label "shrink" state isn't always correct. The input label is supposed to shrink as soon as the input is displaying something. In some circumstances, we can't determine the "shrink" state (number input, datetime input, Stripe input). You might notice an overlap.

To workaround the issue, you can force the "shrink" state of the label.

<TextField InputLabelProps={{ shrink: true }} />

or

<InputLabel shrink>Count</InputLabel>

Floating label

The floating label is absolutely positioned, it won't impact the layout of the page. You need to make sure that the input is larger than the label to display correctly.

Integration with 3rd party input libraries

You can use third-party libraries to format an input. You have to provide a custom implementation of the <input> element with the inputComponent property.

The following demo uses the react-text-mask and react-number-format libraries. The same concept could be applied to e.g. react-stripe-element.

<FormControl className={classes.formControl}>
  <InputLabel htmlFor="formatted-text-mask-input">react-text-mask</InputLabel>
  <Input
    value={values.textmask}
    onChange={handleChange('textmask')}
    id="formatted-text-mask-input"
    inputComponent={TextMaskCustom}
  />
</FormControl>
<TextField
  className={classes.formControl}
  label="react-number-format"
  value={values.numberformat}
  onChange={handleChange('numberformat')}
  id="formatted-numberformat-input"
  InputProps={{
    inputComponent: NumberFormatCustom,
  }}
/>

The provided input component should handle the inputRef property. The property should be called with a value that implements the following interface:

interface InputElement {
  focus(): void;
  value?: string;
}

function MyInputComponent(props) {
  const { component: Component, inputRef, ...other } = props;

  // implement `InputElement` interface
  React.useImperativeHandle(inputRef, () => ({
    focus: () => {
      // logic to focus the rendered component from 3rd party belongs here
    },
    // hiding the value e.g. react-stripe-elements
  }));

  // `Component` will be your `SomeThirdPartyComponent` from below
  return <Component {...other} />;
}

// usage
<TextField
  InputProps={{
    inputComponent: MyInputComponent,
    inputProps: { component: SomeThirdPartyComponent },
  }}
/>;

Accessibility

In order for the text field to be accessible, the input should be linked to the label and the helper text. The underlying DOM nodes should have this structure.

<div class="form-control">
  <label for="my-input">Email address</label>
  <input id="my-input" aria-describedby="my-helper-text" />
  <span id="my-helper-text">We'll never share your email.</span>
</div>

• If you are using the TextField component, you just have to provide a unique id.
• If you are composing the component:

<FormControl>
  <InputLabel htmlFor="my-input">Email address</InputLabel>
  <Input id="my-input" aria-describedby="my-helper-text" />
  <FormHelperText id="my-helper-text">We'll never share your email.</FormHelperText>
</FormControl>

Complementary projects

For more advanced use cases you might be able to take advantage of:

• formik-material-ui Bindings for using Material-UI with formik.
• redux-form-material-ui A set of wrapper components to facilitate using Material UI with Redux Form.
• final-form-material-ui A set of wrapper components to facilitate using Material UI with Final Form.
• mui-rff A set of wrapper components to facilitate using Material UI with React Final Form.

API

• <FilledInput />
• <FormControl />
• <FormHelperText />
• <Input />
• <InputAdornment />
• <InputBase />
• <InputLabel />
• <OutlinedInput />
• <TextField />