material-web/packages/textfield

<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.

Material Design Guidelines: text fields

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 Edge and IE11. See here for detailed instructions.

Example usage

Standard / Filled

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

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

Icon - Leading

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

<script type="module">
  import '@material/mwc-textfield';
  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>

Shaping Outlined

<style>
  mwc-textfield.left {
    --mdc-notched-outline-leading-width: 28px;
    --mdc-notched-outline-leading-border-radius: 28px 0 0 28px;
  }

  mwc-textfield.right {
    --mdc-notched-outline-trailing-border-radius: 0 28px 28px 0;
  }
</style>

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

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

<mwc-textfield
    class="left right";
    label="My Textfield"
    iconTrailing="delete"
    outlined>
</mwc-textfield>

Fullwidth

<!-- Note: Fullwidth does not support label; only placeholder -->
<mwc-textfield fullwidth placeholder="Standard" helper="Helper Text"></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.
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.
required	boolean	Displays error state if value is empty and input is blurred.
maxlength	number	Maximum length to accept input.
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.
fullwidth	boolean	Whether or not to make the input fullwidth. No longer displays label; only placeholder and helper.
helper	string	Helper text to display below the input. Display default only when focused.
helperPersistent	boolean	Always show the helper text despite focus.

* 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';

CSS Custom Properties

Inherits CSS Custom properties from:

• mwc-ripple
• mwc-notched-outline.
• mwc-icon

Name	Default	Description
--mdc-theme-primary	#6200ee	Color when active of the underline ripple, the outline, and the caret.
--mdc-theme-error	#b00020	Color when errored of the underline, the outline, the caret, and the icons.
--mdc-text-field-filled-border-radius	4px 4px 0 0	Border radius of the standard / filled textfield's background filling.
--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.

Additional references

• MDC Web textfields