# 全局配置

快应用根目录下的 app.json 文件用来对快应用进行全局配置。有以下可配置项:

# 配置项

属性 类型
必填
描述
package string 应用包名,确认与原生应用的包名不一致,推荐采用 com.company.module 的格式,如:com.example.demo
name string 应用名称,6 个汉字以内,与应用商店保存的名称一致,用于在桌面图标、弹窗等处显示应用名称
icon string 应用图标,提供 192x192 大小的即可
versionName string 应用版本名称,如:"1.0"
versionCode Number 应用版本号,从 1 自增,推荐每次重新上传包时 versionCode+1
minPlatformVersion Number 支持的最小平台版本号,兼容性检查,避免上线后在低版本平台运行并导致不兼容;如果不填按照内测版本处理
pages string[] 所有页面路径
window Object 全局的默认窗口样式
tabBar Object tab 页设置
usingComponents Object 全局自定义组件配置
navigateToQuickAppList string[] 允许跳转的快应用包名列表
permission Object 快应用接口权限相关设置
wxpay Object 微信支付参数配置

# pages

指定快应用页面定义,每一项都对应一个页面的路径信息(含文件名)。文件名不需要写文件后缀,开发工具会自动去寻找对应位置的 .json, .js, .qxml, .css 文件进行处理。

  • pages 第一项代表快应用的初始页面(首页)
  • 在 pages 中添加一个路径后,需要有对应的文件存在,否则会导致编译报错

如开发目录为:

├── app.js
├── app.json
├── app.css
├── pages
│   │── index
│   │   ├── index.qxml
│   │   ├── index.js
│   │   ├── index.json
│   │   └── index.css
│   └── detail
│       ├── detail.qxml
│       └── detail.js
└── utils

1
2
3
4
5
6
7
8
9
10
11
12
13
14

则需要在 app.json 中写

{
  "pages": ["pages/index/index", "pages/detail/detail"]
}

1
2
3
4

# window

快应用的状态栏、导航条、标题、窗口背景色配置项。

属性 类型
默认值
描述 最低版本
navigationBarBackgroundColor HexColor #000000 导航栏背景颜色
navigationBarTextStyle string white 导航栏标题颜色,仅支持 black / white
navigationBarTitleText string 导航栏标题
navigationStyle string default 导航栏样式,仅支持以下值: default 默认样式;custom 自定义导航栏(只保留右上角胶囊按钮)
backgroundColor HexColor #ffffff 窗口的背景色
backgroundTextStyle string dark 下拉 loading 的样式,仅支持 dark / light
enablePullDownRefresh boolean false 是否开启下拉刷新。 详见 Page.onPullDownRefresh
onReachBottomDistance number 50 页面上拉触底事件触发时距页面底部距离,单位为 px。 详见 Page.onReachBottom
pageOrientation string portrait 屏幕旋转设置,支持 auto / portrait / landscape 详见 响应显示区域变化
menuBarData Object menuBarData 设置
  • 注 1:HexColor 表示十六进制颜色值,如"#ff00ff"

如:

{
  "window": {
    "navigationBarBackgroundColor": "#ffffff",
    "navigationBarTextStyle": "black",
    "navigationBarTitleText": "示例",
    "backgroundColor": "#cccccc",
    "backgroundTextStyle": "light"
  }
}
1
2
3
4
5
6
7
8
9

# tabBar

快应用允许多 tab 页。tab 页底部会有原生的 tab 切换栏。tab 页面路径、tab 栏显示图标、文字、样式等都可以通过 tabBar 配置项指定。

属性 类型
必填
默认值
描述 最低版本
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 的值是一个数组。tab 按数组的顺序排序,每个项都用对象配置一个 tab 页,对象属性值如下:

属性 类型
必填
说明
pagePath string 页面路径,必须在 pages 中先定义
text string tab 上按钮文字
iconPath string 图片路径,icon 大小限制为 40kb,建议尺寸为 81px * 81px,不支持网络图片。 positiontop 时,不显示 icon。
selectedIconPath string 选中时的图片路径,icon 大小限制为 40kb,建议尺寸为 81px * 81px,不支持网络图片。 positiontop 时,不显示 icon。

快应用允许最多配置五个 tab 页

# usingComponents

在此处声明的自定义组件视为全局自定义组件,在快应用内的页面或自定义组件中可以直接使用而无需再声明。

# 配置示例

{
  "pages": ["pages/index/index", "pages/detail/index"],
  "window": {
    "navigationBarTitleText": "Demo"
  },
  "tabBar": {
    "list": [
      {
        "pagePath": "pages/index/index",
        "text": "首页"
      },
      {
        "pagePath": "pages/detail/detail",
        "text": "详情"
      }
    ]
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# permission

快应用接口权限相关设置。字段类型为 Object,结构为:

属性 类型 必填 默认值 描述
scope.userLocation PermissionObject 位置相关权限声明

PermissionObject 结构

属性 类型 必填 默认值 说明
desc string 快应用获取权限时展示的接口用途说明。最长 30 个字符

如:

{
  "pages": ["pages/index/index"],
  "permission": {
    "scope.userLocation": {
      "desc": "你的位置信息将用于快应用位置接口的效果展示"
    }
  }
}

1
2
3
4
5
6
7
8
9

# wxpay

快应用支持微信支付的两种接入方式:app支付网页支付

在使用微信支付时,需要根据需要配置下列参数,详细用法请参考 快应用微信支付, 快应用微信支付接口qa.getWxPaymentTypeqa.requestWxPayment

属性 类型 必填 描述
package string 微信app方式必填 微信支付后台中注册的应用包名,需要和 rpk 中的包名保持一致
sign string 微信app方式必填 微信支付后台注册时提交的 apk 的签名的 Base64 编码,该 apk 签名证书需要和 rpk 的签名证书保持一致
url string 微信网页中间页方式必填 由开发者提供的 H5 页面,开发者需要在该页面中拉起微信网页支付。当调用微信网页支付接口时,系统会加载该页面,并传入订单信息

# 配置示例

{
  "pages": ["pages/index/index", "pages/logs/index"],
  "window": {
    "navigationBarTitleText": "Demo"
  },
  "tabBar": {
    "list": [
      {
        "pagePath": "pages/index/index",
        "text": "首页"
      },
      {
        "pagePath": "pages/logs/logs",
        "text": "日志"
      }
    ]
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

menuBarData相关设置。字段类型为 Object,结构为:

属性 类型 必填 默认值 描述
menuBarStyle string menuBar 样式,默认黑色图标 icon 样式,dark,可以设置 light 浅色
shareTitle string menuBar 中分享功能对应 标题,默认当前快应用名称
shareDescription string menuBar 中分享功能对应描述,默认当前快应用描述
shareIcon string menuBar 中分享功能对应图片,默认当前快应用 icon
shareUrl string menuBar 中备用分享链接,不支持跳转快应用设备时, 分享跳转到此链接页面

如:

  "window": {
    "menuBarData": {
      "menuBarStyle":"dark",
      "shareTitle":"分享标题",
      "shareDescription":"分享描述",
      "shareUrl":'https://www.quickapp.cn/',
      "shareIcon":"https://doc.quickapp.cn/assets/images/logo.png"
      }
  }

1
2
3
4
5
6
7
8
9
10

在线客服