Form

表单容器与字段级校验协调器:提交前按 Model 先做前端必填校验,再把服务端 Result 按字段名路由到对应表单项的行内红字。

最后更新

说明

包裹一组标注 Field 的 FormItem,分两道校验:

  • 提交前在前端挡必填:给 Form 配 Model(实体或字典),调用 Validate() 会按各 FormItem 的 Required 一次性标出所有空字段,全部通过才发请求;只存在于局部变量里的值(口令、文件字节)用 Require / RequireAll 单独校验。
  • 提交后按字段名路由服务端错误:把服务返回的 Result 交给 Apply,服务端用 Result.Data 带回出错字段名,据此把错误就地标到对应字段下方。前端无法判断的逻辑(唯一性、状态门槛等)才需要这一次往返。

用户在该字段内编辑会自动清掉红字;整体性错误(无字段归属)Apply 返回 false,交由调用方退回 Toast 提示。

常见能力:

  • 提交前一次标出全部必填
  • 局部变量用 RequireAll 校验
  • 按字段名路由错误
  • 编辑即时清除
  • 无归属退回 Toast
  • 重开自动清空
  • 自身不渲染额外 DOM

用法

<Form @ref="form" Model="@editing">
    <FormItem Label="模块名称" Field="Name" Required="true">
        <Input @bind-Value="@editing.Name" />
    </FormItem>
    <Button Text="保存" OnClick="Save" />
</Form>

// Save 内:
if (!form.Validate()) return;            // 必填不齐就地标红,不再请求后端
var result = await svc.SaveAsync(editing);
if (!form.Apply(result))                 // 唯一性等业务错误再由服务端带回
    UI.Error(result.Message);

值不在 Model 上时:

if (!form.RequireAll(("OldPassword", oldPassword), ("Confirm", confirmPassword)))
    return;

API 参数

参数 类型 默认值 说明
ChildContent RenderFragment null
Model object null 必填校验的取值来源:实体按 Field 取同名属性,字典按 Field 取键;模型里没有同名字段时跳过不误报。
Visible bool true 取得或设置组件是否可见,默认为false。
VisibleChanged EventCallback<bool> — 事件 取得或设置组件可见性变化时的回调事件。
Class string null 取得或设置组件的CSS类名,用于自定义样式。
Disabled bool false 取得或设置组件是否禁用,默认为false。
Style string null 取得或设置组件的内联样式,用于自定义样式。

方法

方法 说明
Validate() 按各 FormItem 的 Required 校验 Model,一次标出全部空字段并返回是否通过。
Require(field, value) 校验单个由调用方提供的值(局部变量亦可),为空则按登记标签标红。
RequireAll((field, value)…) 清空旧错误后逐项 Require,返回是否全部通过。
Apply(result) 把服务端 Result 的错误按字段名标到位;无字段归属返回 false。

所有组件均继承 BaseComponent,除上表参数外还支持 Class、Style、Disabled、Visible。

微信公众号二维码 扫码关注公众号
QQ 交流群二维码 扫码加入 QQ 群