Sign Up Form
逐步填写注册字段,并获得本地校验与明确提交状态。
适用场景
- 当界面需要以下行为时使用 Sign Up Form:逐步填写注册字段,并获得本地校验与明确提交状态。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/signup-form.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
packages/vue/src/blocks/signup-form/demo.vue
<script setup lang="ts">
import { onBeforeUnmount, ref } from "vue";
import { SignUpForm, type SignUpValues } from "@/components/orvui/blocks/signup-form";
const error = ref<string>();
let timer: ReturnType<typeof setTimeout> | undefined,
finish: (() => void) | undefined,
disposed = false;
async function submit(values: SignUpValues) {
error.value = undefined;
await new Promise<void>((resolve) => {
finish = resolve;
timer = setTimeout(() => {
finish = undefined;
resolve();
}, 1200);
});
if (disposed) return;
if (values.email.toLowerCase().startsWith("taken@")) {
error.value = "This address belongs to an existing demo account.";
throw new Error("Demo account already exists");
}
}
onBeforeUnmount(() => {
disposed = true;
clearTimeout(timer);
finish?.();
});
</script>
<template>
<div class="flex w-full justify-center py-4">
<SignUpForm
description="Use taken@example.com to preview a rejected signup."
:error-message="error"
:on-submit="submit"
><template #footer
>Have a workspace already?
<button
type="button"
class="font-medium text-foreground underline underline-offset-4"
>
Sign in
</button></template
></SignUpForm
>
</div>
</template>
packages/vue/src/blocks/signup-form/src/SignUpForm.vue
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
SignUpForm | v-modelSignUpValues | update:modelValue |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
modelValue?SignUpValuesoptions.valuesvalues?SignUpValues—defaultValues?Partial<SignUpValues>—validate?(values: SignUpValues) => SignUpErrorsdefaultValidatestatus?"success" | "idle" | "loading" | "error"localStatus.valueerrorMessage?string—title?boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>"Create your account"description?boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>"Start building in under a minute."submitLabel?string"Create account"footer?boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>—strengthMeter?booleantrueclassName?string—classNames?SignUpFormClassNames—onSubmit?(values: SignUpValues) => void | Promise<void>—事件
update:modelValue[values: SignUpValues]@update:modelValuevaluesChange[values: SignUpValues]@valuesChangesuccess[values: SignUpValues]@successerror[error: unknown]@error插槽
footer() => VNodeChild#footer无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 Sign Up Form?
- 通过 modelValue、values、defaultValues、validate、status、errorMessage、title、description、submitLabel、footer、strengthMeter、className、classNames、onSubmit 配置 Sign Up Form;API 表列出其类型与默认值。
- 如何连接到应用状态?
- 监听 update:modelValue、valuesChange、success、error,将组件连接到应用状态。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
请留意
部分组件参考了开源作品,相关署名与独立许可请参阅 NOTICE。
更新于
来源与许可 ↗MIT · 0.1.1