Skip to content
On this page

Text field

Material Web catalog**

Text fields let users enter text into a UI.

Types

  1. Filled text field
  2. Outlined text field

Usage

Text fields behave like <input> elements. They provide a container with labels for user input.

A filled textfield next to an outlined textfield. Both have a value of Value
prefilled

html
<md-filled-text-field label="Label" value="Value">
</md-filled-text-field>

<md-outlined-text-field label="Label" value="Value">
</md-outlined-text-field>

Input type

A text field's type attribute changes how the text field works, such as displaying a different keyboard or providing default validation.

Two filled textfields next to each other. The first has a label of Username
and the outlined one has a label of Password

html
<md-filled-text-field label="Username" type="email">
</md-filled-text-field>

<md-filled-text-field label="Password" type="password">
</md-filled-text-field>

Tip: use the inputmode attribute for more control over the displayed keyboard.

Labels

Text fields should label their value with a floating label, a placeholder, or an external label. Labels help the user understand what value to input.

Three outlined textfields next to each other. the first has a label of
Favorite food, the second one a placeholder of email@domain.com and there is a
label that says First name and an empty outlined textfield next to
it

html
<md-outlined-text-field label="Favorite food">
</md-outlined-text-field>

<md-outlined-text-field placeholder="[email protected]">
</md-outlined-text-field>

<div>First name</div>
<md-outlined-text-field aria-label="First name">
</md-outlined-text-field>

Note: text fields do not currently support aria-labelledby. External labels must provide an aria-label. See b/276484803.

Textarea

Multi-line text fields behave like <textarea> elements.

Textareas can specify the initial number of rows. Use CSS width, height, and resize to control the resize behavior of a textarea.

A filled textarea that is vertically larger and has a label that says Vertical
resize

html
<style>
  md-filled-text-field {
    resize: vertical;
  }
</style>
<md-filled-text-field
    type="textarea"
    label="Vertical resize"
    rows="3">
</md-filled-text-field>

Icons

Text fields may display optional icons. Use icons to describe the input method (such as a search icon), provide additional functionality (such as a clear icon), or to express errors.

Three outlined textfields next to each other the first has a search icon at
the start the label Search Messages, the second a label that says Password and
an eye icon toggle button at the end, and a red, visually errored outlined
textfield with the label Username with an exclamation icon at the end and helper
error text under the field that says Username not
available

html
<md-outlined-text-field placeholder="Search for messages">
  <md-icon slot="leading-icon">search</md-icon>
</md-outlined-text-field>

<md-outlined-text-field label="Password" type="password">
  <md-icon-button toggle slot="trailing-icon">
    <md-icon>visibility</md-icon>
    <md-icon slot="selected">visibility_off</md-icon>
  </md-icon-button>
</md-outlined-text-field>

<md-outlined-text-field
    label="Username"
    error
    error-text="Username not available">
  <md-icon slot="trailing-icon">error</md-icon>
</md-outlined-text-field>

Prefix and suffix

Add prefix-text and suffix-text attributes to text fields to display additional context for the value.

An outlined textfield with a floating label that says Dollar amount, a prefix
dollar sign, the number zero as a value and a suffix of decimal zero zero at the
end of the field

html
<md-outlined-text-field
    label="Dollar amount"
    type="number"
    value="0"
    prefix-text="$"
    suffix-text=".00">
</md-outlined-text-field>

Supporting text

Supporting text conveys additional information about the input field, such as how it will be used. Supporting text can be replaced with error text when validating.

Two filled fields next to each other. The first has a label that says comments
and supporting text under the field that says Provide comments for the issue.
The second field has a label of Name with an asterisk and supporting text under
the field that has an asterisk followed by the word
required

html
<md-filled-text-field
    label="Comments"
    supporting-text="Provide comments for the issue">
</md-filled-text-field>

<md-filled-text-field
    label="Name"
    required
    supporting-text="*required"
    error-text="Please fill out this field">
</md-filled-text-field>

Character counter

Text fields with a maxlength attribute will display a character counter.

An outlined textfield with a floating label that says Title and a filled value
that says Short and the text 5 / 10 under the field at the
end

html
<md-outlined-text-field label="Title" value="Short" maxlength="10">
</md-outlined-text-field>

Validation

Text fields that validate can use constraint validation or manual validation.

Constraint validation

Text fields may validate using the browser's constraint validation API. Each input type above links to an article that describes how to validate it.

Text fields in a <form> will validate on submission, or by calling textField.reportValidity().

html
<form>
  <md-filled-text-field
      name="name"
      label="Name"
      required>
  </md-filled-text-field>
  <md-filled-text-field
      name="email"
      label="Email"
      pattern="[\w\d-]+"
      suffix-text="@gmail.com">
  </md-filled-text-field>
</form>

Use the following properties and methods to check and report validation errors.

Manual validation

Alternatively, text fields can manually control their error state and error message. Use manual validation if the text fields are driven by application state logic.

html
<md-outlined-text-field
    label="Username"
    value="jdoe"
    error
    error-text="Username is not available">
</md-outlined-text-field>

Tip: Prefer constraint validation when possible for more platform features, such as <form> validation and listening to invalid events.

Accessibility

Add an aria-label attribute to text fields with external labels or text fields whose labels need to be more descriptive.

html
<div>Username</div>
<md-filled-text-field aria-label="Username"></md-filled-text-field>

<md-filled-text-field label="First" aria-label="First name"></md-filled-text-field>

Filled text field

Filled and outlined text fields are functionally identical. See choosing a text field for guidance on which one to use.

html
<md-filled-text-field label="Filled" value="Value"></md-filled-text-field>

Outlined text field

Filled and outlined text fields are functionally identical. See choosing a text field for guidance on which one to use.

html
<md-outlined-text-field label="Outlined" value="Value"></md-outlined-text-field>

Theming

Text fields support Material theming and can be customized in terms of color, typography, and shape.

Filled text field tokens

TokenDefault value
--md-filled-text-field-container-shape--md-sys-shape-corner-extra-small
--md-filled-text-field-container-color--md-sys-color-surface-container-highest
--md-filled-text-field-focus-active-indicator-color--md-sys-color-primary
--md-filled-text-field-input-text-font--md-sys-typescale-body-large-font
--md-filled-text-field-label-text-font--md-sys-typescale-body-large-font

Filled text field example

A filled text field with the label filled themed to a greenish color

html
<style>
:root {
  --md-filled-text-field-container-shape: 0px;
  --md-sys-typescale-body-large: 400 1rem system-ui;
  --md-sys-color-primary: #006a6a;
  --md-sys-color-surface-container-highest: #e0e3e2;
  --md-filled-text-field-label-text-color: #3f4948;
  --md-filled-text-field-input-text-color: #161d1d;
}
</style>

<md-filled-text-field label="Filled" value="Value">
</md-filled-text-field>

Outlined text field tokens

TokenDefault value
--md-outlined-text-field-container-shape--md-sys-shape-corner-extra-small
--md-outlined-text-field-focus-outline-color--md-sys-color-primary
--md-outlined-text-field-input-text-font--md-sys-typescale-body-large-font
--md-outlined-text-field-label-text-font--md-sys-typescale-body-large-font

Outlined text field example

An outlined text field with the label outlined themed to a greenish color

html
<style>
:root {
  --md-outlined-text-field-container-shape: 0px;
  --md-sys-typescale-body-large: 400 1rem system-ui;
  --md-sys-color-primary: #006a6a;
  --md-outlined-text-field-label-text-color: #3f4948;
  --md-outlined-text-field-input-text-color: #161d1d;
}
</style>

<md-outlined-text-field label="Outlined" value="Value"></md-outlined-text-field>

API

MdFilledTextField <md-filled-text-field>

Properties

PropertyAttributeTypeDefaultDescription
errorerrorbooleanfalseGets or sets whether or not the text field is in a visually invalid state.
This error state overrides the error state controlled by reportValidity().
errorTexterror-textstring''The error message that replaces supporting text when error is true. If errorText is an empty string, then the supporting text will continue to show.
This error message overrides the error message displayed by reportValidity().
labellabelstring''The floating Material label of the textfield component. It informs the user about what information is requested for a text field. It is aligned with the input text, is always visible, and it floats when focused or when text is entered into the textfield. This label also sets accessibilty labels, but the accessible label is overriden by aria-label.
Learn more about floating labels from the Material Design guidelines: https://m3.material.io/components/text-fields/guidelines
noAsteriskno-asteriskbooleanfalseDisables the asterisk on the floating label, when the text field is required.
requiredrequiredbooleanfalseIndicates that the user must specify a value for the input before the owning form can be submitted and will render an error state when reportValidity() is invoked when value is empty. Additionally the floating label will render an asterisk "*" when true.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
valuevaluestring''The current value of the text field. It is always a string.
prefixTextprefix-textstring''An optional prefix to display before the input value.
suffixTextsuffix-textstring''An optional suffix to display after the input value.
hasLeadingIconhas-leading-iconbooleanfalseWhether or not the text field has a leading icon. Used for SSR.
hasTrailingIconhas-trailing-iconbooleanfalseWhether or not the text field has a trailing icon. Used for SSR.
supportingTextsupporting-textstring''Conveys additional information below the text field, such as how it should be used.
textDirectiontext-directionstring''Override the input text CSS direction. Useful for RTL languages that use LTR notation for fractions.
rowsrowsnumber2The number of rows to display for a type="textarea" text field. Defaults to 2.
colscolsnumber20The number of cols to display for a type="textarea" text field. Defaults to 20.
inputModeinputmodestring''
maxmaxstring''Defines the greatest value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max
maxLengthmaxlengthnumber-1The maximum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength
minminstring''Defines the most negative value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min
minLengthminlengthnumber-1The minimum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength
noSpinnerno-spinnerbooleanfalseWhen true, hide the spinner for type="number" text fields.
patternpatternstring''A regular expression that the text field's value must match to pass constraint validation.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern
placeholderplaceholderstring''Defines the text displayed in the textfield when it has no value. Provides a brief hint to the user as to the expected type of data that should be entered into the control. Unlike label, the placeholder is not visible and does not float when the textfield has a value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder
readOnlyreadonlybooleanfalseIndicates whether or not a user should be able to edit the text field's value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly
multiplemultiplebooleanfalseIndicates that input accepts multiple email addresses.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/email#multiple
stepstepstring''Returns or sets the element's step attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step
typetypestring'text'The <input> type to use, defaults to "text". The type greatly changes how the text field behaves.
Text fields support a limited number of <input> types:
- text - textarea - email - number - password - search - tel - url
See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types for more details on each input type.
autocompleteautocompletestring''Describes what, if any, type of autocomplete functionality the input should provide.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
disabledbooleanundefined
namestringundefined
selectionDirectionstringundefined
selectionEndnumberundefined
selectionStartnumberundefined
valueAsNumbernumberundefined
valueAsDateDateundefined

Methods

MethodParametersReturnsDescription
selectNonevoidSelects all the text in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select
setRangeTextargsvoid
setSelectionRangestart, end, directionvoidSets the start and end positions of a selection in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange
stepDownstepDecrementvoidDecrements the value of a numeric type text field by step or n step number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown
stepUpstepIncrementvoidIncrements the value of a numeric type text field by step or n step number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp
resetNonevoidReset the text field to its default value.
formResetCallbackNonevoid
formStateRestoreCallbackstatevoid

Events

EventTypeBubblesComposedDescription
selectEventYesNoThe native select event on <input>
changeEventYesNoThe native change event on <input>
inputInputEventYesYesThe native input event on <input>

MdOutlinedTextField <md-outlined-text-field>

Properties

PropertyAttributeTypeDefaultDescription
errorerrorbooleanfalseGets or sets whether or not the text field is in a visually invalid state.
This error state overrides the error state controlled by reportValidity().
errorTexterror-textstring''The error message that replaces supporting text when error is true. If errorText is an empty string, then the supporting text will continue to show.
This error message overrides the error message displayed by reportValidity().
labellabelstring''The floating Material label of the textfield component. It informs the user about what information is requested for a text field. It is aligned with the input text, is always visible, and it floats when focused or when text is entered into the textfield. This label also sets accessibilty labels, but the accessible label is overriden by aria-label.
Learn more about floating labels from the Material Design guidelines: https://m3.material.io/components/text-fields/guidelines
noAsteriskno-asteriskbooleanfalseDisables the asterisk on the floating label, when the text field is required.
requiredrequiredbooleanfalseIndicates that the user must specify a value for the input before the owning form can be submitted and will render an error state when reportValidity() is invoked when value is empty. Additionally the floating label will render an asterisk "*" when true.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
valuevaluestring''The current value of the text field. It is always a string.
prefixTextprefix-textstring''An optional prefix to display before the input value.
suffixTextsuffix-textstring''An optional suffix to display after the input value.
hasLeadingIconhas-leading-iconbooleanfalseWhether or not the text field has a leading icon. Used for SSR.
hasTrailingIconhas-trailing-iconbooleanfalseWhether or not the text field has a trailing icon. Used for SSR.
supportingTextsupporting-textstring''Conveys additional information below the text field, such as how it should be used.
textDirectiontext-directionstring''Override the input text CSS direction. Useful for RTL languages that use LTR notation for fractions.
rowsrowsnumber2The number of rows to display for a type="textarea" text field. Defaults to 2.
colscolsnumber20The number of cols to display for a type="textarea" text field. Defaults to 20.
inputModeinputmodestring''
maxmaxstring''Defines the greatest value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max
maxLengthmaxlengthnumber-1The maximum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength
minminstring''Defines the most negative value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min
minLengthminlengthnumber-1The minimum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength
noSpinnerno-spinnerbooleanfalseWhen true, hide the spinner for type="number" text fields.
patternpatternstring''A regular expression that the text field's value must match to pass constraint validation.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern
placeholderplaceholderstring''Defines the text displayed in the textfield when it has no value. Provides a brief hint to the user as to the expected type of data that should be entered into the control. Unlike label, the placeholder is not visible and does not float when the textfield has a value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder
readOnlyreadonlybooleanfalseIndicates whether or not a user should be able to edit the text field's value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly
multiplemultiplebooleanfalseIndicates that input accepts multiple email addresses.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/email#multiple
stepstepstring''Returns or sets the element's step attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step
typetypestring'text'The <input> type to use, defaults to "text". The type greatly changes how the text field behaves.
Text fields support a limited number of <input> types:
- text - textarea - email - number - password - search - tel - url
See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types for more details on each input type.
autocompleteautocompletestring''Describes what, if any, type of autocomplete functionality the input should provide.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
disabledbooleanundefined
namestringundefined
selectionDirectionstringundefined
selectionEndnumberundefined
selectionStartnumberundefined
valueAsNumbernumberundefined
valueAsDateDateundefined

Methods

MethodParametersReturnsDescription
selectNonevoidSelects all the text in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select
setRangeTextargsvoid
setSelectionRangestart, end, directionvoidSets the start and end positions of a selection in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange
stepDownstepDecrementvoidDecrements the value of a numeric type text field by step or n step number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown
stepUpstepIncrementvoidIncrements the value of a numeric type text field by step or n step number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp
resetNonevoidReset the text field to its default value.
formResetCallbackNonevoid
formStateRestoreCallbackstatevoid

Events

EventTypeBubblesComposedDescription
selectEventYesNoThe native select event on <input>
changeEventYesNoThe native change event on <input>
inputInputEventYesYesThe native input event on <input>
Text field has loaded