关于GMU配置文件格式说明
概述
GMU配置文件是为了方便GMU组件的个性化适配和扩展而针对GMU组件设计的json格式配置文件,配置文件后缀名为.gmu。
组件可以包含多个页面,每个页面都需要有自己独立的GMU配置文件;无配置项的页面可以没有GMU配置文件;GMU配置文件的文件名需要和页面注册的页面名保持一致。
格式说明
一个标准的GMU配置文件通常会包含以下几个部分:
- inputParams:组件的输入参数
- navigationbar:组件对顶部导航栏的定制
- style:组件的样式设计
- pages:组件的多实例差异化配置
这些配置项可以通过创建页面实例时传入的gmuConfig对象获取到。
以web.gmu为例,常见的配置文件形式如下:
|
示例解析:
inputParams: 用来配置Gmu的打开传入参数,需要开发者在页面实例创建时对这些入参进行处理。在上面例子里,web.gmu的inputParams传入了参数startPage,值为https://www.hundsun.com,在打开web组件时,web组件就会响应该参数并打开恒生电子网站首页。inputParams也可以通过gmu协议调用的方式直接传入。
navigationbar: 页面顶部导航栏配置项,该节点下的配置通常无需页面响应,由框架统一处理和管理。
style: 组件的样式配置,包括但不限于组件中用到的各种颜色、线宽等等。如果组件没有需要配置的样式,该节点可以不存在或为空。
config: 对Gmu的功能性配置需要添加在config节点下,上例中,web组件可以通过showCloseButton选项来控制当webview打开多级web页面时是否显示关闭按钮。
pages: 当组件有多个实例需要不同配置时,可以在pages数组下增加json对象的方式来描述。数组下的json对象除了增加pageid属性作为每个实例的唯一标识以外,其他配置完全相同。当打开指定pageid实例时,框架将会自动以相应pageid配置覆盖合并到主配置的形式将各配置项提供给页面实例。在上例中,使用gmu://web会打开恒生电子网站首页,而使用gmu://web/light则会打开light网站首页,且其余配置不变。如果对应pageid不存在,则仍会打开主配置对应的页面实例。