float-labels.js
Advanced tools
Readme
A zero-dependency plugin that applies the float label pattern to a form.
The float label pattern floats the inline label up above the input after the user focuses on the form field or enters a value.
For production, use the files from the dist/ folder.
Use one of the following methods to add Float Labels to your project:
yarn add float-labels.jsnpm install float-labels.jsbower install float-labels.jsLoad the dist/float-labels.css and dist/float-labels.min.js files somewhere on your page and then trigger the plugin as follows:
// You may pass in a CSS selector, an HTMLElement or a DomList
var floatlabels = new FloatLabels( 'form', {
// options go here
});
To re-initialize Float Labels after it has already been initialized (e.g. form fields have changed with ajax):
floatlabels.rebuild();
To fully remove Float Labels, including all attached Event Listeners:
floatlabels.destroy();
Make sure your HTML markup is valid. Your form fields must have labels, the labels must have the for attribute which should have the same value as the field id attribute. Also input fields must have a type attribute.
<label for="input-1">Enter a title</label>
<input type="text" id="input-1"/>
<label for="textarea-1">Enter some content</label>
<textarea id="textarea-1" placeholder="Placeholders are optional"></textarea>
<label for="select-1">Select an option</label>
<select id="select-1">
<option value="1">Option 1</option>
<option value="2">Option 2</option>
<option value="3">Option 3</option>
</select>
Here are the default options
{
customEvent : null,
customLabel : null,
customPlaceholder: null,
exclude : '.no-label',
inputRegex : /email|number|password|search|tel|text|url/,
prefix : 'fl-',
prioritize : 'label',
requiredClass : 'required',
style : 0,
transform : 'input, select, textarea',
}
transform option to know which element tags to transform.inputRegex option.exclude option are discarded.Type: Function
This function is run immediately after an element has been transformed by float-labels.
customEvent: function( el ) {
// do something
},
Type: Function
This function lets you modify the generated label text; it must return a string value.
customLabel: function( labelEl, el ) {
return labelEl.textContent;
},
Type: Function
This function lets you modify the generated placeholder text; it must return a string value.
customPlaceholder: function( placeholderText, el, labelEl ) {
return placeholderText;
},
Type: String
A comma-separated string of DOM selector elements to exclude.
Type: Regex
Regex of INPUT types to transform.
Type: String
The prefix of all the Float Label CSS classes.
If you change the prefix, you will need to either write your own custom CSS, or change the prefix option in the SCSS to match.
Type: String
Choose to prioritize either the label or placeholder text as the floating-label.
Type: String
The class name of required elements (if not using the required attribute).
Type: Number|String
Choose the style to use, the default value is either 0, 1, or 2. This is used to create the Float Labels style classname (i.e. .fl-style-1). If you have created your own CSS style (i.e. .fl-style-custom), enter it here (i.e. custom).
Type: String
A comma-separated string of DOM elements to transform. Available options are: input, select, and textarea.
Float Labels uses yarn to manage package dependencies and gulp to build from src/.
yarn
gulp
The compiled files will be saved in the dist/ folder.
Sass is used to build the stylesheet so you can @import the src/float-labels.scss file to compile it directly into your Sass project.
Following are the default sass values for Float Labels, they are contained in a map variable.
$float-labels-defaults: (
base-height : 24px,
base-padding : 6px,
border-radius : 3px,
border-width : 1px,
margin-bottom : 24px,
color-background : #fff,
color-background-active : #fff,
color-background-focus : #fff,
color-border : #dfdfdf,
color-border-active : #dfdfdf,
color-border-focus : #1976D2,
color-placeholder : #bbb,
color-required : #D32F2F,
color-text : #444,
color-text-focus : #1976D2,
line-height : 1.5,
font-size : 16px,
font-size-small : 12px,
font-weight : 400,
parent : '',
prefix : 'fl-',
transition-easing : ease-in-out,
transition-speed : 0.2s,
);
To override any values with your own, simply create a new $float-labels map variable and include only the values you wish to change.
Important: Make sure you define $float-labels before you import the src/float-labels.scss file:
$float-labels: (
border-radius : 0,
border-width : 2px,
color-border-focus : #009688,
color-text-focus : #009688,
font-weight : 700,
);
@import "../../node_modules/float-labels.js/src/float-labels"
Sometimes existing CSS stylesheet rules will override the styling of Float Labels. To solve this problem, you can specify a "parent" option in the $float-labels map variable. This option value should be property such as an existing #id definition with a high priority/specificity.
In the following example, all Float Labels css rules will begin with form#my-form:
$float-labels: (
parent: 'form#my-form',
);
The CSS rule .fl-form label.fl-label { ... } now becomes form#my-form.fl-form label.fl-label { ... }.
All changes should be committed to the files in src/.
v3.3.9 - [2019-06-04]
<body dir="rtl">)v3.3.8 - [2019-02-07]
v3.3.6 - [2018-10-09]
v3.3.5 - [2018-08-14]
v3.3.4 - [2018-05-25]
v3.3.3 - [2018-01-30]
v3.3.2 - [2018-01-06]
v3.3.0 - [2017-11-11]
v3.2.1 - [2017-10-27]
v3.2.0 - [2017-08-21]
v3.1.0 - [2017-08-09]
v3.0.3 - [2017-08-09]
v3.0.2 - [2017-08-08]
v2.1.0 - [2017-08-07]
v2.0.2 - [2017-07-14]
v2.0.1 - [2017-01-23]
v2.0.0 - [2017-01-11]
v1.0.9 - [2016-08-06]
v1.0.8 - [2016-01-31]
v1.0.7 - [2015-09-23]
placeholder="" attribute from the label text if it doesn't existdata-tooltip="" attribute to the label if it existspriority for placeholder/labelv1.0.6 - [2015-09-23]
v1.0.0 - [2015-09-03]
FAQs
A zero-dependency plugin that applies the float label pattern to a form.
The npm package float-labels.js receives a total of 681 weekly downloads. As such, float-labels.js popularity was classified as not popular.
We found that float-labels.js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.