全局配置
app.json
文件用来对小程序进行全局配置,页面路径、窗口表现、设置网络超时时间、设置 tabbar 等;如果页面内存在的json
文件,配置同样的选项,则会覆盖全局的配置(页面内的json 文件只能配置部分选项,具体可参看页面内的配置);
以下是示例配置文件 app.json
:
{
"pages": [
"pages/index/index",
"pages/my/my"
],
"window": {
"navigationBarTitleText": "京东小程序 Demo"
},
"tabBar": {
"list": [{
"pagePath": "pages/index/index",
"text": "首页"
}, {
"pagePath": "pages/my/my",
"text": "个人中心"
}]
},
"networkTimeout": {
"request": 10000,
},
"debug": true
}
app.json 配置项列表
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
pages | String Array | 是 | 页面路径列表 |
window | Object | 否 | 全局的窗口表现 |
tabBar | Object | 否 | tab 栏的表现 |
networkTimeout | Object | 否 | 网络超时时间 |
debug | Boolean | 否 | 是否开启 debug 模式,默认关闭 |
pages
用于指定小程序由哪些页面组成,每一项都对应一个页面的 路径+文件名 信息,pages
数组的第一项代表小程序的首页,增加或减少页面,都需要对 pages 数组进行手动增加或减少,值得注意的是,pages
数组中的项目不能重复。
如开发目录为:
├── app.js
├── app.json
├── app.jxss
├── pages
│ │── index
│ │ ├── index.jxml
│ │ ├── index.js
│ │ ├── index.json
│ │ └── index.jxss
│ └── my
│ ├── my.jxml
│ └── my.js
则需要在 app.json 中写
{
"pages":[
"pages/index/index",
"pages/my/my"
]
}
window
用于设置小程序全局的状态栏、标题、窗口表现等。
属性 | 类型 | 默认值 | 描述 |
---|---|---|---|
navigationBarBackgroundColor | HexColor(十六进制颜色值) | #000000 | 导航栏背景颜色,如 #000000 |
navigationBarTextStyle | String | white | 导航栏标题颜色,目前仅支持 black / white |
navigationBarTitleText | String | 导航栏标题文字内容,字数不宜过多 | |
navigationStyle | String | default | 导航栏样式,仅支持以下值:1. default(默认样式), 2. custom(自定义导航栏,只保留右上角按钮) |
backgroundColor | HexColor | #ffffff | 窗口的背景色 |
backgroundTextStyle | String | dark | 下拉 loading 的样式,仅支持 dark / light |
backgroundColorTop | String | #ffffff | 顶部窗口的背景色,仅 iOS 支持 |
backgroundColorBottom | String | #ffffff | 底部窗口的背景色,仅 iOS 支持 |
值得注意的是:
navigationStyle
只在app.json
中生效,请勿在页面的json
中配置navigationStyle: custom
对<web-view>
组件无效
{
"window":{
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "京东接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}
}
tabBar
tabBar 用来配置小程序底部或者顶部的 tab 导航栏的样式以及跳转的页面等;详细配置项如下:
属性 | 类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
color | HexColor | 是 | tab 上的文字默认颜色 | |
selectedColor | HexColor | 是 | tab 上的文字选中时的颜色 | |
backgroundColor | HexColor | 是 | tab 的背景色 | |
borderStyle | String | 否 | black | tabbar上边框的颜色, 仅支持 black、white |
list | Array | 是 | tab 的列表,详见list 属性说明,支持2-5个tab选项 | |
position | String | 否 | bottom | tabBar的位置,仅支持两个值: bottom、top |
其中 list 是数组类型,只能配置最少2个、最多5个 tab。tab 按数组的顺序排序,每个项都是一个独立的对象,其可配置值如下:
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
pagePath | String | 是 | 页面路径,必须在 pages 数组中先定义 |
text | String | 是 | tab 上按钮文字 |
iconPath | String | 否 | 图片路径,icon 大小限制为40kb,建议尺寸为 81px * 81px,不支持网络图片。当 postion 为 top 时,不显示 icon。 |
selectedIconPath | String | 否 | 选中时的图片路径,要求同 iconPath |
tabBar 各字段示例:
networkTimeout
网络请求的超时时间,单位均为毫秒。
属性 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
request | Number | 否 | 60000 | jd.request 的超时时间 |
debug
布尔类型,当配置为true
时,扫码后,小程序中会增加一个信息查看按钮,可以查看 Page 的注册,页面路由,事件触发,console
等信息,可以帮助开发者快速定位问题。
页面配置
每一个小程序页面也可以使用.json
文件来对本页面的窗口表现进行配置。
页面的配置只能设置 app.json 中部分 window 配置项的内容,页面中配置项会覆盖 app.json
的 window
中相同的配置项,可配置的选项如下:
属性 | 类型 | 默认值 | 描述 |
---|---|---|---|
navigationBarBackgroundColor | HexColor | #000000 | 导航栏背景颜色,如 #000000 |
navigationBarTextStyle | String | white | 导航栏标题颜色,仅支持 black、white |
navigationBarTitleText | String | 导航栏标题文字内容 | |
backgroundColor | HexColor | #ffffff | 窗口的背景色 |
backgroundTextStyle | String | dark | 下拉 loading 的样式,仅支持 dark、light |
disableScroll | Boolean | false | 设置为 true 则页面整体不能上下滚动;仅在页面配置中有效, |
示例 my.json 如下:
{
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "个人中心",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}