Tailwind CSS PIN Input Plugin API

Installation

To get started, install Pin Input plugin via npm, else you can skip this step if you are already using Preline UI as a package.

1. Install the plugin

   Install @preline/pin-input via npm

   Terminal

                             
                               npm i @preline/pin-input
                             
                           

2. Add the plugin CSS

   Use @source to register the plugin's JavaScript path for Tailwind CSS scanning, then @import the plugin's CSS files into your Tailwind CSS file.

   main.css

                             
                               @import "tailwindcss";
                               
                               /* @preline/pin-input */
                               /* [!code highlight:3] */
                               @source "../node_modules/@preline/pin-input/*.js";
                               @import "./node_modules/@preline/pin-input/variants.css";
                               @import "./node_modules/@preline/pin-input/theme.css";
                             
                           

3. Add the plugin JavaScript

   Include the JavaScript <script> that powers the interactive elements near the end of your </body> tag:

   HTML

   <script src="./node_modules/@preline/pin-input/index.js"></script>

   ---

   Additional Initialization Options

   Use the non-auto entry if you need manual initialization. In this mode, automatic initialization on page load is not included, so the component should be initialized explicitly.

   HTML (non-auto)

   <script type="module"> // [!code highlight:3] import HSPinInput from "@preline/pin-input/non-auto.mjs"; new HSPinInput(document.querySelector("#pin-input")); </script>

   ---

   Via bundler

   When using a bundler (Vite, webpack, etc.), import the plugin directly as an ES module.

   JavaScript (auto)

                             
                               import "@preline/pin-input";
                             
                           

   JavaScript (non-auto)

                             
                               import HSPinInput from "@preline/pin-input/non-auto";
                               
                               HSPinInput.autoInit();
                               
                               // Or initialize a specific element manually
                               const el = document.querySelector("#pin-input");
                               if (el) new HSPinInput(el);
                             
                           

Example

Wrap the PIN Input's toggle data-hs-pin-input-item within data-hs-pin-input.

Basic usage

Prefer to create your own style? Here is a completely unstylized example.

                      
                        <div data-hs-pin-input>
                          <input type="text" data-hs-pin-input-item>
                          <input type="text" data-hs-pin-input-item>
                          <input type="text" data-hs-pin-input-item>
                          <input type="text" data-hs-pin-input-item>
                        </div>
                      
                    

Class Options

Tailwind Modifiers

Methods

The HSPinInput object is contained within the global window object

                      
                        const { element } = HSPinInput.getInstance('#pin-input', true);
                        const destroyBtn = document.querySelector('#destroy-btn');
                        
                        destroyBtn.addEventListener('click', () => {
                          element.destroy();
                        });
                      
                    

Events

                      
                        const el = HSPinInput.getInstance('#pin-input');

                        el.on('completed', ({currentValue}) => {...});
                      
                    

Ready to use Components

PIN Input

Explore ready-to-use Tailwind CSS examples built with Preline UI.

View PIN Input examples