MUI TextField: Build Variants, Colors & Styles

The mui textfield is a fundamental component in Material-UI, designed to capture user inputs efficiently and stylishly. This guide explores its build variants, extensive customization through colors and styles, and practical use cases to elevate your application's UI/UX.

Introduction to MUI TextField

The mui textfield provides a highly adaptable interface component for user inputs in web applications, supporting a range of styles, configurations, and user interactions. Whether you are collecting simple text inputs, passwords, or more complex multiline entries, mui textfield offers the flexibility to meet these needs with robust customization options.

Basic TextField

Material-UI offers three distinct build variants for the basic mui textfield each tailored for different UI preferences and user experiences:

1. Standard: Offers a minimalist approach with an underline that becomes prominent on focus. Ideal for clean, modern designs where the interface is not cluttered.
2. Filled: This variant introduces a light background fill and an underline that only appears when the field is active, adding a subtle touch of depth and emphasis.
3. Outlined: Features a full border around the text field, which enhances visibility on varied backgrounds and provides a clear demarcation for interactive elements.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// BasicTextFields Component: Demonstrates different TextField variants.
export default function BasicTextFields() {
  return (
    // Container component for form elements with specified margins and width
    <box component="form" sx="{{"> :not(style)': { m: 1, width: '25ch' } }} // Apply margin and width to each TextField
      noValidate // Disables browser validation
      autoComplete="off" // Disables autocomplete feature
    >
      {/* Outlined TextField: Uses a border to define the input area */}
      <textfield id="outlined-basic" label="Outlined" variant="outlined"></textfield>


      {/* Filled TextField: Includes a background fill to highlight the input area */}
      <textfield id="filled-basic" label="Filled" variant="filled"></textfield>


      {/* Standard TextField: Features a minimalist design with a bottom underline */}
      <textfield id="standard-basic" label="Standard" variant="standard"></textfield>
    </box>
  );
}

Form Props

The mui textfield is equipped to handle a variety of standard form attributes that enhance functionality and user interaction. These attributes include options like required, disabled, and type, which are essential for guiding user inputs and maintaining form integrity. Additionally, the helperText prop is particularly useful for providing context about a field’s input, explaining its utility or offering guidance on the expected format.

Following are the key Form Props:

• required: Marks the field as necessary, prompting users to fill it out before submitting a form. This is crucial for ensuring that all essential information is gathered.
• disabled: Temporarily disables the input field, making it non-interactive. This is useful in scenarios where certain conditions need to be met before user input can be accepted.
• type: Defines the type of data expected in the text field, such as text, password, or number. This helps in structuring the form data correctly and ensures that the user input matches the required format.
• helperText: Provides additional details or instructions associated with the input field. This can be used to clarify the purpose of the data or to guide users on how to fill out the form correctly.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// FormPropsTextFields Component: Showcases TextField with various props and states.
export default function FormPropsTextFields() {
  return (
    // Container for the form elements with specified margins and width
    <box component="form" sx="{{" .muitextfield-root m: width: novalidate disables html5 validation autocomplete="off" turns off auto-completion>
      {/* Section for Outlined TextFields with various configurations */}
      <div>
        <textfield required id="outlined-required" label="Required" defaultvalue="Hello World" pre-filled text></textfield>
        <textfield disabled id="outlined-disabled" label="Disabled" defaultvalue="Hello World" pre-filled text non-interactive></textfield>
        <textfield id="outlined-password-input" label="Password" type="password" hides the text input autocomplete="current-password"></textfield>
        <textfield id="outlined-read-only-input" label="Read Only" defaultvalue="Hello World" slotprops="{{" input: readonly: true non-editable input></textfield>
        <textfield id="outlined-number" label="Number" type="number" numeric input slotprops="{{" inputlabel: shrink: true configuration></textfield>
        <textfield id="outlined-search" label="Search field" type="search" optimized for search input></textfield>
        <textfield id="outlined-helperText" label="Helper text" defaultvalue="Default Value" helpertext="Some important text" additional information for the user></textfield>
      </div>
      {/* Section for Filled TextFields, similar configurations as above, different variant */}
      <div>
        <textfield required id="filled-required" label="Required" defaultvalue="Hello World" variant="filled"></textfield>
        <textfield disabled id="filled-disabled" label="Disabled" defaultvalue="Hello World" variant="filled"></textfield>
        // Remaining Filled TextFields omitted for brevity
      </div>
      {/* Section for Standard TextFields, similar configurations as above, different variant */}
      <div>
        <textfield required id="standard-required" label="Required" defaultvalue="Hello World" variant="standard"></textfield>
        <textfield disabled id="standard-disabled" label="Disabled" defaultvalue="Hello World" variant="standard"></textfield>
        // Remaining Standard TextFields omitted for brevity
      </div>
    </box>
  );
}

Multiline Text Fields

The multiline prop in the mui textfield is a powerful feature that transforms the standard text field into a TextareaAutosize element, making it ideal for inputs that require longer text entries such as comments, descriptions, or feedback forms. This feature is especially useful in forms where users need to provide detailed information that exceeds a single line of text.

For scenarios where you need more control over the size of the text field, you can use the minRows and maxRows props to set minimum and maximum boundaries for its height. This is particularly useful when you want to maintain a certain layout aesthetic or when dealing with form inputs that are expected to be within specific length constraints.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// MULTILINE TEXT FIELDS COMPONENT: Demonstrates various multiline TextField configurations.
export default function MultilineTextFields() {
  return (
    // Container for the multiline TextField elements with specified margins and width
    <box component="form" sx="{{" .muitextfield-root m: width: novalidate disables browser validation autocomplete="off" turns off auto-completion>
      {/* OUTLINED TEXTFIELDS GROUP */}
      <div>
        <textfield id="outlined-multiline-flexible" label="Multiline" multiline maxrows="{4}" allows flexible number of rows up to></textfield>
        <textfield id="outlined-textarea" label="Multiline Placeholder" placeholder="Placeholder" text for empty field multiline></textfield>
        <textfield id="outlined-multiline-static" label="Multiline" multiline rows="{4}" fixed number of defaultvalue="Default Value" pre-filled text></textfield>
      </div>


      {/* FILLED TEXTFIELDS GROUP */}
      <div>
        <textfield id="filled-multiline-flexible" label="Multiline" multiline maxrows="{4}" variant="filled" filled style></textfield>
        <textfield id="filled-textarea" label="Multiline Placeholder" placeholder="Placeholder" multiline variant="filled"></textfield>
        <textfield id="filled-multiline-static" label="Multiline" multiline rows="{4}" defaultvalue="Default Value" variant="filled"></textfield>
      </div>


      {/* STANDARD TEXTFIELDS GROUP */}
      <div>
        <textfield id="standard-multiline-flexible" label="Multiline" multiline maxrows="{4}" variant="standard" standard style></textfield>
        <textfield id="standard-textarea" label="Multiline Placeholder" placeholder="Placeholder" multiline variant="standard"></textfield>
        <textfield id="standard-multiline-static" label="Multiline" multiline rows="{4}" defaultvalue="Default Value" variant="standard"></textfield>
      </div>
    </box>
  );
}

Select

The select prop in mui textfield transforms the standard text field into a dropdown menu by integrating the Select component internally. This modification allows for seamless selection among predefined options, making it particularly useful in forms where users must choose from a set list.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';
import MenuItem from '@mui/material/MenuItem';


// Currency options for the select dropdown.
const currencies = [
  { value: 'USD', label: '$' },
  { value: 'EUR', label: '€' },
  { value: 'BTC', label: '฿' },
  { value: 'JPY', label: '¥' },
];


// SELECT TEXT FIELDS COMPONENT: Demonstrates TextField with select dropdowns.
export default function SelectTextFields() {
  return (
    // Container for the select TextField elements with specified margins and width
    <box component="form" sx="{{" .muitextfield-root m: width: novalidate disables browser validation autocomplete="off" turns off auto-completion>
      {/* OUTLINED SELECT TEXTFIELDS GROUP */}
      <div>
        <textfield id="outlined-select-currency" select label="Select" defaultvalue="EUR" pre-selected currency helpertext="Please select your currency" additional information for the user>
          {currencies.map((option) => (
            <menuitem key="{option.value}" value="{option.value}">
              {option.label}
            </menuitem>
          ))}
        </textfield>
        <textfield id="outlined-select-currency-native" select label="Native select" defaultvalue="EUR" slotprops="{{" select: native: true uses native element helpertext="Please select your currency">
          {currencies.map((option) => (
            <option key="{option.value}" value="{option.value}">
              {option.label}
            </option>
          ))}
        </textfield>
      </div>


      {/* FILLED SELECT TEXTFIELDS GROUP */}
      <div>
        <textfield id="filled-select-currency" select label="Select" defaultvalue="EUR" variant="filled" filled style helpertext="Please select your currency">
          {currencies.map((option) => (
            <menuitem key="{option.value}" value="{option.value}">
              {option.label}
            </menuitem>
          ))}
        </textfield>
        <textfield id="filled-select-currency-native" select label="Native select" defaultvalue="EUR" variant="filled" slotprops="{{" select: native: true helpertext="Please select your currency">
          {currencies.map((option) => (
            <option key="{option.value}" value="{option.value}">
              {option.label}
            </option>
          ))}
        </textfield>
      </div>


      {/* STANDARD SELECT TEXTFIELDS GROUP */}
      <div>
        <textfield id="standard-select-currency" select label="Select" defaultvalue="EUR" variant="standard" standard style helpertext="Please select your currency">
          {currencies.map((option) => (
            <menuitem key="{option.value}" value="{option.value}">
              {option.label}
            </menuitem>
          ))}
        </textfield>
        <textfield id="standard-select-currency-native" select label="Native select" defaultvalue="EUR" variant="standard" slotprops="{{" select: native: true helpertext="Please select your currency">
          {currencies.map((option) => (
            <option key="{option.value}" value="{option.value}">
              {option.label}
            </option>
          ))}
        </textfield>
      </div>
    </box>
  );
}

Input Adornments

Input Adornments in Material-UI's mui textfield offer a flexible way to incorporate additional elements like prefixes, suffixes, or interactive icons directly within the text field.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import IconButton from '@mui/material/IconButton';
import Input from '@mui/material/Input';
import FilledInput from '@mui/material/FilledInput';
import OutlinedInput from '@mui/material/OutlinedInput';
import InputLabel from '@mui/material/InputLabel';
import InputAdornment from '@mui/material/InputAdornment';
import FormHelperText from '@mui/material/FormHelperText';
import FormControl from '@mui/material/FormControl';
import TextField from '@mui/material/TextField';
import Visibility from '@mui/icons-material/Visibility';
import VisibilityOff from '@mui/icons-material/VisibilityOff';


// INPUT ADORNMENTS COMPONENT: Demonstrates various ways to use Input Adornments with TextField and FormControl.
export default function InputAdornments() {
  const [showPassword, setShowPassword] = React.useState(false);


  const handleClickShowPassword = () => setShowPassword((show) => !show);
  const handleMouseDownPassword = (event) => event.preventDefault();
  const handleMouseUpPassword = (event) => event.preventDefault();


  return (
    <box sx="{{" display: flexwrap:>
      {/* OUTLINED VARIANT GROUP */}
      <div>
        <textfield label="With normal TextField" id="outlined-start-adornment" sx="{{" m: width: inputprops="{{" startadornment: position="start">kg,
          }}
        />
        <formcontrol sx="{{" m: width: variant="outlined">
          <outlinedinput id="outlined-adornment-weight" endadornment="{<InputAdornment" position="end">kg}
            aria-describedby="outlined-weight-helper-text"
          />
          <formhelpertext id="outlined-weight-helper-text">Weight</formhelpertext>
        </outlinedinput></formcontrol>
        <formcontrol sx="{{" m: width: variant="outlined">
          <inputlabel htmlfor="outlined-adornment-password">Password</inputlabel>
          <outlinedinput id="outlined-adornment-password" type="{showPassword" : endadornment="{" position="end">
                <iconbutton aria-label="toggle password visibility" onclick="{handleClickShowPassword}" onmousedown="{handleMouseDownPassword}" onmouseup="{handleMouseUpPassword}" edge="end">
                  {showPassword ? <visibilityoff></visibilityoff> : <visibility></visibility>}
                </iconbutton>
              
            }
            label="Password"
          />
        </outlinedinput></formcontrol>
        <formcontrol fullwidth sx="{{" m:>
          <inputlabel htmlfor="outlined-adornment-amount">Amount</inputlabel>
          <outlinedinput id="outlined-adornment-amount" startadornment="{<InputAdornment" position="start">$}
            label="Amount"
          />
        </outlinedinput></formcontrol>
      </textfield>
</div>
      {/* FILLED VARIANT GROUP */}
      <div>
        <textfield label="With normal TextField" id="filled-start-adornment" sx="{{" m: width: inputprops="{{" startadornment: position="start">kg,
          }}
          variant="filled"
        />
        <formcontrol sx="{{" m: width: variant="filled">
          <filledinput id="filled-adornment-weight" endadornment="{<InputAdornment" position="end">kg}
            aria-describedby="filled-weight-helper-text"
          />
          <formhelpertext id="filled-weight-helper-text">Weight</formhelpertext>
        </filledinput></formcontrol>
        <formcontrol sx="{{" m: width: variant="filled">
          <inputlabel htmlfor="filled-adornment-password">Password</inputlabel>
          <filledinput id="filled-adornment-password" type="{showPassword" : endadornment="{" position="end">
                <iconbutton aria-label="toggle password visibility" onclick="{handleClickShowPassword}" onmousedown="{handleMouseDownPassword}" onmouseup="{handleMouseUpPassword}" edge="end">
                  {showPassword ? <visibilityoff></visibilityoff> : <visibility></visibility>}
                </iconbutton>
              
            }
          />
        </filledinput></formcontrol>
        <formcontrol fullwidth sx="{{" m: variant="filled">
          <inputlabel htmlfor="filled-adornment-amount">Amount</inputlabel>
          <filledinput id="filled-adornment-amount" startadornment="{<InputAdornment" position="start">$}
          />
        </filledinput></formcontrol>
      </textfield>
</div>
      {/* STANDARD VARIANT GROUP */}
      <div>
        <textfield label="With normal TextField" id="standard-start-adornment" sx="{{" m: width: inputprops="{{" startadornment: position="start">kg,
          }}
          variant="standard"
        />
        <formcontrol variant="standard" sx="{{" m: mt: width:>
          <input id="standard-adornment-weight" endadornment="{<InputAdornment" position="end">kg}
            aria-describedby="standard-weight-helper-text"
          />
          <formhelpertext id="standard-weight-helper-text">Weight</formhelpertext>
        </formcontrol>
        <formcontrol sx="{{" m: width: variant="standard">

         <input id="standard-adornment-password" type="{showPassword" : endadornment="{" position="end">
            <iconbutton aria-label="toggle password visibility" onclick="{handleClickShowPassword}" onmousedown="{handleMouseDownPassword}" onmouseup="{handleMouseUpPassword}">
              {showPassword ? <visibilityoff></visibilityoff> : <visibility></visibility>}
            </iconbutton>
          
        }
      />
    </formcontrol>
    <formcontrol fullwidth sx="{{" m: variant="standard">
      <inputlabel htmlfor="standard-adornment-amount">Amount</inputlabel>
      <input id="standard-adornment-amount" startadornment="{<InputAdornment" position="start">$}
      />
    </formcontrol>
  </textfield>
</div>
</box>
)
};

Margin

The margin prop in the mui textfield component is a practical attribute that allows you to control the vertical spacing of the text field within a form. This can be crucial for achieving the desired layout and ensuring that the form is visually appealing.

The margin prop accepts three values: none, dense, and normal. Each of these settings adjusts the amount of space around the text field, affecting how compact or spread out the form elements appear.

• none (default): Applies no additional margin to the TextField. This setting is useful when you want to handle spacing through other means, such as using grid systems or custom CSS.
• dense: Reduces the amount of vertical space around the text field. This is ideal for forms where space is limited or when many elements need to be displayed without overwhelming the user.
• normal: Increases the vertical spacing for better readability and separation between fields. This setting is often used in forms where clarity and ease of use are prioritized.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// RedBar Component: Displays a red horizontal bar to visually separate elements.
function RedBar() {
  return (
    // Styling applied using a function to access the theme for conditional styles
    <box sx="{(theme)"> ({
        height: 20, // Fixed height for the bar
        backgroundColor: 'rgba(255, 0, 0, 0.1)', // Light red background color
        ...theme.applyStyles('dark', { // Conditional style application for dark themes
          backgroundColor: 'rgb(255 132 132 / 25%)',
        }),
      })}
    />
  );
}


// LayoutTextFields Component: Demonstrates TextField components with different margin settings.
export default function LayoutTextFields() {
  return (
    <box sx="{{" display: flexbox container for layout flexdirection: arranges children vertically .muitextfield-root width: standard width applied to all textfields>
      <redbar></redbar>
      <textfield label="{'margin="none"'}" id="margin-none"></textfield> // TextField with no margin
      <redbar></redbar>
      <textfield label="{'margin="dense"'}" id="margin-dense" margin="dense"></textfield> // TextField with dense margin for tighter spacing
      <redbar></redbar>
      <textfield label="{'margin="normal"'}" id="margin-normal" margin="normal"></textfield> // TextField with normal margin for standard spacing
      <redbar></redbar>
    </box>
  );
}
</box>

Controlled vs. Uncontrolled Components

In React, components like mui textfield can be either controlled or uncontrolled, which refers to how their state is managed.

• A controlled TextField is managed by state and props within a parent component, offering precise value handling and updates.
• Conversely, an uncontrolled TextField maintains its own internal state, initialized with defaultValue, simplifying setup but offering less direct control over its state.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// StateTextFields Component: Demonstrates the use of controlled and uncontrolled TextField components.
export default function StateTextFields() {
  // State hook for controlling the TextField value
  const [name, setName] = React.useState('Cat in the Hat');


  return (
    // Container for the form elements with specific margin and width styles
    <box component="form" sx="{{"> :not(style)': { m: 1, width: '25ch' } }} // Apply margin and width to each TextField
      noValidate // Disables browser validation
      autoComplete="off" // Turns off auto-completion
    >
      {/* CONTROLLED TEXTFIELD */}
      <textfield id="outlined-controlled" label="Controlled" for the textfield value="{name}" controlled linked to state onchange="{(event)"> {
          setName(event.target.value); // Update state based on input
        }}
      />
      {/* UNCONTROLLED TEXTFIELD */}
      <textfield id="outlined-uncontrolled" label="Uncontrolled" for the textfield defaultvalue="foo" initial value uncontrolled></textfield>
    </textfield></box>
  );
}

Inputs

Material-UI's Input component provides a streamlined way to handle user inputs in forms. It supports various states such as default values, placeholders, disabled inputs, and error handling.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import Input from '@mui/material/Input';


// Accessibility label configuration for inputs.
const ariaLabel = { 'aria-label': 'description' };


// Inputs Component: Demonstrates various configurations of MUI Input components.
export default function Inputs() {
  return (
    // Form container that applies margin to each input and disables browser validation and autocomplete.
    <box component="form" sx="{{"> :not(style)': { m: 1 } }} // Margin applied to all direct children except <style> elements
      noValidate // Disables HTML form validation.
      autoComplete="off" // Prevents the browser from auto-filling input fields.
    >
      {/* STANDARD INPUT */}
      <Input
        defaultValue="Hello world" // Sets initial value for the input
        inputProps={ariaLabel} // Accessibility properties
      />
      {/* INPUT WITH PLACEHOLDER */}
      <Input
        placeholder="Placeholder" // Displays placeholder text when the input is empty
        inputProps={ariaLabel} // Accessibility properties
      />
      {/* DISABLED INPUT */}
      <Input
        disabled // Disables the input field
        defaultValue="Disabled" // Sets initial value for the input
        inputProps={ariaLabel} // Accessibility properties
      />
      {/* ERROR INPUT */}
      <Input
        defaultValue="Error" // Sets initial value for the input
        error // Indicates an error with a visual cue
        inputProps={ariaLabel} // Accessibility properties
      />
    </style></box>
  );
}

Color

The color prop changes the highlight color of the text field when focused.

Implementation with Code:

import * as React from 'react';
import Box from '@mui/material/Box';
import TextField from '@mui/material/TextField';


// ColorTextFields Component: Demonstrates TextField components styled with various color schemes.
export default function ColorTextFields() {
  return (
    // Form container applying margin and width to each TextField component
    <box component="form" sx="{{"> :not(style)': { m: 1, width: '25ch' } }} // Specifies margin and width for direct children
      noValidate // Disables HTML5 validation
      autoComplete="off" // Disables browser auto-completion
    >
      {/* OUTLINED TEXTFIELD WITH SECONDARY COLOR */}
      <textfield label="Outlined secondary" text for the textfield color="secondary" applies secondary theme focused keeps visually></textfield>
      {/* FILLED TEXTFIELD WITH SUCCESS COLOR */}
      <textfield label="Filled success" text for the textfield variant="filled" uses filled of color="success" applies success theme often green focused keeps visually></textfield>
      {/* STANDARD TEXTFIELD WITH WARNING COLOR */}
      <textfield label="Standard warning" text for the textfield variant="standard" uses standard minimal styling color="warning" applies warning theme often yellow or orange focused keeps visually></textfield>
    </box>
  );
}

Conclusion

Throughout this guide, we've explored the diverse capabilities of the MUI TextField component, covering its variants, styles, colors, and additional functionalities like select options and input adornments.

1. Variants and Styles: We discussed how different TextField variants like standard, filled, and outlined can be utilized to meet specific design needs, enhancing the form's usability and appearance.
2. Functionality Enhancements: By leveraging props such as select and input adornments, TextField can be transformed to accommodate more complex user interactions, such as selecting from dropdowns or adding icons for improved functionality.
3. Form Management: The distinction between controlled and uncontrolled components was highlighted, emphasizing their roles in managing form state and interactions in React applications.
4. Basic Inputs: The simplicity and flexibility of the MUI Input component were showcased, demonstrating how it can handle various input states to streamline user form interactions.

The versatility of MUI components allows developers to build comprehensive, responsive, and accessible user interfaces. For further customization and deeper understanding, refer to the official Material-UI documentation.

The above is the detailed content of MUI TextField: Build Variants, Colors & Styles. For more information, please follow other related articles on the PHP Chinese website!