PlaceholderAPI/ExamplesGithub

Generates virtual placeholders on input.


    Browser Support

    Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
    Yes 8+ Yes Yes Yes

    Features

    • Creates on elements of every input type including textarea.
    • Adds on elements an user's class name for customizing.
    • Keeps the placeholder when the input element is focused elements in IE10+ browsers.

    Examples

    • Basic: Example of using default options.
    • Dynamic creation : Example of handling placeholders for dynamically added or deleted elements.

    More examples can be found on the left sidebar of each example page, and have fun with it.


    Install

    TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

    Via Package Manager

    TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

    npm
    $ npm install --save tui-placeholder # Latest version
    $ npm install --save tui-placeholder@<version> # Specific version
    bower
    $ bower install tui-placeholder # Latest version
    $ bower install tui-placeholder#<tag> # Specific version

    Via Contents Delivery Network (CDN)

    TOAST UI products are available over the CDN powered by TOAST Cloud.

    You can use the CDN as below.

    <script src="https://uicdn.toast.com/tui.placeholder/latest/tui-placeholder.js"></script>
    

    If you want to use a specific version, use the tag name instead of latest in the url's path.

    The CDN directory has the following structure.

    tui.placeholder/
    ├─ latest/
    │  ├─ tui-placeholder.js
    │  └─ tui-placeholder.min.js
    ├─ v2.1.0/
    │  ├─ ...

    Download Source Files


    Usage

    HTML

    This component requires a target elements.

    <input type="text" placeholder="Enter your name" />
    
    <input type="number" placeholder="Enter your phone number" />
    

    JavaScript

    This component does not use the instance created through the constructor function. First, you should import the module using one of the following ways depending on your environment.

    Using namespace in browser environment
    var placeholder = tui.placeholder;
    
    Using module format in node environment
    var placeholder = require('tui-placeholder'); /* CommonJS */
    
    import {placeholder} from 'tui-placeholder'; /* ES6 */
    

    Then you should call the generate method with options to create virtual placeholders.

    var targets = document.getElementByTags('input');
    
    placeholder.generate(targets, { ... });
    

    For more information about the API, please see here.


    Documents

    You can also see the older versions of API page on the releases page.


    Contributing


    License

    This software is licensed under the MIT © NHN Entertainment.