Text field character counter
Character counter is used if there is a character limit. It displays the ratio of characters used and the total character limit.
Basic usage
HTML structure
<div class="mdc-text-field-character-counter">0 / 140</div>
NOTE: Place this inside .mdc-text-field-helper-line
for single line mdc text field which is an immediate sibling of .mdc-text-field
and
place it as first element of .mdc-text-field
for multi-line text field variant (textarea).
Styles
@use "@material/textfield/character-counter";
@include character-counter.character-counter-core-styles;
JavaScript instantiation
import {MDCTextFieldCharacterCounter} from '@material/textfield/character-counter';
const characterCounter = new MDCTextFieldCharacterCounter(document.querySelector('.mdc-text-field-character-counter'));
API
CSS classes
CSS Class |
Description |
mdc-text-field-character-counter |
Mandatory. |
Sass mixins
Mixin |
Description |
mdc-text-field-character-counter-color($color) |
Customizes the color of the character counter associated with an enabled text field. |
mdc-text-field-disabled-character-counter-color($color) |
Customizes the color of the character counter associated with a disabled text field. |
mdc-text-field-character-counter-position($xOffset, $yOffset) |
Positions the character counter element inside text field. Used only for textarea variant. |
MDCTextFieldCharacterCounter
properties and methods
Property |
Value Type |
Description |
foundation |
MDCTextFieldCharacterCounterFoundation |
Returns the character counter's foundation. This allows the parent MDCTextField component to access the public methods on the MDCTextFieldCharacterCounterFoundation class. |
Usage within frameworks
If you are using a JavaScript framework, such as React or Angular, you can create a Character Counter for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.
MDCTextFieldCharacterCounterAdapter
Method Signature |
Description |
setContent(content: string) => void |
Sets the text content of character counter element. |
MDCTextFieldCharacterCounterFoundation
Method Signature |
Description |
setCounterValue(currentLength: number, maxLength: number) => void |
Sets the character counter values including characters used and total character limit. |