AntDesign Blazor 弹窗表单校验实现详解

在 AntDesign Blazor 项目中，弹窗(Modal)与表单(Form)的结合使用是一个常见需求，特别是在需要进行数据校验的场景下。本文将详细介绍如何在 AntDesign Blazor 中实现一个带有校验功能的弹窗表单。

基本结构

弹窗表单的基本结构由 Modal 组件包裹 Form 组件构成。Modal 负责弹窗的显示/隐藏，Form 则处理表单的提交和校验逻辑。

<Modal Title="表单标题" @bind-Visible="@_visible" Footer="null">
    <Form Model="@model"
          OnFinish="OnFinish"
          OnFinishFailed="OnFinishFailed">
        <!-- 表单内容 -->
    </Form>
</Modal>

关键实现点

1. Modal 属性配置

   • @bind-Visible：双向绑定控制弹窗显示/隐藏
   • Footer="null"：隐藏默认底部按钮区域，以便自定义

2. Form 属性配置

   • Model：绑定表单数据模型
   • OnFinish：表单验证成功回调
   • OnFinishFailed：表单验证失败回调

完整示例代码

以下是一个包含用户名和密码校验的完整弹窗表单实现：

@page "/form-demo"

<Button Type="@ButtonType.Primary" OnClick="ShowModal">打开表单</Button>

<Modal Title="用户登录" @bind-Visible="@visible" Footer="null">
    <Form Model="@loginModel"
          LabelCol="new ColLayoutParam { Span = 6 }"
          WrapperCol="new ColLayoutParam { Span = 18 }"
          OnFinish="HandleSubmit"
          OnFinishFailed="HandleFailed">
        
        <FormItem Label="用户名" 
                 ValidateRules="new[] { new ValidateRule { Required = true, Message = "请输入用户名" } }">
            <Input @bind-Value="@context.UserName" />
        </FormItem>
        
        <FormItem Label="密码"
                 ValidateRules="new[] { new ValidateRule { Required = true, Message = "请输入密码" } }">
            <InputPassword @bind-Value="@context.Password" />
        </FormItem>
        
        <div class="ant-modal-footer">
            <Button Type="@ButtonType.Primary" HtmlType="submit">提交</Button>
            <Button Type="@ButtonType.Default" OnClick="HideModal" Style="margin-left: 8px;">取消</Button>
        </div>
    </Form>
</Modal>

@code {
    private bool visible = false;
    private LoginModel loginModel = new LoginModel();
    
    private void ShowModal() => visible = true;
    private void HideModal() => visible = false;
    
    private void HandleSubmit(LoginModel model)
    {
        // 处理表单提交逻辑
        Console.WriteLine($"用户名: {model.UserName}, 密码: {model.Password}");
        HideModal();
    }
    
    private void HandleFailed(FormContext<LoginModel> context)
    {
        // 处理表单验证失败逻辑
        Console.WriteLine("表单验证失败");
    }
    
    public class LoginModel
    {
        public string UserName { get; set; }
        public string Password { get; set; }
    }
}

校验规则详解

AntDesign Blazor 提供了多种校验规则配置方式：

1. 必填校验

   ValidateRules="new[] { new ValidateRule { Required = true, Message = "错误提示信息" } }"
   

2. 长度校验

   ValidateRules="new[] { 
       new ValidateRule { Min = 6, Message = "最少6个字符" },
       new ValidateRule { Max = 20, Message = "最多20个字符" }
   }"
   

3. 正则校验

   ValidateRules="new[] { 
       new ValidateRule { 
           Pattern = "^\\S+@\\S+\\.\\S+$", 
           Message = "请输入有效的邮箱地址" 
       }
   }"
   

最佳实践

1. 自定义底部按钮区域：通过设置 Footer="null" 并自定义底部区域，可以更灵活地控制按钮布局和样式。

2. 表单模型设计：为每个表单创建专用的模型类，保持数据结构的清晰。

3. 错误处理：在 OnFinishFailed 回调中可以添加自定义的错误处理逻辑，如记录日志或显示额外提示。

4. 响应式布局：合理设置 LabelCol 和 WrapperCol 参数，确保表单在不同屏幕尺寸下都能良好显示。

通过以上方法，开发者可以在 AntDesign Blazor 项目中轻松实现功能完善、用户体验良好的弹窗表单。