vue3-otp-input-field
v1.0.4
Published
Customizable OTP input field component for Vue 3
Downloads
385
Maintainers
Readme
Vue-Vite 3 OTP Input Field
Customizable OTP input field component for Vue 3 Vite.
Recommended to use with Vue Vite. Because Vue(without Vite) does not accept the emit funcitons as node package.
Preview
Demo
Installation
To install:
npm i vue3-otp-input-field
OR
yarn add vue3-otp-input-field
OR
Without Build Tools
<script src="https://unpkg.com/vue3-otp-input-field"></script>
Usage
In your desired component add the OTP component with required props
<script setup>
import { ref } from "vue";
import { OTP } from "vue3-otp-input-field";
function logOtpValue(val = []) {
code.value = val;
}
const code = ref([]);
const fieldSize = ref(6);
function handleSubmit() {
console.log(code.value);
}
</script>
<template>
<OTP
size="medium"
:fields="fieldSize"
inputstyle="width: 80px; height: 50px; font-size: 40px; margin: 3px; border-radius: 5px;"
type="mix"
className="example-class-name"
@OTPValueChanged="logOtpValue"
/>
<div class="card">
<button type="button" @click="handleSubmit">Submit</button>
</div>
<h1>{{ code }}</h1>
</template>
<style scoped></style>
Props parameters
| Prop/Attribute | Type | Description |
| ------------------ | ---------- | ------------------------------------------------------------------------------ |
| size
| string
| Size of the OTP component ("small"
, "medium"
, "large"
) |
| :fields
| number
| Specify the number of input box |
| inputstyle
| string
| Styles applied to each input field (CSS inline styles) |
| type
| string
| Type of OTP ("number"
, "mix"
) |
| className
| string
| Additional class name(s) for styling or customization |
| @OTPValueChanged
| function
| Event handler for OTP value change (Vue.js event binding). Its a Emit function |
Contribute
Contributions are always welcome!