@material/floating-label
Advanced tools
@material/floating-label is a package from the Material Components for the Web (MDC Web) library. It provides a floating label component that can be used in form fields to enhance user experience by animating the label when the input field is focused or filled.
Basic Floating Label
This code snippet demonstrates how to create a basic floating label using the @material/floating-label package. The label will float above the input field when the field is focused or filled.
<div class="mdc-floating-label" id="my-label-id">My Label</div>Floating Label with Input
This example shows how to use the floating label in conjunction with an input field. The label will float above the input field when the user interacts with it.
<div class="mdc-text-field">
<input type="text" class="mdc-text-field__input" aria-labelledby="my-label-id">
<label class="mdc-floating-label" id="my-label-id">My Label</label>
</div>JavaScript Initialization
This code demonstrates how to initialize the floating label component using JavaScript. This is useful for adding dynamic behavior to the floating label.
import { MDCFloatingLabel } from '@material/floating-label';
const floatingLabel = new MDCFloatingLabel(document.querySelector('.mdc-floating-label'));react-floating-label-input is a React component that provides similar functionality to @material/floating-label. It allows you to create floating labels for input fields in a React application. Unlike @material/floating-label, which is part of the MDC Web library, react-floating-label-input is specifically designed for React.
floating-label-react is another React component for creating floating labels. It offers similar features to @material/floating-label but is tailored for use in React applications. It provides a simple API for integrating floating labels with input fields.
vue-mdc-adapter is a library that integrates Material Components for the Web with Vue.js. It includes a floating label component similar to @material/floating-label. This package is ideal for Vue.js developers who want to use Material Design components in their applications.
Floating labels display the type of input a field requires. Every Text Field and Select should have a label, except for full-width text fields, which use the input's placeholder attribute instead. Labels are aligned with the input line and always visible. They can be resting (when a field is inactive and empty) or floating. The label is a text caption or description for the Text Field.
npm install @material/floating-label
<span class="mdc-floating-label" id="my-label-id">Hint text</span>
@use "@material/floating-label/mdc-floating-label";
import {MDCFloatingLabel} from '@material/floating-label';
const floatingLabel = new MDCFloatingLabel(document.querySelector('.mdc-floating-label'));
| CSS Class | Description |
|---|---|
mdc-floating-label | Mandatory. |
mdc-floating-label--float-above | Indicates the label is floating in the floating position. |
mdc-floating-label--shake | Shakes the label. |
| Mixin | Description |
|---|---|
ink-color($color) | Customizes the ink color of the label. |
fill-color($color) | Customizes the fill color of the label. |
shake-keyframes($modifier, $positionY, $positionX, $scale) | Generates a CSS @keyframes at-rule for an invalid label shake. Used in conjunction with the shake-animation mixin. |
shake-animation($modifier) | Applies shake keyframe animation to label. |
float-position($positionY, $positionX, $scale) | Sets position of label when floating. |
max-width($max-width) | Sets the max width of the label. |
MDCFloatingLabel Properties and Methods| Method Signature | Description |
|---|---|
shake(shouldShake: boolean) => void | Proxies to the foundation's shake() method. |
float(shouldFloat: boolean) => void | Proxies to the foundation's float() method. |
getWidth() => number | Proxies to the foundation's getWidth() method. |
If you are using a JavaScript framework, such as React or Angular, you can create a Floating Label 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.
MDCFloatingLabelAdapter| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the label element. |
removeClass(className: string) => void | Removes a class from the label element. |
getWidth() => number | Returns the width of the label element. |
registerInteractionHandler(evtType: string, handler: EventListener) => void | Registers an event listener for a given event. |
deregisterInteractionHandler(evtType: string, handler: EventListener) => void | Deregisters an event listener for a given event. |
MDCFloatingLabelFoundation| Method Signature | Description |
|---|---|
shake(shouldShake: boolean) | Shakes or stops shaking the label, depending on the value of shouldShake. |
float(shouldFloat: boolean) | Floats or docks the label, depending on the value of shouldFloat. |
getWidth() => number | Returns the width of the label element. |
6.0.0 (2020-04-22)
[@use](https://github.com/use) (098ae32)indeterminate checkbox (b273afa)select: HTML Markup significantly changed, see README; REMOVED adapter methods isSelectedTextFocused, getSelectedTextAttr, setSelectedTextAttr; ADDED adapter methods isSelectAnchorFocused, getSelectAnchorAttr, setSelectAnchorAttr; removed variables outlined-dense-label-position-y, icon-padding; added variables minimum-height-for-filled-label, filled-baseline-top, selected-text-height, anchor-padding-left, anchor-padding-left-with-leading-icon, anchor-padding-right.
text-field: Redundant mixins mdc-text-field-textarea-fill-color, mdc-text-field-textarea-stroke-color, mdc-text-field-fullwidth-bottom-line-color removed. Instead, use mdc-text-field-fill-color, mdc-text-field-outline-color, and mdc-text-field-bottom-line-color respectively to achieve the same effect.
textfield: mdc-text-field--dense and associated mixins/variables have been removed. Use the density() mixin instead.
textfield: removed the following variables: $input-padding, $input-padding-top, $input-padding-bottom, $outlined-input-padding-top, $outlined-input-padding-bottom, $input-border-bottom
linear-progress: DOM for linear progress buffer changed. MDCLinearProgressAdapter method getBuffer, getPrimaryBar, setStyle removed. MDCLinearProgressAdapter method setBufferBarStyle, setPrimaryBarStyle added.
linear-progress: DOM for linear progress buffer changed. MDCLinearProgressAdapter method getBuffer, getPrimaryBar, setStyle removed. MDCLinearProgressAdapter method setBufferBarStyle, setPrimaryBarStyle added.
typography: typography.baseline-top() and typography.baseline-bottom() are now private. Use typography.baseline() for containers and typography.text-baseline() for text with $top and $bottom params.
chips: The touch target and text now appear inside the primary action element. Please see the readme for markup changes.
textfield: filled text fields must include a <div class="mdc-text-field__ripple"></div>
textfield: Filled textfields will no longer show a floating label at certain densities. This can be overridden by setting $mdc-text-field-minimum-height-for-filled-label: 40px
chips: Both MDCChipAdapter and MDCChipSetAdapter have new methods. MDCChipSetFoundation event handlers now accept the corresponding chip event detail interface as the sole argument. The root property has been removed from the MDCChipRemovalEventDetail interface.
line-ripple: mdc-line-ripple-color() mixin has been renamed to mdc-line-ripple-active-color()
textfield: Default textfields must now specify mdc-text-field--filled. Disabled outlined textfields no longer have a shaded background. Height mixin no longer specifies a baseline override, use typography's baseline-top mixin.
Four variables and a mixin in mdc-textfield were renamed to use a mdc-text-field- prefix when depended on via @import (formerly mdc-required-text-field-label-asterisk_, now required-label-asterisk_).
textfield: icons must use .mdc-text-field__icon--leading or .mdc-text-field__icon--trailing classes. mdc-text-field-icon-color() mixin has been split into mdc-text-field-leading-icon-color() and mdc-text-field-trailing-icon-color().
switch: Added setNativeControlAttr method in mdc-switch adapter.
checkbox: remove event listener for 'change' and add event listener for 'click'.
$mdc-button-disabled-container-fill-color
renamed to $mdc-button-disabled-container-color.$edgeOptOut option from mdc-theme-prop() Sass mixin.FAQs
The Material Components for the web floating-label component
The npm package @material/floating-label receives a total of 649,948 weekly downloads. As such, @material/floating-label popularity was classified as popular.
We found that @material/floating-label demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.