@material/mwc-textfield NPM

`<mwc-textfield>`

IMPORTANT: The Material Web Components are a work in progress and subject to major changes until 1.0 release.

Text fields let users enter and edit text.

Installation

npm install @material/mwc-textfield

NOTE: The Material Web Components are distributed as ES2017 JavaScript Modules, and use the Custom Elements API. They are compatible with all modern browsers including Chrome, Firefox, Safari, Edge, and IE11, but an additional tooling step is required to resolve bare module specifiers, as well as transpilation and polyfills for IE11. See here for detailed instructions.

Example usage

Standard / Filled

<mwc-textfield label="My Textfield"></mwc-textfield>

<script type="module">
  import '@material/mwc-textfield/mwc-textfield.js';
</script>

Icon - Leading

<mwc-textfield label="My Textfield" icon="event"></mwc-textfield>

<script type="module">
  import '@material/mwc-textfield/mwc-textfield.js';
  import '@material/mwc-icon/mwc-icon-font.js';
</script>

Icon - Trailing

<mwc-textfield label="My Textfield" iconTrailing="delete"></mwc-textfield>

Helper Text

<mwc-textfield label="My Textfield" helper="Helper Text"></mwc-textfield>

Primary Color

<style>
  mwc-textfield {
    --mdc-theme-primary: green;
  }
</style>

<mwc-textfield
    label="My Textfield"
    iconTrailing="delete"
    required>
</mwc-textfield>

Variants

Outlined

<mwc-textfield
    outlined
    label="My Textfield"
    iconTrailing="delete">
</mwc-textfield>

Shaped

<style>
  mwc-textfield.rounded {
    --mdc-shape-small: 28px;
  }
</style>

<mwc-textfield
    class="rounded"
    label="My Textfield"
    outlined>
</mwc-textfield>

API

Properties/Attributes

Name	Type	Description
`value`	`string`	The input control's value.
`type`	`TextFieldType*`	A string specifying the type of control to render.
`label`	`string`	Sets floating label value.
`placeholder`	`string`	Sets disappearing input placeholder.
`prefix`	`string`	Prefix text to display before the input.
`suffix`	`string`	Suffix text to display after the input.
`icon`	`string`	Leading icon to display in input. See `mwc-icon`.
`iconTrailing`	`string`	Trailing icon to display in input. See `mwc-icon`.
`disabled`	`boolean`	Whether or not the input should be disabled.
`charCounter`	`boolean`	Note: requries `maxLength` to be set. Display character counter with max length.
`outlined`	`boolean`	Whether or not to show the material outlined variant.
`helper`	`string`	Helper text to display below the input. Display default only when focused.
`helperPersistent`	`boolean`	Always show the helper text despite focus.
`required`	`boolean`	Displays error state if value is empty and input is blurred.
`maxLength`	`number`	Maximum length to accept input.
`validationMessage`	`string`	Message to show in the error color when the textfield is invalid. (Helper text will not be visible)
`pattern`	`string`	`HTMLInputElement.prototype.pattern` (empty string will unset attribute)
`min`	`number`\|`string`	`HTMLInputElement.prototype.min` (empty string will unset attribute)
`max`	`number`\|`string`	`HTMLInputElement.prototype.max` (empty string will unset attribute)
`size`	`number`\|`null`	`HTMLInputElement.prototype.size` (null will unset attribute)
`step`	`number`\|`null`	`HTMLInputElement.prototype.step` (null will unset attribute)
`autoValidate`	`boolean`	Reports validity on value change rather than only on blur.
`validity`	`ValidityState` (readonly)	The `ValidityState` of the textfield.
`willValidate`	`boolean` (readonly)	`HTMLInputElement.prototype.willValidate`
`validityTransform`	`ValidityTransform**`\|`null`	Callback called before each validation check. See the validation section for more details.
`validateOnInitialRender`	`boolean`	Runs validation check on initial render.
`name`	`string`	Sets the `name` attribute on the internal input.***

* TextFieldType is exported by mwc-textfield and mwc-textfield-base

type TextFieldType = 'text'|'search'|'tel'|'url'|'email'|'password'|
    'date'|'month'|'week'|'time'|'datetime-local'|'number'|'color';

** ValidityTransform is not exported. See the validation section for more details.

type ValidityTransform = (value: string, nativeValidity: ValidityState) => Partial<ValidityState>

*** The name property should only be used for browser autofill as webcomponent form participation does not currently consider the name attribute. See #289.

Methods

Name	Description
`checkValidity() => boolean`	Returns `true` if the textfield passes validity checks. Returns `false` and fires an `invalid` event on the textfield otherwise. NOTE: When accessing any property or function that checks validity at textfield initial boot up, you may have to await `<mwc-textfield>.updateComplete`.
`reportValidity() => boolean`	Runs `checkValidity()` method, and if it returns false, then it reports to the user that the input is invalid.
`setCustomValidity(message:string) => void`	Sets a custom validity message (also overwrites `validationMessage`). If this message is not the empty string, then the element is suffering from a custom validity error and does not validate.
`layout() => Promise<void>`	Re-calculate layout. If a textfield is styled with `display:none` before it is first rendered, and it has a label that is floating, then you must call `layout()` the first time you remove `display:none`, or else the notch surrounding the label will not render correctly.

CSS Custom Properties

Inherits CSS Custom properties from:

Name	Default	Description
`--mdc-text-field-filled-border-radius`	`4px 4px 0 0`	Border radius of the standard / filled textfield's background filling.
`--mdc-text-field-idle-line-color`	`rgba(0, 0, 0, 0.42)`	Color of the filled textfield's bottom line when idle.
`--mdc-text-field-hover-line-color`	`rgba(0, 0, 0, 0.87)`	Color of the filled textfield's bottom line when hovering.
`--mdc-text-field-disabled-line-color`	`rgba(0, 0, 0, 0.06)`	Color of the filled textfield's bottom line when disabled.
`--mdc-text-field-outlined-idle-border-color`	`rgba(0, 0, 0, 0.38)`	Color of the outlined textfield's outline when idle.
`--mdc-text-field-outlined-hover-border-color`	`rgba(0, 0, 0, 0.87)`	Color of the outlined textfield's outline when hovering.
`--mdc-text-field-outlined-disabled-border-color`	`rgba(0, 0, 0, 0.06)`	Color of the outlined textfield's outline when disabled.
`--mdc-text-field-fill-color`	`rgb(245, 245, 245)`	Color of the textfield's background fill (non-outlined).
`--mdc-text-field-disabled-fill-color`	`rgb(250, 250, 250)`	Color of the textfield's background fill (non-outlined) when disabled.
`--mdc-text-field-ink-color`	`rgba(0, 0, 0, 0.87)`	Color of the input text.
`--mdc-text-field-label-ink-color`	`rgba(0, 0, 0, 0.6)`	Color of the non-focused floating label, helper text, char counter, and placeholder.
`--mdc-text-field-disabled-ink-color`	`rgba(0, 0, 0, 0.37)`	Color of the input text, the floating label, helper text, char counter, and placeholder of a disabled textfield.

Global Custom Properties

This component exposes the following global theming custom properties.

Name	Description
`--mdc-theme-primary`	Color when active of the underline ripple, the outline, and the caret.
`--mdc-theme-error`	Color when errored of the underline, the outline, the caret, and the icons.
`--mdc-typography-subtitle1-<PROPERTY>`	Styles the typography of the textfield.

Validation

<mwc-textfield> follows the basic <input> constraint validation model. It exposes:

required
maxLength
pattern
min
max
step
validity
willValidate
checkValidity()
reportValidity()
setCustomValidity(message)

Additionally, it implements more features such as:

validationMessage
validateOnInitialRender
and validityTransform

By default, <mwc-textfield> will report validation on blur.

Custom validation logic

The validityTransform property is a function that can be set on <mwc-textfield> to implement custom validation logic that transforms the ValidityState of the input control. The type of a ValidityTransform is the following:

(value: string, nativeValidity: ValidityState) => Partial<ValidityState>

Where value is the new value in the textfield to be validated and nativeValidity is an interface of ValidityState of the native input control. For example:

<mwc-textfield
    id="my-textfield"
    pattern="[0-9]+"
    value="doggos">
</mwc-textfield>
<script>
  const textfield = document.querySelector('#my-textfield');
  textfield.validityTransform = (newValue, nativeValidity) => {
    if (!nativeValidity.valid) {
      if (nativeValidity.patternMismatch) {
        const hasDog = newValue.includes('dog');
        // changes to make to the nativeValidity
        return {
          valid: hasDog,
          patternMismatch: !hasDog;
        };
      } else {
        // no changes
        return {};
      }
    } else {
      const isValid = someExpensiveOperation(newValue);
      // changes to make to the native validity
      return {
        valid: isValid,
        // or whatever type of ValidityState prop you would like to set (if any)
        customError: !isValid,
      };
    }
  }
</script>

In this example we first check the native validity which is invalid due to the pattern mismatching (the value is doggos which is not a number). The value includes dog, thus we make it valid and undo the pattern mismatch.

<mwc-textfield>