superplaceholder.js [](http://badge.fury.io/js/superplaceholder)
=====
*Super charge your input placeholders*
***
[DEMO](http://kushagragour.in/lab/superplaceholderjs) • [Installation](#installation) • [Usage](#usage)
superplaceholder.js is a library to bring your input placeholders to life by cycling multiple instructions in a single input placeholder.
Installation
-----
**superplaceholder.js** is *less than 1KB* minified & gzipped.
- Bower: `bower install superplaceholder`
- NPM: `npm install superplaceholder`
- [Download zip](https://github.com/chinchang/superplaceholder.js/archive/master.zip).
**Note**: **superplaceholder.js** supports AMD and commonJS module pattern out of the box.
Usage
-----
### Syntax
```js
superplaceholder({
el: ,
sentences: ,
options: {} // optional customizable parameters
});
```
### Basic
```js
superplaceholder({
el: document.querySelector('input'),
sentences: [ 'Something to show', 'Another thing to show']
});
```
### Customization
Pass an optional `options` object for custom settings.
```js
superplaceholder({
el: document.querySelector('input'),
sentences: [ 'Something to show', 'Another thing to show'],
options: {
// delay between letters (in milliseconds)
letterDelay: 100, // milliseconds
// delay between sentences (in milliseconds)
sentenceDelay: 1000,
// should start on input focus. Set false to autostart
startOnFocus: true,
// loop through passed sentences
loop: false,
// Initially shuffle the passed sentences
shuffle: false,
// Show cursor or not. Shows by default
showCursor: true,
// String to show as cursor
cursor: '|'
}
});
```
Browser Support
-----
**superplaceholder.js** works best on latest versions of Google Chrome, Firefox and Safari and Chrome mobile.
For all non-supported browsers, the library will graceful degradate without any explicit handling in your code.
Contributing
-----
Interested in contributing features and fixes?
[Read more on contributing](./CONTRIBUTING.md).
Changelog
-----
See the [Changelog](https://github.com/chinchang/superplaceholder.js/wiki/Changelog).
License
-----
Copyright (c) 2018 Kushagra Gour, http://kushagragour.in
This work is licensed under a [Creative Commons Attribution-NoDerivatives 4.0 International License](http://creativecommons.org/licenses/by-nd/4.0/).