The MDC Text Field component provides a textual input field adhering to the Material Design Specification. It is fully accessible, ships with RTL support, and includes a gracefully-degraded version that does not require any javascript.
npm install --save @material/textfield
<div class="mdc-text-field">
<input type="text" id="my-text-field" class="mdc-text-field__input">
<label class="mdc-text-field__label" for="my-text-field">Hint text</label>
<div class="mdc-text-field__bottom-line"></div>
</div>It's also possible to wrap an input within a <label> to avoid dynamic id generation:
<label class="mdc-text-field">
<input type="text" class="mdc-text-field__input">
<span class="mdc-text-field__label">Hint Text</span>
<div class="mdc-text-field__bottom-line"></div>
</label>NOTE: Only place an
mdc-text-field__labelinside of a text field if you plan on using Javascript. Otherwise, the label must go outside of the text-field, as shown below.
<label for="text-field-no-js">TextField with no JS: </label>
<div class="mdc-text-field">
<input type="text" id="text-field-no-js" class="mdc-text-field__input" placeholder="Hint text">
<div class="mdc-text-field__bottom-line"></div>
</div><div class="mdc-text-field mdc-text-field--disabled">
<input type="text" id="disabled-text-field" class="mdc-text-field__input" disabled>
<label class="mdc-text-field__label" for="disabled-text-field">Disabled text field</label>
<div class="mdc-text-field__bottom-line"></div>
</div>When dealing with JS-driven text fields that already have values, you'll want to ensure that you
render the text field label with the mdc-text-field__label--float-above modifier class. This will
ensure that the label moves out of the way of the text field's value and prevents a Flash Of
Un-styled Content (FOUC). You'll also want to add the mdc-text-field--upgraded modifier class
on the text-field root element. The JS component does for you automatically on initialization, but
since it won't be added until that JS runs, adding it manually will prevent an initial FOUC.
<div class="mdc-text-field mdc-text-field--upgraded">
<input type="text" id="pre-filled" class="mdc-text-field__input" value="Pre-filled value">
<label class="mdc-text-field__label mdc-text-field__label--float-above" for="pre-filled">
Label in correct place
</label>
<div class="mdc-text-field__bottom-line"></div>
</div>MDC Text Fields can include helper text that is useful for providing supplemental information to users, as well for validation messages (covered below).
<div class="mdc-text-field">
<input type="text" id="username" class="mdc-text-field__input" aria-controls="username-helper-text">
<label for="username" class="mdc-text-field__label">Username</label>
<div class="mdc-text-field__bottom-line"></div>
</div>
<p id="username-helper-text" class="mdc-text-field-helper-text" aria-hidden="true">
This will be displayed on your public profile
</p>Helper text appears on input field focus and disappears on input field blur by default when using the text-field JS component.
If you'd like the helper text to always be visible, add the
mdc-text-field-helper-text--persistent modifier class to the element.
<div class="mdc-text-field">
<input type="email" id="email" class="mdc-text-field__input">
<label for="email" class="mdc-text-field__label">Email address</label>
<div class="mdc-text-field__bottom-line"></div>
</div>
<p class="mdc-text-field-helper-text mdc-text-field-helper-text--persistent">
We will <em>never</em> share your email address with third parties
</p>Note that in every example where the helper text is dependent on the state of the input element, we
assign an id to the mdc-text-field-helper-text element and set that id to the value of the
aria-controls attribute on the input element. We recommend doing this as well as it will help
indicate to assistive devices that the display of the helper text is dependent on the interaction with
the input element.
When using our vanilla JS component, if it sees that the input element has an aria-controls
attribute, it will look for an element with the id specified and treat it as the text field's help
text element, taking care of adding/removing aria-hidden and other a11y attributes. This can also
be done programmatically, which is described below.
MDC TextField provides validity styling by using the :invalid and :required attributes provided
by HTML5's form validation API.
<div class="mdc-text-field">
<input type="password" id="pw" class="mdc-text-field__input" required minlength=8>
<label for="pw" class="mdc-text-field__label">Password</label>
<div class="mdc-text-field__bottom-line"></div>
</div>By default an input's validity is checked via checkValidity() on blur, and the styles are updated
accordingly. Set the MDCTextField.valid variable to set the input's validity explicitly. MDC TextField
automatically appends an asterisk to the label text if the required attribute is set.
Helper text can be used to provide additional validation messages. Use
mdc-text-field-helper-text--validation-msg to provide styles for using the helper text as a validation
message. This can be easily combined with mdc-text-field-helper-text--persistent to provide a robust
UX for client-side form field validation.
<div class="mdc-text-field">
<input required minlength=8 type="password" class="mdc-text-field__input" id="pw"
aria-controls="pw-validation-msg">
<label for="pw" class="mdc-text-field__label">Choose password</label>
<div class="mdc-text-field__bottom-line"></div>
</div>
<p class="mdc-text-field-helper-text
mdc-text-field-helper-text--persistent
mdc-text-field-helper-text--validation-msg"
id="pw-validation-msg">
Must be at least 8 characters long
</p>Leading and trailing icons can be added to MDC Text Fields as visual indicators
as well as interaction targets. To do so, add the relevant classes
(mdc-text-field--with-leading-icon or mdc-text-field--with-trailing-icon) to the root element, add
an i element with your preferred icon, and give it a class of mdc-text-field__icon.
<div class="mdc-text-field mdc-text-field--box mdc-text-field--with-leading-icon">
<i class="material-icons mdc-text-field__icon" tabindex="0">event</i>
<input type="text" id="my-input" class="mdc-text-field__input">
<label for="my-input" class="mdc-text-field__label">Your Name</label>
<div class="mdc-text-field__bottom-line"></div>
</div><div class="mdc-text-field mdc-text-field--box mdc-text-field--with-trailing-icon">
<input type="text" id="my-input" class="mdc-text-field__input">
<label for="my-input" class="mdc-text-field__label">Your Name</label>
<i class="material-icons mdc-text-field__icon" tabindex="0">event</i>
<div class="mdc-text-field__bottom-line"></div>
</div>NOTE: if you would like to display un-clickable icons, simply remove
tabindex="0", and the css will ensure the cursor is set to default, and that actioning on an icon doesn't do anything unexpected.
<div class="mdc-text-field mdc-text-field--textarea">
<textarea id="textarea" class="mdc-text-field__input" rows="8" cols="40"></textarea>
<label for="textarea" class="mdc-text-field__label">Textarea Label</label>
</div><div class="mdc-text-field mdc-text-field--textarea">
<textarea id="textarea-css-only"
class="mdc-text-field__input"
rows="8"
cols="40"
placeholder="Enter something about yourself"></textarea>
</div><div class="mdc-text-field mdc-text-field--fullwidth">
<input class="mdc-text-field__input"
type="text"
placeholder="Full-Width TextField"
aria-label="Full-Width TextField">
</div>
<div class="mdc-text-field mdc-text-field--fullwidth mdc-text-field--textarea">
<textarea id="full-width-textarea" class="mdc-text-field__input" rows="8"></textarea>
<label for="full-width-textarea" class="mdc-text-field__label">Textarea Label</label>
</div>Note that full-width text fields do not support floating labels. Labels should not be included as part of the DOM structure for full-width text fields. Full-width textareas behave normally.
<div class="mdc-text-field mdc-text-field--box">
<input type="text" id="tf-box" class="mdc-text-field__input">
<label for="tf-box" class="mdc-text-field__label">Your Name</label>
<div class="mdc-text-field__bottom-line"></div>
</div>Note that Text field boxes support all of the same features as normal text-fields, including help text, validation, and dense UI.
<label for="css-only-text-field-box">Your name:</label>
<div class="mdc-text-field mdc-text-field--box">
<input type="text" class="mdc-text-field__input" id="css-only-text-field-box" placeholder="Name">
</div>To customize a Filled Text Field or a Text Field textarea's border radius, you can use the following mixins.
Alternatively, if you would like to change the border radius for every instance of MDC Text Field uniformly, regardless
of the variant, you can override $mdc-text-field-border-radius in Sass.
This mixin customizes the border radius for a Text Field Box.
This mixin customizes the border radius for a Text Field textarea.
MDC TextField ships with Component / Foundation classes which are used to provide a full-fidelity Material Design text field component.
import {MDCTextField, MDCTextFieldFoundation} from '@material/textfield';const mdcTextField = require('mdc-text-field');
const MDCTextField = mdcTextField.MDCTextField;
const MDCTextFieldFoundation = mdcTextField.MDCTextFieldFoundation;require(['path/to/mdc-textfield'], mdcTextField => {
const MDCTextField = mdcTextField.MDCTextField;
const MDCTextFieldFoundation = mdcTextField.MDCTextFieldFoundation;
});const MDCTextField = mdc.textField.MDCTextField;
const MDCTextFieldFoundation = mdc.textField.MDCTextFieldFoundation;mdc.textField.MDCTextField.attachTo(document.querySelector('.mdc-text-field'));import {MDCTextField} from '@material/textfield';
const textField = new MDCTextField(document.querySelector('.mdc-text-field'));When MDCTextField is instantiated with a root element containing the mdc-text-field--box class,
it instantiates an MDCRipple instance on the element in order to facilitate the correct
interaction UX for text field boxes as outlined in the spec. The way this ripple is instantiated
can be controlled by passing a ripple factory argument to the constructor.
const textFieldBoxEl = document.querySelector('.mdc-text-field--box');
const textField = new MDCTextField(textFieldBoxEl, /* foundation */ undefined, (el) => {
// do something with el...
return new MDCRipple(el);
});By default the ripple factory simply calls new MDCRipple(el) and returns the result.
Similar to regular DOM elements, the MDCTextField functionality is exposed through accessor
methods.
HTMLLabelElement. This is a normal property (non-accessor) that holds a reference to the element
being used as the text field's "helper text". It defaults to null. If the text field's input element
contains an aria-controls attribute on instantiation of the component, it will look for an element
with the corresponding id within the document and automatically assign it to this property.
String setter. Proxies to the foundation's setHelperTextContent method when set.
Boolean. Proxies to the foundation's isDisabled/setDisabled methods when retrieved/set
respectively.
Boolean setter. Proxies to the foundation's setValid method when set.
MDCRipple instance. Set to the MDCRipple instance for the root element that MDCTextField
initializes when given an mdc-text-field--box root element. Otherwise, the field is set to null.
Because MDC TextField is a feature-rich and relatively complex component, its adapter is a bit more complicated.
| Method Signature | Description |
|---|---|
| addClass(className: string) => void | Adds a class to the root element |
| removeClass(className: string) => void | Removes a class from the root element |
| addClassToLabel(className: string) => void | Adds a class to the label element. We recommend you add a conditional check here, and in removeClassFromLabel for whether or not the label is present so that the JS component could be used with text fields that don't require a label, such as the full-width text field. |
| removeClassFromLabel(className: string) => void | Removes a class from the label element |
| eventTargetHasClass(target: HTMLElement, className: string) => boolean | Returns true if classname exists for a given target element |
| registerTextFieldInteractionHandler(evtType: string, handler: EventListener) => void | Registers an event handler on the root element for a given event |
| deregisterTextFieldInteractionHandler(evtType: string, handler: EventListener) => void | Deregisters an event handler on the root element for a given event |
| notifyIconAction() => void | Emits a custom event "MDCTextField:icon" denoting a user has clicked the icon |
| addClassToBottomLine(className: string) => void | Adds a class to the bottom line element |
| removeClassFromBottomLine(className: string) => void | Removes a class from the bottom line element |
| addClassToHelperText(className: string) => void | Adds a class to the helper text element. Note that in our code we check for whether or not we have a helper text element and if we don't, we simply return. |
| removeClassFromHelperText(className: string) => void | Removes a class from the helper text element. |
| helperTextHasClass(className: string) => boolean | Returns whether or not the helper text element contains the current class |
| registerInputInteractionHandler(evtType: string, handler: EventListener) => void | Registers an event listener on the native input element for a given event |
| deregisterInputInteractionHandler(evtType: string, handler: EventListener) => void | Deregisters an event listener on the native input element for a given event |
| registerBottomLineEventHandler(evtType: string, handler: EventListener) => void | Registers an event listener on the bottom line element for a given event |
| deregisterBottomLineEventHandler(evtType: string, handler: EventListener) => void | Deregisters an event listener on the bottom line element for a given event |
| setHelperTextAttr(name: string, value: string) => void | Sets an attribute with a given value on the helper text element |
| removeHelperTextAttr(name: string) => void | Removes an attribute from the helper text element |
| setHelperTextContent(content: string) => void | Sets the content of the helper text element |
| getNativeInput() => {value: string, disabled: boolean, badInput: boolean, checkValidity: () => boolean}? | Returns an object representing the native text input element, with a similar API shape. The object returned should include the value, disabled and badInput properties, as well as the checkValidity() function. We never alter the value within our code, however we do update the disabled property, so if you choose to duck-type the return value for this method in your implementation it's important to keep this in mind. Also note that this method can return null, which the foundation will handle gracefully. |
| getBottomLineFoundation() => MDCTextFieldBottomLineFoundation | Returns the instance of the bottom line element's foundation |
Returns a boolean specifying whether or not the input is disabled.
Updates the input's disabled state.
Sets the validity state of the Text Field. Triggers custom validity checking.
Handles click and keydown events originating from inside the Text Field component.
Activates the focus state of the Text Field. Normally called in response to the input focus event.
Deactivates the focus state of the Text Field. Normally called in response to the input blur event.
Animates the bottom line. The animation expands outward from the user's click or touch. Expects an event with clientX/clientY properties.
Handles the end of the bottom line animation, performing actions that must wait for animations to finish. Expects a transition-end event.
MDC TextField components use the configured theme's primary color for its underline and label text when the input is focused.
MDC TextField components support dark themes.