模块配置

说明

模块是页面层级下的容器，在每个页面上按顺序显示。每个模块可包含一个或多个元素。

示例

  1. {
  2.     "modules": [
  3.         {
  4.             "id": "base",
  5.             "name": "基本信息",
  6.             "icon": "icon-Game-page",
  7.             "description": "这里是模块描述",
  8.             "elements": []
  9.         }
  10.     ]
  11. }

配置细项

字段名称 说明 类型 默认值 必须
desc 模块描述 String '' 否
elements 元素集合 Array [] 否
icon 模块图标 String '' 否
id 模块的ID String '' 否
name 模块名称 String '' 是
optional 是否可选开启/关闭 Boolean false 否

可选开启/关闭的作用

当一个模块是可选的时候，值的变化不会立即保存，需要点击模块下的确认才会把整个模块下的值一起保存。

如有以下模块配置：

  1. {
  2.     "modules": [
  3.         {
  4.             "id": "mymodule",
  5.             "name": "我的模块",
  6.             "optional": true,
  7.             "elements": [
  8.                 {
  9.                     "id": "title",
  10.                     "name": "标题",
  11.                     "type": "input"
  12.                 },
  13.                 {
  14.                     "id": "subTitle",
  15.                     "name": "副标题",
  16.                     "type": "input"
  17.                 }
  18.             ]
  19.         }
  20.     ]
  21. }

对应的dist结构应是：

  1. {
  2.     "dist": {
  3.         "mymodule": {
  4.             "enable": false,
  5.             "title": {
  6.                 "value": "这是标题"
  7.             },
  8.             "subTitle": {
  9.                 "value": "这是副标题"
  10.             }
  11.         }
  12.     }
  13. }

注意：其中的enable代表的是该模块有没有被启用，开发者可根据enable的值进行相应的处理。