建站
咨詢
售后
建站咨詢
新聞中心
全局配置
小程序根目錄下的 app.json 文件用來對微信小程序進(jìn)行全局配置。文件內(nèi)容為一個(gè) JSON 對象，有以下屬性：
網(wǎng)站建設(shè)哪家好，找成都創(chuàng)新互聯(lián)公司！專注于網(wǎng)頁設(shè)計(jì)、網(wǎng)站建設(shè)、微信開發(fā)、微信小程序定制開發(fā)、集團(tuán)企業(yè)網(wǎng)站建設(shè)等服務(wù)項(xiàng)目。為回饋新老客戶創(chuàng)新互聯(lián)還提供了平陰免費(fèi)建站歡迎大家使用！
配置項(xiàng)
| 屬性 | 類型 | 必填 | 描述 | 最低版本 |
|---|---|---|---|---|
| entryPagePath | string | 否 | 小程序默認(rèn)啟動(dòng)首頁 | |
| pages | string[] | 是 | 頁面路徑列表 | |
| window | Object | 否 | 全局的默認(rèn)窗口表現(xiàn) | |
| tabBar | Object | 否 | 底部 tab 欄的表現(xiàn) | |
| networkTimeout | Object | 否 | 網(wǎng)絡(luò)超時(shí)時(shí)間 | |
| debug | boolean | 否 | 是否開啟 debug 模式，默認(rèn)關(guān)閉 | |
| functionalPages | boolean | 否 | 是否啟用插件功能頁，默認(rèn)關(guān)閉 | 2.1.0 |
| subpackages | Object[] | 否 | 分包結(jié)構(gòu)配置 | 1.7.3 |
| workers | string | 否 | Worker 代碼放置的目錄 | 1.9.90 |
| requiredBackgroundModes | string[] | 否 | 需要在后臺(tái)使用的能力，如「音樂播放」 | |
| plugins | Object | 否 | 使用到的插件 | 1.9.6 |
| preloadRule | Object | 否 | 分包預(yù)下載規(guī)則 | 2.3.0 |
| resizable | boolean | 否 | PC 小程序是否支持用戶任意改變窗口大小（包括最大化窗口）；iPad 小程序是否支持屏幕旋轉(zhuǎn)。默認(rèn)關(guān)閉 | 2.3.0 |
| usingComponents | Object | 否 | 全局自定義組件配置 | 開發(fā)者工具 1.02.1810190 |
| permission | Object | 否 | 小程序接口權(quán)限相關(guān)設(shè)置 | 微信客戶端 7.0.0 |
| sitemapLocation | string | 是 | 指明 sitemap.json 的位置 | |
| style | string | 否 | 指定使用升級后的weui樣式 | 2.8.0 |
| useExtendedLib | Object | 否 | 指定需要引用的擴(kuò)展庫 | 2.2.1 |
| entranceDeclare | Object | 否 | 微信消息用小程序打開 | 微信客戶端7.0.9 |
| darkmode | boolean | 否 | 小程序支持 DarkMode | 2.11.0 |
| themeLocation | string | 否 | 指明 theme.json 的位置，darkmode為true為必填 | 開發(fā)者工具 1.03.2004271 |
| lazyCodeLoading | string | 否 | 配置自定義組件代碼按需注入 | 2.11.1 |
| singlePage | Object | 否 | 單頁模式相關(guān)配置 | 2.12.0 |
entryPagePath
指定小程序的默認(rèn)啟動(dòng)路徑（首頁），常見情景是從微信聊天列表頁下拉啟動(dòng)、小程序列表啟動(dòng)等。如果不填，將默認(rèn)為 pages 列表的第一項(xiàng)。不支持帶頁面路徑參數(shù)。
{
"entryPagePath": "pages/index/index"
}
pages
用于指定小程序由哪些頁面組成，每一項(xiàng)都對應(yīng)一個(gè)頁面的 路徑（含文件名） 信息。文件名不需要寫文件后綴，框架會(huì)自動(dòng)去尋找對應(yīng)位置的 .json, .js, .wxml, .wxss 四個(gè)文件進(jìn)行處理。
未指定 entryPagePath 時(shí)，數(shù)組的第一項(xiàng)代表小程序的初始頁面（首頁）。
小程序中新增/減少頁面，都需要對 pages 數(shù)組進(jìn)行修改。
如開發(fā)目錄為：
├── 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
用于設(shè)置小程序的狀態(tài)欄、導(dǎo)航條、標(biāo)題、窗口背景色。
| 屬性 | 類型 | 默認(rèn)值 | 描述 | 最低版本 |
|---|---|---|---|---|
| navigationBarBackgroundColor | HexColor | #000000 | 導(dǎo)航欄背景顏色，如 #000000 | |
| navigationBarTextStyle | string | white | 導(dǎo)航欄標(biāo)題顏色，僅支持 black / white | |
| navigationBarTitleText | string | 導(dǎo)航欄標(biāo)題文字內(nèi)容 | ||
| navigationStyle | string | default | 導(dǎo)航欄樣式，僅支持以下值： default 默認(rèn)樣式 custom 自定義導(dǎo)航欄，只保留右上角膠囊按鈕。參見注 2。 | 微信客戶端 6.6.0 |
| backgroundColor | HexColor | #ffffff | 窗口的背景色 | |
| backgroundTextStyle | string | dark | 下拉 loading 的樣式，僅支持 dark / light | |
| backgroundColorTop | string | #ffffff | 頂部窗口的背景色，僅 iOS 支持 | 微信客戶端 6.5.16 |
| backgroundColorBottom | string | #ffffff | 底部窗口的背景色，僅 iOS 支持 | 微信客戶端 6.5.16 |
| enablePullDownRefresh | boolean | false | 是否開啟全局的下拉刷新。 詳見 Page.onPullDownRefresh | |
| onReachBottomDistance | number | 50 | 頁面上拉觸底事件觸發(fā)時(shí)距頁面底部距離，單位為 px。 詳見 Page.onReachBottom | |
| pageOrientation | string | portrait | 屏幕旋轉(zhuǎn)設(shè)置，支持 auto / portrait / landscape 詳見 響應(yīng)顯示區(qū)域變化 | 2.4.0 (auto) / 2.5.0 (landscape) |
- 注 1：HexColor（十六進(jìn)制顏色值），如"#ff00ff"
- 注 2：關(guān)于navigationStyle客戶端 7.0.0 以下版本，navigationStyle 只在 app.json 中生效?？蛻舳?6.7.2 版本開始，navigationStyle: custom 對 web-view 組件無效開啟 custom 后，低版本客戶端需要做好兼容。開發(fā)者工具基礎(chǔ)庫版本切到 1.7.0（不代表最低版本，只供調(diào)試用）可方便切到舊視覺
如：
{
"window": {
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "微信接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}
}
tabBar
如果小程序是一個(gè)多 tab 應(yīng)用（客戶端窗口的底部或頂部有 tab 欄可以切換頁面），可以通過 tabBar 配置項(xiàng)指定 tab 欄的表現(xiàn)，以及 tab 切換時(shí)顯示的對應(yīng)頁面。
| 屬性 | 類型 | 必填 | 默認(rèn)值 | 描述 | 最低版本 |
|---|---|---|---|---|---|
| color | HexColor | 是 | tab 上的文字默認(rèn)顏色，僅支持十六進(jìn)制顏色 | ||
| selectedColor | HexColor | 是 | tab 上的文字選中時(shí)的顏色，僅支持十六進(jìn)制顏色 | ||
| backgroundColor | HexColor | 是 | tab 的背景色，僅支持十六進(jìn)制顏色 | ||
| borderStyle | string | 否 | black | tabbar 上邊框的顏色， 僅支持 black / white | |
| list | Array | 是 | tab 的列表，詳見 list 屬性說明，最少 2 個(gè)、最多 5 個(gè) tab | ||
| position | string | 否 | bottom | tabBar 的位置，僅支持 bottom / top | |
| custom | boolean | 否 | false | 自定義 tabBar，見詳情 | 2.5.0 |
其中 list 接受一個(gè)數(shù)組，只能配置最少 2 個(gè)、最多 5 個(gè) tab。tab 按數(shù)組的順序排序，每個(gè)項(xiàng)都是一個(gè)對象，其屬性值如下：
| 屬性 | 類型 | 必填 | 說明 |
|---|---|---|---|
| pagePath | string | 是 | 頁面路徑，必須在 pages 中先定義 |
| text | string | 是 | tab 上按鈕文字 |
| iconPath | string | 否 | 圖片路徑，icon 大小限制為 40kb，建議尺寸為 81px * 81px，不支持網(wǎng)絡(luò)圖片。 當(dāng) position 為 top 時(shí)，不顯示 icon。 |
| selectedIconPath | string | 否 | 選中時(shí)的圖片路徑，icon 大小限制為 40kb，建議尺寸為 81px * 81px，不支持網(wǎng)絡(luò)圖片。 當(dāng) position 為 top 時(shí)，不顯示 icon。 |
networkTimeout
各類網(wǎng)絡(luò)請求的超時(shí)時(shí)間，單位均為毫秒。
| 屬性 | 類型 | 必填 | 默認(rèn)值 | 說明 |
|---|---|---|---|---|
| request | number | 否 | 60000 | wx.request 的超時(shí)時(shí)間，單位：毫秒。 |
| connectSocket | number | 否 | 60000 | wx.connectSocket 的超時(shí)時(shí)間，單位：毫秒。 |
| uploadFile | number | 否 | 60000 | wx.uploadFile 的超時(shí)時(shí)間，單位：毫秒。 |
| downloadFile | number | 否 | 60000 | wx.downloadFile 的超時(shí)時(shí)間，單位：毫秒。 |
debug
可以在開發(fā)者工具中開啟 debug 模式，在開發(fā)者工具的控制臺(tái)面板，調(diào)試信息以 info 的形式給出，其信息有 Page 的注冊，頁面路由，數(shù)據(jù)更新，事件觸發(fā)等?？梢詭椭_發(fā)者快速定位一些常見的問題。
functionalPages
基礎(chǔ)庫 2.1.0 開始支持，低版本需做兼容處理。
插件所有者小程序需要設(shè)置這一項(xiàng)來啟用插件功能頁。
subpackages
微信客戶端 6.6.0 ，基礎(chǔ)庫 1.7.3 及以上版本支持
啟用分包加載時(shí)，聲明項(xiàng)目分包結(jié)構(gòu)。
寫成 subPackages 也支持。
workers
基礎(chǔ)庫 1.9.90 開始支持，低版本需做兼容處理。
使用 Worker 處理多線程任務(wù)時(shí)，設(shè)置 Worker 代碼放置的目錄
requiredBackgroundModes
微信客戶端 6.7.2 及以上版本支持
申明需要后臺(tái)運(yùn)行的能力，類型為數(shù)組。目前支持以下項(xiàng)目：
- audio: 后臺(tái)音樂播放
- location: 后臺(tái)定位
如：
{
"pages": ["pages/index/index"],
"requiredBackgroundModes": ["audio", "location"]
}
注：在此處申明了后臺(tái)運(yùn)行的接口，開發(fā)版和體驗(yàn)版上可以直接生效，正式版還需通過審核。
plugins
基礎(chǔ)庫 1.9.6 開始支持，低版本需做兼容處理。
聲明小程序需要使用的插件。
preloadRule
基礎(chǔ)庫 2.3.0 開始支持，低版本需做兼容處理。
聲明分包預(yù)下載的規(guī)則。
resizable
基礎(chǔ)庫 2.3.0 開始支持，低版本需做兼容處理。
在 iPad 上運(yùn)行的小程序可以設(shè)置支持屏幕旋轉(zhuǎn)。
在 PC 上運(yùn)行的小程序，用戶可以按照任意比例拖動(dòng)窗口大小，也可以在小程序菜單中最大化窗口
usingComponents
開發(fā)者工具 1.02.1810190 及以上版本支持
在此處聲明的自定義組件視為全局自定義組件，在小程序內(nèi)的頁面或自定義組件中可以直接使用而無需再聲明。
permission
微信客戶端 7.0.0 及以上版本支持
小程序接口權(quán)限相關(guān)設(shè)置。字段類型為 Object，結(jié)構(gòu)為：
| 屬性 | 類型 | 必填 | 默認(rèn)值 | 描述 |
|---|---|---|---|---|
| scope.userLocation | PermissionObject | 否 | 位置相關(guān)權(quán)限聲明 |
PermissionObject 結(jié)構(gòu)
| 屬性 | 類型 | 必填 | 默認(rèn)值 | 說明 |
|---|---|---|---|---|
| desc | string | 是 | 小程序獲取權(quán)限時(shí)展示的接口用途說明。最長 30 個(gè)字符 |
如：
{
"pages": ["pages/index/index"],
"permission": {
"scope.userLocation": {
"desc": "你的位置信息將用于小程序位置接口的效果展示" // 高速公路行駛持續(xù)后臺(tái)定位
}
}
}
sitemapLocation
指明 sitemap.json 的位置；默認(rèn)為 'sitemap.json' 即在 app.json 同級目錄下名字的 sitemap.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,
}
style
基礎(chǔ)庫 2.8.0 開始支持，低版本需做兼容處理。
微信客戶端 7.0 開始，UI 界面進(jìn)行了大改版。小程序也進(jìn)行了基礎(chǔ)組件的樣式升級。app.json 中配置 "style": "v2"可表明啟用新版的組件樣式。
本次改動(dòng)涉及的組件有 button icon radio checkbox switch slider。可前往小程序示例進(jìn)行體驗(yàn)。
useExtendedLib
基礎(chǔ)庫 2.2.1 開始支持，低版本需做兼容處理。
最新的 nightly 版開發(fā)者工具開始支持，同時(shí)基礎(chǔ)庫從支持 npm 的版本（2.2.1）起支持
指定需要引用的擴(kuò)展庫。目前支持以下項(xiàng)目：
- kbone: 多端開發(fā)框架
- weui: WeUI 組件庫
指定后，相當(dāng)于引入了對應(yīng)擴(kuò)展庫相關(guān)的最新版本的 npm 包，同時(shí)也不占用小程序的包體積。目前暫不支持在分包中引用。用法如下：
{
"useExtendedLib": {
"kbone": true,
"weui": true
}
}
entranceDeclare
微信客戶端 7.0.9 及以上版本支持，iOS 暫不支持
聊天位置消息用打車類小程序打開，詳情參考。
"entranceDeclare": {
"locationMessage": {
"path": "pages/index/index",
"query": "foo=bar"
}
}
darkmode
開發(fā)者工具 1.03.2004271 及以上版本支持，基礎(chǔ)庫 2.11.0 及以上版本支持
微信iOS客戶端 7.0.12 版本、Android客戶端 7.0.13 版本正式支持 DarkMode，可通過配置"darkmode": true表示當(dāng)前小程序可適配 DarkMode，所有基礎(chǔ)組件均會(huì)根據(jù)系統(tǒng)主題展示不同的默認(rèn)樣式，navigation bar 和 tab bar 也會(huì)根據(jù)開發(fā)者的配置自動(dòng)切換。
配置后，請根據(jù)DarkMode 適配指南自行完成基礎(chǔ)樣式以外的適配工作。
{
"darkmode": true
}
themeLocation
自定義 theme.json 的路徑，當(dāng)配置"darkmode":true時(shí)，當(dāng)前配置文件為必填項(xiàng)。
{
"themeLocation": "/path/to/theme.json"
}
lazyCodeLoading
基礎(chǔ)庫 2.11.1 及以上版本支持，2.11.1 以下兼容但無優(yōu)化效果
通常情況下，在小程序啟動(dòng)期間，所有頁面及自定義組件的代碼都會(huì)進(jìn)行注入，當(dāng)前頁面沒有使用到的自定義組件和頁面在注入后其實(shí)并沒有被使用。
自基礎(chǔ)庫版本 2.11.1 起，小程序支持有選擇地注入必要的代碼，以降低小程序的啟動(dòng)時(shí)間和運(yùn)行時(shí)內(nèi)存。
{
"lazyCodeLoading": "requiredComponents"
}
當(dāng)配置了這一項(xiàng)時(shí)，小程序僅注入當(dāng)前頁面需要的自定義組件和頁面代碼，在頁面中必然不會(huì)用到的自定義組件不會(huì)被加載和初始化。
注意：添加這項(xiàng)配置后，未使用到的代碼文件將不被執(zhí)行。
singlePage
基礎(chǔ)庫 2.11.3 及以上版本支持，目前分享到朋友圈 (Beta) 后打開會(huì)進(jìn)入單頁模式
單頁模式相關(guān)配置
| 屬性 | 類型 | 必填 | 默認(rèn)值 | 描述 |
|---|---|---|---|---|
| navigationBarFit | String | 否 | 默認(rèn)自動(dòng)調(diào)整，若原頁面是自定義導(dǎo)航欄，則為 float，否則為 squeezed | 導(dǎo)航欄與頁面的相交狀態(tài)，值為 float 時(shí)表示導(dǎo)航欄浮在頁面上，與頁面相交；值為 squeezed 時(shí)表示頁面被導(dǎo)航欄擠壓，與頁面不相交 |
分享標(biāo)題：創(chuàng)新互聯(lián)小程序教程：微信小程序全局配置
URL標(biāo)題：http://m.5511xx.com/article/cdgsjdc.html
