OTP Input
通过分组输入框键入或粘贴固定长度验证码,并获取完成反馈。
适用场景
- 当界面需要以下行为时使用 OTP Input:通过分组输入框键入或粘贴固定长度验证码,并获取完成反馈。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/otp-input.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
Enter 123456 to verify.
packages/vue/src/blocks/otp-input/demo.vue
<script setup lang="ts">
import { ref } from "vue";
import { OTPInput, type OTPStatus } from "@/components/orvui/blocks/otp-input";
const code = ref("");
const verification = ref<OTPStatus>("idle");
function verify(value: string) {
verification.value = value === "123456" ? "success" : "error";
}
function reset() {
verification.value = "idle";
}
</script>
<template>
<div class="flex flex-col items-center gap-4">
<OTPInput
v-model="code"
:status="verification"
label="Verification code"
hint="Enter 123456 to verify."
success-message="Verified."
error-message="Wrong code, try again."
@change="reset"
@complete="verify"
/>
</div>
</template>
packages/vue/src/blocks/otp-input/src/OTPInput.vue
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
OTPInput | v-modelstring | update:modelValue |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
length?number6modelValue?stringprops.valuevalue?string—defaultValue?string""label?string—hint?string—successMessage?string—errorMessage?string—status?"success" | "idle" | "error""idle"mask?booleanfalsedisabled?booleanfalseautoFocus?booleanfalseariaLabel?string"One-time passcode"className?string—事件
update:modelValue[value: string]@update:modelValuechange[value: string]@changecomplete[value: string]@complete无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 OTP Input?
- 通过 length、modelValue、value、defaultValue、label、hint、successMessage、errorMessage、status、mask、disabled、autoFocus、ariaLabel、className 配置 OTP Input;API 表列出其类型与默认值。
- 如何连接到应用状态?
- 监听 update:modelValue、change、complete,将组件连接到应用状态。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
请留意
部分组件参考了开源作品,相关署名与独立许可请参阅 NOTICE。
更新于
来源与许可 ↗MIT · 0.1.1