app.json文件用来对微信小程序进行全局配置,决定页面文件的路径、窗口表现、设置网络超时时间、设置多 tab 等
第一部分:整体程序 app 之app.json文件(配置小程序项目)
一:在第二节 小程序目录结构中描述到"一个描述整体程序的 app 之app.json文件(配置小程序项目)"
作用:对微信小程序进行全局配置,决定页面文件的路径、窗口表现、设置网络超时时间、设置多 tab 等。
所有的选项配置pages、window、tabBar、networkTimeout、debug
app.json 配置项列表:
属性 类型 必填 描述
pages String Array 是 设置页面路径
window Object 否 设置默认页面的窗口表现
tabBar Object 否 设置底部 tab 的表现
networkTimeout Object 否 设置网络超时时间
debug Boolean 否 设置是否开启 debug 模式
pages属性说明:
类型是String Array(字符串数组), 每一项都是字符串,来指定小程序由哪些页面组成。
每一项代表对应页面的【路径+文件名】信息,数组的第一项代表小程序的初始页面。
小程序中新增/减少页面,都需要对 pages 数组进行修改。
文件名不需要后缀,框架自动匹配pages 数组路径下 .json, .js, .wxml, .wxss 4文件进行整合。
pages字符串数组的第一个字符串页面路径【路径+文件名】为小程序显示的首页。
如开发目录为:
pages/
pages/index/index.wxml
pages/index/index.js
pages/index/index.wxss
pages/logs/logs.wxml
pages/logs/logs.js
则配如下(小程序中新增/减少页面,都需要对 pages 数组进行修改)
{
"pages": [
//这里的的第一个页面作为首页显示
"pages/index/index",
"pages/logs/logs"
]
}
二:配置项pages
接受一个数组,每一项都是字符串,来指定小程序由哪些页面组成。每一项代表对应页面的【路径+文件名】信息,数组的第一项代表小程序的初始页面。小程序中新增/减少页面,都需要对 pages 数组进行修改。
文件名不需要写文件后缀,因为框架会自动去寻找路径下 .json, .js, .wxml, .wxss 四个文件进行整合
三:配置window
用于设置小程序的状态栏、导航条、标题、窗口背景色。
属性 类型 默认值 描述 最低版本
navigationBarBackgroundColor HexColor #000000 导航栏背景颜色,
如"#000000"
navigationBarTextStyle String white 导航栏标题颜色,
仅支持 black/white navigationBarTitleText String 导航栏标题文字内容
navigationStyle String default 导航栏样式, 微信版本 6.6.0
仅支持 default/custom。
custom 模式可自定义导航栏,
只保留右上角胶囊状的按钮
backgroundColor HexColor #ffffff 窗口的背景色
backgroundTextStyle String dark 下拉背景字体、loading 图的样式,
仅支持 dark/light
enablePullDownRefresh Boolean false 是否开启下拉刷新,
详见页面相关事件处理函数Page()
注:
HexColor(十六进制颜色值),如"#ff00ff"
navigationStyle 开启 custom 后,低版本客户端需要做好兼容。开发者工具基础库版本切到 1.7.0(不代表最低版本,只供调试用) 可方便切到旧视觉
四:配置项tabBar
如果小程序是一个多 tab 应用(客户端窗口的底部或顶部有 tab 栏可以切换页面),
可以通过 tabBar 配置项指定 tab 栏的表现,以及 tab 切换时显示的对应页面
属性 类型 必填 默认值 描述
color HexColor 是 tab 上的文字默认颜色
selectedColor HexColor 是 tab 上的文字选中时的颜色
backgroundColor HexColor 是 tab 的背景
borderStyle String 否 black tabbar上边框的颜色, 仅支持 black/white
list Array 是 tab 的列表,详见 list 属性说明
tabBar 中的 list 是一个数组,
只能配置最少2个、最多5个 tab,
tab 按数组的顺序排序。
position String 否 bottom 可选值 bottom、top
设置 position 为 top 时,将不会显示 icon
list数组说明
属性类型必填说明
pagePath String 是 页面路径,必须在 pages 中先定义
text String 是 tab 上按钮文字
iconPath String 否 图片路径,icon 大小限制为40kb,
建议尺寸为 81px * 81px,
当 postion 为 top 时,此参数无效,
不支持网络图片
selectedIconPath String 否 选中时的图片路径,icon 大小限制为40kb,
建议尺寸为 81px * 81px ,
当 postion 为 top 时,此参数无效
五:配置项networkTimeout
可以设置各种网络请求的超时时间。
属性 类型 必填 说明
request Number 否 wx.request的超时时间,单位毫秒,默认为:60000
connectSocket Number 否 wx.connectSocket的超时时间,单位毫秒,默认为:60000
uploadFile Number 否 wx.uploadFile的超时时间,单位毫秒,默认为:60000
downloadFile Number 否 wx.downloadFile的超时时间,单位毫秒,默认为:60000
六:配置项debug
可以在开发者工具中开启 debug 模式,在开发者工具的控制台面板,调试信息以 info 的形式给出,其信息有Page的注册,页面路由,数据更新,事件触发 。 可以帮助开发者快速定位一些常见的问题。
第二部分:页面配置(页面名.json文件)
在在第二节 小程序目录结构中第六中描述到"页面的json配置(页面名称.json)"
每一个页面也可以使用.json文件来对本页面的窗口表现进行配置。 页面的配置比app.json全局配置简单得多,只是设置 app.json 中的 window 配置项的内容,页面中配置项会覆盖 app.json 的 window 中相同的配置项。
页面的.json只能设置 window 相关配置项,以决定本页面窗口表现,所以无需写 window 这个键。
总结:每个页面.json(页面配置),其实就是对app.json的window配置项进行继承覆盖重写
应用:app.json中配置了启用上下拉刷新,但某些页面不需要,那么就可以在页面名.json中进行重写禁用了。又比如每个页的标题,也是需要重写的。
如:
{
"navigationBarBackgroundColor":"#ffffff",
"navigationBarTextStyle":"black",
"navigationBarTitleText":"微信接口功能演示",
"backgroundColor":"#eeeeee",
"backgroundTextStyle":"light"
}
所有app.json中的window配置项在页面名.json中都是可以覆盖重写的,但页面名.json配置又有自己的特性是app.json小程序全局配置没有的
属性 类型 默认值 描述
disableScroll Boolean false 设置为 true 则页面整体不能上下滚动;
只在 page.json 中有效,无法在 app.json 中设置该项