微信小程序開發之全局配置(轉自開發文檔)

全局配置

小程序根目錄下的 app.json 文件用來對微信小程序進行全局配置,決定頁面文件的路徑、窗口表現、設置網絡超時時間、設置多 tab 等。

配置示例

以下是一個包含了部分常用配置選項的 app.json :

{
"pages": [
"pages/index/index",
"pages/logs/index"
],
"window": {
"navigationBarTitleText": "Demo"
},
"tabBar": {
"list": [{
"pagePath": "pages/index/index",
"text": "首頁"
}, {
"pagePath": "pages/logs/logs",
"text": "日誌"
}]
},
"networkTimeout": {
"request": 10000,
"downloadFile": 10000
},
"debug": true
}

app.json 配置項列表

微信小程序開發之全局配置(轉自開發文檔)

微信小程序開發之全局配置(轉自開發文檔)

pages

用於指定小程序由哪些頁面組成,每一項都對應一個頁面的 路徑+文件名 信息。文件名不需要寫文件後綴,框架會自動去尋找對於位置的.json, .js, .wxml, .wxss 四個文件進行處理。

數組的第一項代表小程序的初始頁面(首頁)。小程序中新增/減少頁面,都需要對 pages 數組進行修改。

如開發目錄為:

├── app.js
├── app.json
├── app.wxss
├── pages
│ │── index
│ │ ├── index.wxml
│ │ ├── index.js
│ │ ├── index.json
│ │ └── index.wxss
│ └── logs
│ ├── logs.wxml
│ └── logs.js
└── utils

則需要在 app.json 中寫

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

window

用於設置小程序的狀態欄、導航條、標題、窗口背景色。

微信小程序開發之全局配置(轉自開發文檔)

微信小程序開發之全局配置(轉自開發文檔)

注:HexColor(十六進制顏色值),如"#ff00ff"

注:navigationStyle 只在 app.json 中生效。開啟 custom 後,低版本客戶端需要做好兼容。開發者工具基礎庫版本切到 1.7.0(不代表最低版本,只供調試用)可方便切到舊視覺

注:客戶端 6.7.2 版本開始,navigationStyle: custom 對 組件無效

如 app.json :

{
"window":{
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "微信接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}
}
微信小程序開發之全局配置(轉自開發文檔)

tabBar

如果小程序是一個多 tab 應用(客戶端窗口的底部或頂部有 tab 欄可以切換頁面),可以通過 tabBar 配置項指定 tab 欄的表現,以及 tab 切換時顯示的對應頁面。

微信小程序開發之全局配置(轉自開發文檔)

其中 list 接受一個數組,只能配置最少2個、最多5個 tab。tab 按數組的順序排序,每個項都是一個對象,其屬性值如下:

微信小程序開發之全局配置(轉自開發文檔)

當 postion 為 top 時,不顯示 icon。selectedIconPathString否選中時的圖片路徑,icon 大小限制為40kb,建議尺寸為 81px * 81px,不支持網絡圖片。

當 postion 為 top 時,不顯示 icon。

微信小程序開發之全局配置(轉自開發文檔)

networkTimeout

各類網絡請求的超時時間,單位均為毫秒。

微信小程序開發之全局配置(轉自開發文檔)

debug

可以在開發者工具中開啟 debug 模式,在開發者工具的控制檯面板,調試信息以 info 的形式給出,其信息有Page的註冊,頁面路由,數據更新,事件觸發等。可以幫助開發者快速定位一些常見的問題。

functionalPages

基礎庫 2.1.0 開始支持,低版本需做兼容處理。

啟用插件功能頁時,插件所有者小程序需要設置其 functionalPages 為 true。

subpackages

微信客戶端 6.6.0 ,基礎庫 1.7.3 及以上版本支持

寫成 subPackages 也支持。

workers

基礎庫 1.9.90 開始支持,低版本需做兼容處理。

使用 Worker 處理多線程任務時,設置 Worker 代碼放置的目錄

requiredBackgroundModes

微信客戶端 6.7.2 及以上版本支持

申明需要後臺運行的能力,類型為數組。目前支持以下項目:

  • audio: 後臺音樂播放

如:

{
"pages": ["pages/index/index"],
"requiredBackgroundModes": ["audio"]
}

注:在此處申明瞭後臺運行的接口,開發版和體驗版上可以直接生效,正式版還需通過審核。

plugins

基礎庫 1.9.6 開始支持,低版本需做兼容處理。

preloadRule

基礎庫 2.3.0 開始支持,低版本需做兼容處理。

resizable

基礎庫 2.3.0 開始支持,低版本需做兼容處理。

在 iPad 上運行的小程序可以設置支持屏幕旋轉。

navigateToMiniProgramAppIdList

基礎庫 2.4.0 開始支持,低版本需做兼容處理。

當小程序需要使用 wx.navigateToMiniProgram 接口跳轉到其他小程序時,需要先在配置文件中聲明需要跳轉的小程序 appId 列表,最多允許填寫 10 個。

頁面配置

每一個小程序頁面也可以使用.json文件來對本頁面的窗口表現進行配置。

頁面的配置只能設置 app.json 中部分 window 配置項的內容,頁面中配置項會覆蓋 app.json 的 window 中相同的配置項。

配置示例

{
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "微信接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}

頁面配置項列表

微信小程序開發之全局配置(轉自開發文檔)

微信小程序開發之全局配置(轉自開發文檔)

頁面的.json只能設置 window 相關的配置項,以決定本頁面的窗口表現,所以無需寫 window 這個鍵。


分享到:


相關文章: