首页
/ JSONForm 动态表单字段显示控制技术解析

JSONForm 动态表单字段显示控制技术解析

2025-06-28 00:12:01作者:胡易黎Nicole

背景介绍

JSONForm 是一个基于 JSON Schema 构建 Web 表单的 JavaScript 库,它允许开发者通过 JSON 配置快速生成复杂的表单界面。在实际应用中,我们经常遇到需要根据用户选择动态显示或隐藏某些表单字段的需求。

问题场景

在一个实际项目中,存在一个包含多个选项的选择列表(select),其中有两个特殊选项需要额外的自定义数据输入字段。当用户选择这两个特殊选项时,需要显示对应的输入字段;选择其他选项时,则隐藏这些字段。同时,还需要考虑表单初始化时可能已经存在预选值的情况。

技术实现方案

1. 数据结构设计

首先定义 JSON Schema 结构,其中包含一个选择字段和两个条件显示字段:

{
  "properties": {
    "when": {
      "type": "string",
      "enum": ["anytime", "morning", "afternoon", "evening", "date-format", "date-time-format"]
    },
    "date-format": {
      "type": "string"
    },
    "date-time-format": {
      "type": "string"
    }
  }
}

2. 表单配置

在表单配置中,我们为选择字段添加 onChange 事件处理程序,用于动态控制相关字段的显示状态:

{
  "type": "fieldset",
  "items": [
    {
      "title": "when to show",
      "key": "compliments.config.compliments[].when",
      "onChange": "动态显示控制函数"
    },
    {
      "key": "compliments.config.compliments[].date-format",
      "title": "date to show",
      "placeholder": "YYYY-MM-DD",
      "fieldHtmlClass": "date-format",
      "type": "text"
    },
    {
      "key": "compliments.config.compliments[].date-time-format",
      "title": "date/time to show",
      "placeholder": "min hour day_of_month month dow",
      "type": "text",
      "fieldHtmlClass": "date-time-format"
    }
  ]
}

3. 动态显示控制

实现动态显示控制的核心逻辑如下:

  1. CSS 初始隐藏:通过 CSS 默认隐藏所有条件字段
.xxx fieldset div[class$="format"] {
  display: none;
}
  1. jQuery 选择器:使用 jQuery 查找并显示符合条件的字段
$('.xxx div[class$="---when"] option:selected').each(function() {
  var o = $(this).val();
  if(o.endsWith('format')) {
    $(this).closest('fieldset').find('div[class$="'+o+'"]').css('display','block')
  }
})

4. 表单加载事件处理

为了确保在表单初始化时正确处理预选值,我们使用自定义事件机制:

// 定义自定义事件
const event = new Event("form_loaded");

// 表单生成后触发事件
$("#result-form").jsonForm(data);
document.dispatchEvent(event);

// 事件处理程序
$(document).on('form_loaded', function() {
  // 初始化显示逻辑
});

技术要点解析

  1. DOM 操作策略:通过 jQuery 的 DOM 遍历方法(closest、find)精确定位需要控制的元素

  2. CSS 类名匹配:利用 CSS 属性选择器([class$="..."])匹配特定结尾的类名

  3. 事件驱动架构:使用自定义事件实现模块间的松耦合通信

  4. 动态表单状态管理:同时处理用户交互和初始化状态两种场景

扩展思考

  1. 验证逻辑:可以为特殊字段添加验证规则,如日期格式验证、cron 表达式验证等

  2. 性能优化:对于大型表单,可以考虑使用事件委托减少事件监听器数量

  3. 响应式设计:结合现代 CSS 特性如 Grid 或 Flexbox 实现更灵活的布局

这种动态表单字段控制方案不仅适用于 JSONForm,其核心思想也可以应用于其他表单库或自定义表单实现中,具有很好的通用性和参考价值。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8