展示全部

# pages.json

pages.json 文件是 uni-app x 的页面管理配置文件，决定应用的首页、页面文件的路径、窗口样式、原生的导航栏、底部的原生tabbar 等。

所有页面，均需在pages.json中注册，否则不会被打包到应用中。

在HBuilderX中新建页面，默认会在pages.json中自动注册。在HBuilderX中删除页面文件，也会在状态栏提示从pages.json中移除注册。

除了管理页面，pages.json支持对页面进行特殊配置，比如应用首页的tabbar、每个页面的顶部导航栏设置。

但这些uni-app中设计的功能，主要是为了解决页面由webview渲染带来的性能问题，由原生提供一些配置来优化。

uni-app x的app平台，页面不再由webview渲染，其实不需要原生提供特殊配置来优化。但为了开发的便利和多端的统一，也支持了tabbar和导航栏设置。
但uni-app x不再支持uni-app的app-plus专用配置以及tabbar的midbutton。这些额外的功能，通过uni-ui x的自定义导航栏和tabbar组件来满足。

自定义导航栏： uni-nav-bar
自定义tabbar：uni-tab-bar

导航栏高度为 44px (不含状态栏)，tabBar 高度为 50px (不含安全区)。

# 配置项列表

属性

类型

默认值

必填

兼容性

描述

globalStyle

globalStyle 配置项列表

否

默认页面的窗口表现

pages

Array<PagesOptionsPage>

是

页面路径及窗口表现

tabBar

tabBar 配置项列表

否

底部 tab 的表现

topWindow

topWindow 配置项列表

否

上窗体

leftWindow

leftWindow 配置项列表

否

左窗体

rightWindow

rightWindow 配置项列表

否

右窗体

condition

condition 配置项列表

否

启动模式

subPackages

Array<PagesSubPackages>

否

分包加载配置

preloadRule

preloadRule 配置项列表

否

声明分包预下载的规则

workers

string

否

使用 Worker 处理多线程任务时，设置 Worker 代码放置的目录

easycom

easycom 配置项列表

否

组件自动引入规则

uniIdRouter

uniIdRouter 配置项列表

否

根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：详见

entryPagePath

string

否

默认启动首页

# globalStyle 配置项列表

globalStyle节点里是所有页面都生效的全局样式配置。它的配置与页面级style基本相同，但优先级低于页面级style配置。

默认页面的窗口表现

属性类型默认值必填兼容性描述

navigationBarBackgroundColor

string (string.ColorString)

app: #F8F8F8
web: #F8F8F8
mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd: #000000
mp-alipay、mp-kuaishou: #ffffff

否

导航栏背景颜色（同状态栏背景色）

navigationBarTextStyle

string (string.ThemeJsonString)

"black"

否

导航栏标题颜色，仅支持 black/white（支付宝小程序不支持，请使用 my.setNavigationBar）。

navigationBarTitleText

string

否

导航栏标题文字内容

navigationStyle

'default' | 'custom'

"default"

否

导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看使用注意。

backgroundColor

string (string.ColorString)

"#ffffff"

否

下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果）

backgroundColorContent

string (string.ColorString)

"#ffffff"

否

页面容器背景色

backgroundTextStyle

string (string.ThemeJsonString)

"dark"

否

下拉 loading 的样式，仅支持 dark / light

enablePullDownRefresh

boolean

false

否

是否开启下拉刷新，详见页面生命周期。

onReachBottomDistance

number

否

页面上拉触底事件触发时距页面底部距离，单位只支持px，详见页面生命周期。

backgroundColorTop

string (string.ColorString)

"#ffffff"

否

顶部窗口的背景色(bounce回弹区域), 仅 iOS 平台

backgroundColorBottom

string (string.ColorString)

"#ffffff"

否

底部窗口的背景色(bounce回弹区域), 仅 iOS 平台

titleImage

string (string.ImageURIString)

否

导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址

transparentTitle

'always' | 'auto' | 'none'

"none"

否

导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明

titlePenetrate

'YES' | 'NO'

"NO"

否

导航栏点击穿透

pageOrientation

'auto' | 'portrait' | 'landscape'

"portrait"

否

横屏配置，屏幕旋转设置，仅支持 auto / portrait / landscape 详见响应显示区域变化。

hideStatusBar

boolean

false

否

是否隐藏系统顶部状态栏

hideBottomNavigationIndicator

boolean

false

否

是否隐藏系统底部导航栏

androidThreeButtonNavigationTranslucent

boolean

false

否

页面内容是否可以渲染到虚拟按键区域

androidThreeButtonNavigationBackgroundColor

string (string.ColorString)

否

虚拟按键区域背景色

androidThreeButtonNavigationStyle

string (string.ThemeJsonString)

否

虚拟按键区域前景色

animationType

"pop-in"

否

窗口显示的动画效果，详见：窗口动画。

animationDuration

number

300

否

窗口显示动画的持续时间，单位为 ms

allowsBounceVertical

'YES' | 'NO'

"YES"

否

是否允许向下拉拽。默认 YES。如果需要下拉刷新，值必须为YES

usingComponents

object

否

引用小程序组件，参考小程序组件。

renderingMode

string

否

同层渲染，webrtc(实时音视频) 无法正常时尝试配置 seperated 强制关掉同层

leftWindow

boolean

true

否

当存在 leftWindow时，默认是否显示 leftWindow

topWindow

boolean

true

否

当存在 topWindow时，默认是否显示 topWindow

rightWindow

boolean

true

否

当存在 rightWindow时，默认是否显示 rightWindow

rpxCalcMaxDeviceWidth

number

960

否

rpx 计算所支持的最大设备宽度，单位 px

rpxCalcBaseDeviceWidth

number

375

否

rpx 计算使用的基准设备宽度，设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算，单位 px

rpxCalcIncludeWidth

number

750

否

rpx 计算特殊处理的值，始终按实际的设备宽度计算，单位 rpx

dynamicRpx

boolean

false

否

动态 rpx，屏幕大小变化会重新渲染 rpx

maxWidth

number

否

单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选)

enableUcssReset

boolean

true

否

是否启用ucss样式覆盖

app-plus

app-plus 配置项列表

否

5+ App 特有配置

h5 配置项列表

否

H5 特有配置

mp-alipay

mp-alipay 配置项列表

否

支付宝小程序特有配置

mp-weixin

mp-weixin 配置项列表

否

微信小程序特有配置

mp-baidu

mp-baidu 配置项列表

否

百度小程序特有配置

mp-toutiao

object

否

头条小程序特有配置

mp-qq

object

否

QQ小程序特有配置

mp-kuaishou

object

否

快手小程序特有配置

mp-jd

object

否

设置编译到 mp-jd 平台的特定样式

mp-lark

object

否

飞书小程序特有配置

# h5 配置项列表

H5 特有配置

属性

类型

默认值

必填

兼容性

描述

titleNView

titleNView 配置项列表

否

导航栏设置

pullToRefresh

pullToRefresh 配置项列表

否

下拉刷新

# titleNView 配置项列表

导航栏设置

属性	类型	默认值	必填	兼容性	描述
backgroundColor	string (string.ColorString)	"#f7f7f7"	否	-	背景颜色，颜色值格式为"#RRGGBB"。
buttons	array	-	否	-	自定义按钮，参考 buttons。
titleColor	string (string.ColorString)	"#000000"	否	-	标题文字颜色
titleText	string	-	否	-	标题文字内容
titleSize	string	-	否	-	标题文字字体大小
type	'defaultValue' \| 'transparent'	"defaultValue"	否	-	导航栏样式。"default"-默认样式；"transparent"-透明渐变。
searchInput	object	-	否	-	导航栏上的搜索框样式，详见：searchInput。

# pullToRefresh 配置项列表

下拉刷新

属性

类型

默认值

必填

兼容性

描述

support

boolean

否

是否开启窗口的下拉刷新功能

color

string (string.ColorString)

否

颜色值格式为"#RRGGBB"，仅"circle"样式下拉刷新支持此属性。

type

'defaultValue' | 'circle'

否

下拉刷新控件样式

height

string

否

窗口的下拉刷新控件进入刷新状态的拉拽高度。支持百分比，如"10%"；像素值，如"50px"。

range

string

否

窗口可下拉拖拽的范围。支持百分比，如"10%"；像素值，如"50px"。

offset

string

否

下拉刷新控件的起始位置。仅对"circle"样式下拉刷新控件有效，用于定义刷新控件下拉时的起始位置。支持百分比，如"10%"；像素值，如"50px"。

contentdown

contentdown 配置项列表

否

在下拉可刷新状态时下拉刷新控件显示的内容

contentover

contentover 配置项列表

否

在释放可刷新状态时下拉刷新控件显示的内容

contentrefresh

contentrefresh 配置项列表

否

在正在刷新状态时下拉刷新控件显示的内容

# contentdown 配置项列表

在下拉可刷新状态时下拉刷新控件显示的内容

属性

类型

默认值

必填

兼容性

描述

caption

string

否

下拉刷新控件上显示的标题内容

# contentover 配置项列表

在释放可刷新状态时下拉刷新控件显示的内容

属性

类型

默认值

必填

兼容性

描述

caption

string

否

下拉刷新控件上显示的标题内容

# contentrefresh 配置项列表

在正在刷新状态时下拉刷新控件显示的内容

属性

类型

默认值

必填

兼容性

描述

caption

string

否

下拉刷新控件上显示的标题内容

# mp-weixin 配置项列表

微信小程序特有配置

属性

类型

默认值

必填

兼容性

描述

homeButton

boolean

false

否

在非首页、非页面栈最底层页面或非tabbar内页面中的导航栏展示home键

backgroundColorTop

HexColor

"#ffffff"

否

顶部窗口的背景色，仅 iOS 支持

backgroundColorBottom

HexColor

"#ffffff"

否

顶部窗口的背景色，仅 iOS 支持

restartStrategy

'homePage' | 'homePageAndLatestPage'

"homePage"

否

重新启动策略配置。支持 homePage / homePageAndLatestPage

initialRenderingCache

'static' | 'dynamic'

否

页面初始渲染缓存配置。支持 static / dynamic

visualEffectInBackground

'none' | 'hidden'

"none"

否

切入系统后台时，隐藏页面内容，保护用户隐私。支持 hidden / none

handleWebviewPreload

'static' | 'manual' | 'none'

"static"

否

控制预加载下个页面的时机。支持 static / manual / auto

enableUcssReset

boolean

true

否

是否启用ucss样式覆盖

# pages 配置项列表

pages节点里注册页面，数据格式是数组，数组每个项都是一个对象，通过path属性指定页面路径，通过style指定该页面的样式配置。

属性

类型

默认值

必填

兼容性

描述

path

string (string.PageURIString)

是

配置页面路径

style

style 配置项列表

否

配置页面窗口表现，配置项参考下方 pageStyle。

needLogin

boolean

false

否

是否需要登录才可访问

Tips：

pages节点的第一项为应用入口页（即首页）
应用中新增/减少页面，都需要对 pages 数组进行修改
文件名不需要写后缀，框架会自动寻找路径下的页面资源
页面路径必须与真实的文件路径大小写保持一致，即大小写敏感

示例

假使开发目录为：

	
┌─pages
│  ├─index
│  │  └─index.uvue
│  └─login
│     └─login.uvue
├─static
├─main.uts
├─App.uvue
├─manifest.json
└─pages.json

则需要在 pages.json 中填写

{
    "pages": [
        {
            "path": "pages/index/index",
            "style": { ... }
        }, {
            "path": "pages/login/login",
            "style": { ... }
        }
    ]
}

示例源码如下，请查看 pre > code 标签中的内容

{
    "pages": [
        {
            "path": "pages/index/index",
            "style": { ... }
        }, {
            "path": "pages/login/login",
            "style": { ... }
        }
    ]
}

# style 配置项列表

用于设置每个页面的状态栏、导航条的颜色、文字等信息。

页面中配置项会覆盖 globalStyle 中相同的配置项

配置页面窗口表现，配置项参考下方 pageStyle。

属性类型默认值必填兼容性描述

navigationBarBackgroundColor

string (string.ColorString)

app: #F8F8F8
web: #F8F8F8
mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd: #000000
mp-alipay、mp-kuaishou: #ffffff

否

导航栏背景颜色（同状态栏背景色）

navigationBarTextStyle

'white' | 'black'

"black"

否

导航栏标题颜色，仅支持 black/white

navigationBarTitleText

string

否

导航栏标题文字内容

navigationBarShadow

navigationBarShadow 配置项列表

否

导航栏阴影，配置参考下方导航栏阴影

navigationStyle

'default' | 'custom'

"default"

否

导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看使用注意。

disableScroll

boolean

false

否

设置为 true 则页面整体不能上下滚动（无bounce效果）。只在页面配置中有效，在 globalStyle 中设置无效。

backgroundColor

string (string.ColorString)

"#ffffff"

否

下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果）

backgroundColorContent

string (string.ColorString)

"#ffffff"

否

页面容器背景色

backgroundTextStyle

'dark' | 'light'

"dark"

否

下拉 loading 的样式，仅支持 dark/light

enablePullDownRefresh

boolean

false

否

是否开启下拉刷新，详见页面生命周期。

onReachBottomDistance

number

否

页面上拉触底事件触发时距页面底部距离，单位只支持px，详见页面生命周期。

pageOrientation

'auto' | 'portrait' | 'landscape'

"portrait"

否

页面旋转设置，支持 auto 设备自适应 / portrait 竖向 / landscape 横向

hideStatusBar

boolean

false

否

是否隐藏系统顶部状态栏

hideBottomNavigationIndicator

boolean

false

否

是否隐藏系统底部导航栏

androidThreeButtonNavigationTranslucent

boolean

false

否

页面内容是否可以渲染到虚拟按键区域

androidThreeButtonNavigationBackgroundColor

string (string.ColorString)

否

虚拟按键区域背景色

androidThreeButtonNavigationStyle

string (string.ThemeJsonString)

否

虚拟按键区域前景色

backgroundColorTop

string (string.ColorString)

"#ffffff"

否

顶部窗口的背景色(bounce回弹区域), 仅 iOS 平台

backgroundColorBottom

string (string.ColorString)

"#ffffff"

否

底部窗口的背景色(bounce回弹区域), 仅 iOS 平台

disableSwipeBack

boolean

false

否

是否禁用右滑手势关闭页面

titleImage

string (string.ImageURIString)

否

导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址

transparentTitle

'always' | 'auto' | 'none'

"none"

否

导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明

titlePenetrate

'YES' | 'NO'

"NO"

否

导航栏点击穿透

enableUcssReset

boolean

true

否

是否启用ucss样式覆盖

app-plus

app-plus 配置项列表

否

编译到 App 平台的特定样式

h5 h5 配置项列表 - 否 - 编译到 H5 平台的特定样式

mp-alipay

mp-alipay 配置项列表

否

支付宝小程序特有配置

mp-weixin

mp-weixin 配置项列表

否

微信小程序特有配置

mp-baidu

mp-baidu 配置项列表

否

百度小程序特有配置

mp-toutiao

object

否

头条小程序特有配置

mp-qq

object

否

QQ小程序特有配置

mp-kuaishou

object

否

快手小程序特有配置

mp-jd

object

否

设置编译到 mp-jd 平台的特定样式

mp-lark

object

否

飞书小程序特有配置

usingComponents

object

否

引用小程序组件，参考 [小程序组件https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html#小程序自定义组件支持)。

leftWindow

boolean

true

否

当存在 leftWindow时，当前页面是否显示 leftWindow

topWindow

boolean

true

否

当存在 topWindow时，当前页面是否显示 topWindow

rightWindow

boolean

true

否

当存在 rightWindow时，当前页面是否显示 rightWindow

maxWidth

number

否

Tips

横屏
- Web：横竖屏由手机浏览器控制，无法在pages.json中指定。uni-app x的页面和基础组件都支持自适应宽屏界面
- Android：默认是竖屏。从4.13起支持配置pageOrientation实现横屏或自动旋转适应
- iOS：在iPhone手机上默认竖屏，在iPad上默认自动旋转适应。从4.25起iPhone设置支持配置pageOrientation，iPad设备不受pageOrientation配置影响（表现为自动旋转适配），如需在iPad设备固定某个方向可以在项目的 Info.plist 中配置应用可支持的横竖屏列表来配置，详见应用可支持横竖屏列表配置，配置后应用将限定在可支持的横竖屏列表中配置的值（如配置应用可支持的列表仅为横屏，则应用只能显示为横屏）。uni-app x的页面和基础组件都支持自适应宽屏界面
状态栏
- 手机顶部状态栏的背景色、前景色(white/black)与navigationBarBackgroundColor和navigationBarTextStyle相同
- 小程序平台，pages.json中各个颜色的设置仅支持普通的16进制数值。App和Web支持设为transparent，即透明。
- 如需动态设置状态栏颜色，使用api uni.setNavigationBarColor
- 当navigationStyle设为custom时，原生导航栏不显示。此时需要注意系统状态栏背景色恒为透明。
- 注意不同手机的状态栏高度并不相同，如需获取本机的状态栏高度，使用api uni.getWindowInfo 或 css变量 --status-bar-height
- 配置hideStatusBar可以隐藏状态栏
- 同时隐藏状态栏hideStatusBar和底部指示器hideBottomNavigationIndicator，可以实现页面全屏
下拉刷新
- pages.json中下拉刷新是页面级配置，方便使用但灵活度有限。
- 如需自定义下拉刷新，请使用scroll-view或list-view的下拉刷新。
Android系统导航栏 (通常指手机底部按钮或手势指示条区域)
- 系统导航栏的背景颜色与backgroundColorContent颜色一致，导航栏的前景色会根据backgroundColorContent颜色自动适配 (4.21版本开始支持)
- tabBar页面的系统导航栏背景颜色取值策略参考
- 系统导航栏为全面屏手势时，HBuilderX4.31版本调整页面内容可以渲染到手势指示条区域（低版本页面内容会自动避开手势指示条区域），如需适配可以通过uni.getWindowInfo获取安全区域底部插入位置信息进行适配
- HBuilderX4.41版本起，App-Android平台支持配置页面内容是否渲染到虚拟按键区域，但横屏时会默认渲染到该区域且无法修改此行为，属于当前版本遗留问题，后续修复。

style示例

{
  "pages": [{
      "path": "pages/index/index",
      "style": {
        "navigationBarTitleText": "首页",//设置页面标题文字
        "enablePullDownRefresh":true//开启下拉刷新
      }
    },
    ...
  ]
}

示例源码如下，请查看 pre > code 标签中的内容

{
  "pages": [{
      "path": "pages/index/index",
      "style": {
        "navigationBarTitleText": "首页",//设置页面标题文字
        "enablePullDownRefresh":true//开启下拉刷新
      }
    },
    ...
  ]
}

# navigationBarShadow 配置项列表

导航栏阴影，配置参考下方导航栏阴影

属性

类型

默认值

必填

兼容性

描述

colorType

否

阴影的颜色，支持：grey、blue、green、orange、red、yellow

# 页面背景色

页面容器背景色：可在页面 json 文件中通过 backgroundColorContent 属性配置，支持 #RRGGBB 写法，默认为白色
窗口背景色：可在页面 json 文件中通过 backgroundColor 属性配置，支持 #RRGGBB 写法，默认为白色。被页面容器背景色覆盖，仅在页面设置下拉刷新时才可能看到此颜色

# h5 配置项列表

编译到 H5 平台的特定样式

属性

类型

默认值

必填

兼容性

描述

titleNView

titleNView 配置项列表

否

导航栏设置

pullToRefresh

pullToRefresh 配置项列表

否

下拉刷新

# mp-weixin 配置项列表

微信小程序特有配置

属性

类型

默认值

必填

兼容性

描述

homeButton

boolean

false

否

在非首页、非页面栈最底层页面或非tabbar内页面中的导航栏展示home键

backgroundColorTop

HexColor

"#ffffff"

否

顶部窗口的背景色，仅 iOS 支持

backgroundColorBottom

HexColor

"#ffffff"

否

顶部窗口的背景色，仅 iOS 支持

restartStrategy

'homePage' | 'homePageAndLatestPage'

"homePage"

否

重新启动策略配置。支持 homePage / homePageAndLatestPage

initialRenderingCache

'static' | 'dynamic'

否

页面初始渲染缓存配置。支持 static / dynamic

visualEffectInBackground

'none' | 'hidden'

"none"

否

切入系统后台时，隐藏页面内容，保护用户隐私。支持 hidden / none

handleWebviewPreload

'static' | 'manual' | 'none'

"static"

否

控制预加载下个页面的时机。支持 static / manual / auto

enableUcssReset

boolean

true

否

是否启用ucss样式覆盖

# tabBar 配置项列表

tabbar节点用于配置应用的tabbar，仅支持配置一个。如需在更多页面配置tabbar，见下面的自定义tabbar。

底部 tab 的表现

属性

类型

默认值

必填

兼容性

描述

color

string (string.ColorString)

是

tab 上的文字默认颜色

selectedColor

string (string.ColorString)

是

tab 上的文字选中时的颜色

backgroundColor

string (string.ColorString)

是

tab 的背景色

borderStyle

string (string.ThemeJsonString)

"black"

否

tabbar 上边框的颜色，可选值 black、white，black对应颜色rgba(0,0,0,0.33)，white对应颜色rgba(255,255,255,0.33)。

blurEffect

'dark' | 'extralight' | 'light' | 'none'

"none"

否

高斯模糊效果

list

Array<PagesOptionsTabbarList>

是

tab 的列表，详见 list 属性说明，最少2个、最多5个 tab

position

'top' | 'bottom'

"bottom"

否

tabbar 的位置,可选值 bottom、top。

fontSize

string

"10px"

否

文字默认大小

iconWidth

string

"24px"

否

图标默认宽度（高度等比例缩放）

spacing

string

"3px"

否

图标和文字的间距

height

string

"50px"

否

tabBar 默认高度

midButton

midButton 配置项列表

否

中间按钮仅在 list 项为偶数时有效

iconfontSrc

string

否

list设置 iconfont 属性时，需要指定字体文件路径

backgroundImage

string

否

设置背景图片，优先级高于 backgroundColor

backgroundRepeat

'repeat' | 'repeat-x' | 'repeat-y' | 'no-repeat'

"no-repeat"

否

设置标题栏的背景图平铺方式

redDotColor

string (string.ColorString)

否

tabbar上红点颜色

Tips

backgroundColor
- app-android平台：系统导航（System navigation）栏的背景色会与 tabBar 背景色保持一致。如果应用没有配置 tabBar 页面导航栏背景颜色取值策略参考
- app-ios平台：tabBar 会自动适配安全区域，底部安全区域背景色会与 tabBar 背景色保持一致。如果应用没有配置 tabBar，则不会自动适配底部安全区域，开发者需根据应用实际情况自行处理。
自定义tabbar：uni-tab-bar 自定义tabbar的核心逻辑：

tabbar页面刚开始只载入第一个子tab组件，其他tab组件是在点击相应的选项卡时v-if设为true来创建
一个子tab一旦被v-if加载后，不要再v-if设为false去掉，也不通过v-show控制，而是通过css的visibility来控制显示和隐藏。这样可以保留每个子tab的状态，比如滚动位置、输入框内容。切换tab也会更快速。

# PagesOptionsTabbarList 配置项列表

属性

类型

默认值

必填

兼容性

描述

iconfont

iconfont 配置项列表

否

字体图标，优先级高于 iconPath

pagePath

string (string.PageURIString)

是

页面路径，必须在 pages 中先定义

text

string

是

tab 上按钮文字，在 App 和 H5 平台为非必填。例如中间可放一个没有文字的+号图标

iconPath

string (string.ImageURIString)

否

图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标

selectedIconPath

string (string.ImageURIString)

否

选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 position 为 top 时，此参数无效

visible

boolean

否

该项是否显示，默认显示

tabbar示例

"tabBar": {
	"color": "#7A7E83",
	"selectedColor": "#3cc51f",
	"borderStyle": "black",
	"backgroundColor": "#ffffff",
	"list": [{
		"pagePath": "pages/component/index",
		"iconPath": "static/image/icon_component.png",
		"selectedIconPath": "static/image/icon_component_HL.png",
		"text": "组件"
	}, {
		"pagePath": "pages/API/index",
		"iconPath": "static/image/icon_API.png",
		"selectedIconPath": "static/image/icon_API_HL.png",
		"text": "接口"
	}]
}

示例源码如下，请查看 pre > code 标签中的内容

"tabBar": {
	"color": "#7A7E83",
	"selectedColor": "#3cc51f",
	"borderStyle": "black",
	"backgroundColor": "#ffffff",
	"list": [{
		"pagePath": "pages/component/index",
		"iconPath": "static/image/icon_component.png",
		"selectedIconPath": "static/image/icon_component_HL.png",
		"text": "组件"
	}, {
		"pagePath": "pages/API/index",
		"iconPath": "static/image/icon_API.png",
		"selectedIconPath": "static/image/icon_API_HL.png",
		"text": "接口"
	}]
}

# iconfont 配置项列表

字体图标，优先级高于 iconPath

属性

类型

默认值

必填

兼容性

描述

text

string

否

字库 Unicode 码

selectedText

string

否

选中后字库 Unicode 码

fontSize

string

否

字体图标字号(px)

color

string (string.ColorString)

否

字体图标颜色

selectedColor

string (string.ColorString)

否

字体图标选中颜色

# midButton 配置项列表

中间按钮仅在 list 项为偶数时有效

属性

类型

默认值

必填

兼容性

描述

width

string

"80px"

否

中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度

height

string

"80px"

否

中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果

text

string

否

中间按钮的文字

iconPath

string (string.ImageURIString)

否

中间按钮的图片路径

iconWidth

string

"24px"

否

图标默认宽度（高度等比例缩放）

backgroundImage

string (string.ImageURIString)

否

中间按钮的背景图片路径

iconfont

object

否

字体图标，优先级高于 iconPath

# topWindow 配置项列表

上窗体

属性

类型

默认值

必填

兼容性

描述

path

string

否

配置页面路径

style

object

否

配置页面窗口表现，配置项参考下方 pageStyle

matchMedia

matchMedia 配置项列表

否

配置显示该窗口的规则，配置项参考下方 matchMedia

# matchMedia 配置项列表

配置显示该窗口的规则，配置项参考下方 matchMedia

属性

类型

默认值

必填

兼容性

描述

minWidth

number

768

否

当设备可见区域宽度 minWidth 时，显示该 window+

# leftWindow 配置项列表

左窗体

属性

类型

默认值

必填

兼容性

描述

path

string

否

配置页面路径

style

object

否

配置页面窗口表现，配置项参考下方 pageStyle

matchMedia

matchMedia 配置项列表

否

配置显示该窗口的规则，配置项参考下方 matchMedia

# matchMedia 配置项列表

配置显示该窗口的规则，配置项参考下方 matchMedia

属性

类型

默认值

必填

兼容性

描述

minWidth

number

768

否

当设备可见区域宽度 minWidth 时，显示该 window+

# rightWindow 配置项列表

右窗体

属性

类型

默认值

必填

兼容性

描述

path

string

否

配置页面路径

style

object

否

配置页面窗口表现，配置项参考下方 pageStyle

matchMedia

matchMedia 配置项列表

否

配置显示该窗口的规则，配置项参考下方 matchMedia

# matchMedia 配置项列表

配置显示该窗口的规则，配置项参考下方 matchMedia

属性

类型

默认值

必填

兼容性

描述

minWidth

number

768

否

当设备可见区域宽度 minWidth 时，显示该 window+

# condition 配置项列表

启动模式配置，仅开发期间生效，用于模拟直达页面的场景。教程详见

启动模式

属性

类型

默认值

必填

兼容性

描述

current

number

是

当前激活的模式，list节点的索引值。

list

Array<PagesConditionItem>

是

启动模式列表

# PagesConditionItem 配置项列表

属性

类型

默认值

必填

兼容性

描述

name

string

是

启动模式名称

path

string (string.PageURIString)

是

启动页面路径

query

string

否

启动参数，可在页面的 onLoad 函数里获得

# easycom 配置项列表

easycom是uni-app提供的一种简化组件使用的方式。一般情况下组件放置在符合规范的位置时即可自动引用。

但有时组件的路径或文件名无法满足easycom默认规范要求，可以在pages.json里进行规则的自定义。

自定义easycom的详细教程详见

组件自动引入规则

属性

类型

默认值

必填

兼容性

描述

autoscan

boolean

true

否

是否开启自动扫描，开启后将会自动扫描符合components/组件名称/组件名称.vue/uvue目录结构的组件

custom

object

否

以正则方式自定义组件匹配规则。如果autoscan不能满足需求，可以使用custom自定义匹配规则

# uniIdRouter 配置项列表

根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：详见

属性

类型

默认值

必填

兼容性

描述

loginPage

string (string.PageURIString)

否

登录页面路径

resToLogin

boolean

否

是否开启自动根据响应体判断跳转登录页面，默认true（开启）

needLogin

Array<string,string.PageURIString>

否

# subPackages 配置项列表

分包加载配置，此配置为小程序的分包加载机制。详细教程详见

subPackages 节点接收一个数组，数组每一项都是应用的子包，其属性值如下：

属性

类型

默认值

必填

兼容性

描述

root

string

是

子包的根目录

pages

Array<SubPackagePagesOptionsPage>

是

子包由哪些页面组成，参数同 pages

# preloadRule 配置项列表

分包预载配置。

配置preloadRule后，在进入小程序某个页面时，由框架自动预下载可能需要的分包，提升进入后续分包页面时的启动速度

preloadRule 中，key 是页面路径，value 是进入此页面的预下载配置，每个配置有以下几项：

声明分包预下载的规则

属性

类型

默认值

必填

兼容性

描述

network

'all' | 'wifi'

"wifi"

否

在指定网络下预下载，可选值为：all（不限网络）、wifi（仅wifi下预下载）

packages

Array<string>

是

进入页面后预下载分包的 root 或 name。APP 表示主包。

# pages.json

# 配置项列表

# globalStyle 配置项列表

# h5 配置项列表

# titleNView 配置项列表

# pullToRefresh 配置项列表

# contentdown 配置项列表

# contentover 配置项列表

# contentrefresh 配置项列表

# mp-weixin 配置项列表

# pages 配置项列表

# style 配置项列表

# navigationBarShadow 配置项列表

# 页面背景色

# h5 配置项列表

# mp-weixin 配置项列表

# tabBar 配置项列表

# PagesOptionsTabbarList 配置项列表

# iconfont 配置项列表

# midButton 配置项列表

# topWindow 配置项列表

# matchMedia 配置项列表

# leftWindow 配置项列表

# matchMedia 配置项列表

# rightWindow 配置项列表

# matchMedia 配置项列表

# condition 配置项列表

# PagesConditionItem 配置项列表

# easycom 配置项列表

# uniIdRouter 配置项列表

# subPackages 配置项列表

# preloadRule 配置项列表

# 参见

本页导读