Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
2ac11b7c
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3188
Star
106
Fork
809
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
93
列表
看板
标记
里程碑
合并请求
69
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
93
Issue
93
列表
看板
标记
里程碑
合并请求
69
合并请求
69
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
2ac11b7c
编写于
9月 07, 2023
作者:
DCloud-WZF
💬
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs(uni-app x): pages and router
上级
c28e3010
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
26 addition
and
26 deletion
+26
-26
docs/api/router.md
docs/api/router.md
+4
-4
docs/collocation/pages.md
docs/collocation/pages.md
+22
-22
未找到文件。
docs/api/router.md
浏览文件 @
2ac11b7c
...
...
@@ -7,8 +7,8 @@
|参数|类型|必填|默认值|说明|平台差异说明|
|:-|:-|:-|:-|:-|:-|
|url|String|是||需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数。参数与路径之间使用?分隔,参数键与参数值用=相连,不同参数用&分隔;如 'path?key=value&key2=value2',path为下一个页面的路径,下一个页面的onLoad函数可得到传递的参数| |
|animationType|String|否|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
api/router?id=animation
)
|App|
|animationDuration|Number|否|300|窗口动画持续时间,单位为 ms|App|
|animationType|String|否|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
api/router?id=animation
)
|App
(uni-app x 不支持)
|
|animationDuration|Number|否|300|窗口动画持续时间,单位为 ms|App
(uni-app x 不支持)
|
|events|Object|否||页面间通信接口,用于监听被打开页面发送到当前页面的数据。2.8.9+ 开始支持。||
|success|Function|否||接口调用成功的回调函数||
|fail|Function|否||接口调用失败的回调函数||
...
...
@@ -200,8 +200,8 @@ uni.switchTab({
|参数|类型|必填|默认值|说明|平台差异说明|
|:-|:-|:-|:-|:-|:-|
|delta|Number|否|1|返回的页面数,如果 delta 大于现有页面数,则返回到首页。||
|animationType|String|否|pop-out|窗口关闭的动画效果,详见:
[
窗口动画
](
api/router?id=animation
)
|App|
|animationDuration|Number|否|300|窗口关闭动画的持续时间,单位为 ms|App|
|animationType|String|否|pop-out|窗口关闭的动画效果,详见:
[
窗口动画
](
api/router?id=animation
)
|App
(uni-app x 不支持)
|
|animationDuration|Number|否|300|窗口关闭动画的持续时间,单位为 ms|App
(uni-app x 不支持)
|
|success|Function|否|接口调用成功的回调函数|
|fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
...
...
docs/collocation/pages.md
浏览文件 @
2ac11b7c
...
...
@@ -18,7 +18,7 @@
|
[
leftWindow
](
/collocation/pages?id=leftwindow
)
|Object|否|大屏左侧窗口|H5|
|
[
topWindow
](
/collocation/pages?id=topwindow
)
|Object|否|大屏顶部窗口|H5|
|
[
rightWindow
](
/collocation/pages?id=rightwindow
)
|Object|否|大屏右侧窗口|H5|
|
[
uniIdRouter
](
/uniCloud/uni-id-summary.md?id=uni-id-router
)
|Object|否|自动跳转相关配置,新增于HBuilderX 3.5.0|
app-uvue
不支持|
|
[
uniIdRouter
](
/uniCloud/uni-id-summary.md?id=uni-id-router
)
|Object|否|自动跳转相关配置,新增于HBuilderX 3.5.0|
uni-app x
不支持|
|entryPagePath|String|否|默认启动首页,新增于HBuilderX 3.7.0|微信小程序、支付宝小程序|
以下是一个包含了所有配置选项的
`pages.json`
:
...
...
@@ -142,15 +142,15 @@
|backgroundColor|HexColor|#ffffff|下拉显示出来的窗口的背景色|微信小程序|
|backgroundTextStyle|String|dark|下拉 loading 的样式,仅支持 dark / light|微信小程序|
|enablePullDownRefresh|Boolean|false|是否开启下拉刷新,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
。||
|onReachBottomDistance|Number|50|页面上拉触底事件触发时距页面底部距离,单位只支持px,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
|
app-uvue
不支持|
|onReachBottomDistance|Number|50|页面上拉触底事件触发时距页面底部距离,单位只支持px,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
|
uni-app x
不支持|
|backgroundColorTop|HexColor|#ffffff|顶部窗口的背景色(bounce回弹区域)|仅 iOS 平台|
|backgroundColorBottom|HexColor|#ffffff|底部窗口的背景色(bounce回弹区域)|仅 iOS 平台|
|titleImage|String||导航栏图片地址(替换当前文字标题),支付宝小程序内必须使用https的图片链接地址|支付宝小程序、H5、APP(
app-uvue
不支持)|
|transparentTitle|String|none|导航栏整体(前景、背景)透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明|支付宝小程序、H5、APP(
app-uvue
不支持)|
|titleImage|String||导航栏图片地址(替换当前文字标题),支付宝小程序内必须使用https的图片链接地址|支付宝小程序、H5、APP(
uni-app x
不支持)|
|transparentTitle|String|none|导航栏整体(前景、背景)透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明|支付宝小程序、H5、APP(
uni-app x
不支持)|
|titlePenetrate|String|NO|导航栏点击穿透|支付宝小程序、H5|
|pageOrientation|String|portrait|横屏配置,屏幕旋转设置,仅支持 auto / portrait / landscape 详见
[
响应显示区域变化
](
https://developers.weixin.qq.com/miniprogram/dev/framework/view/resizable.html
)
|App 2.4.7+(
app-uvue
不支持)、微信小程序、QQ小程序|
|animationType|String|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
/api/router?id=animation
)
|App(
app-uvue
不支持)|
|animationDuration|Number|300|窗口显示动画的持续时间,单位为 ms|App(
app-uvue
不支持)|
|pageOrientation|String|portrait|横屏配置,屏幕旋转设置,仅支持 auto / portrait / landscape 详见
[
响应显示区域变化
](
https://developers.weixin.qq.com/miniprogram/dev/framework/view/resizable.html
)
|App 2.4.7+(
uni-app x
不支持)、微信小程序、QQ小程序|
|animationType|String|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
/api/router?id=animation
)
|App(
uni-app x
不支持)|
|animationDuration|Number|300|窗口显示动画的持续时间,单位为 ms|App(
uni-app x
不支持)|
|app-plus|Object||设置编译到 App 平台的特定样式,配置项参考下方
[
app-plus
](
/collocation/pages?id=app-plus
)
|App|
|h5|Object||设置编译到 H5 平台的特定样式,配置项参考下方
[
H5
](
/collocation/pages?id=h5
)
|H5|
|mp-alipay|Object||设置编译到 mp-alipay 平台的特定样式,配置项参考下方
[
MP-ALIPAY
](
/collocation/pages?id=mp-alipay
)
|支付宝小程序|
...
...
@@ -161,7 +161,7 @@
|mp-qq|Object||设置编译到 mp-qq 平台的特定样式|QQ小程序|
|mp-kuaishou|Object||设置编译到 mp-kuaishou 平台的特定样式|快手小程序|
|mp-jd|Object||设置编译到 mp-jd 平台的特定样式|京东小程序|
|usingComponents|Object| |引用小程序组件,参考
[
小程序组件
](
/tutorial/miniprogram-subject.html#小程序自定义组件支持
)
|
app-uvue
不支持|
|usingComponents|Object| |引用小程序组件,参考
[
小程序组件
](
/tutorial/miniprogram-subject.html#小程序自定义组件支持
)
|
uni-app x
不支持|
|renderingMode|String| |同层渲染,webrtc(实时音视频) 无法正常时尝试配置 seperated 强制关掉同层|微信小程序|
|leftWindow|Boolean|true|当存在 leftWindow 时,默认是否显示 leftWindow|H5|
|topWindow|Boolean|true|当存在 topWindow 时,默认是否显示 topWindow|H5|
...
...
@@ -335,18 +335,18 @@ uni-app 2.9+ 新增 leftWindow, topWindow, rightWindow 配置。用于解决宽
|navigationBarBackgroundColor|HexColor|#F8F8F8|导航栏背景颜色(同状态栏背景色)|APP与H5为#F8F8F8,小程序平台请参考相应小程序文档|
|navigationBarTextStyle|String|black|导航栏标题颜色及状态栏前景颜色,仅支持 black/white||
|navigationBarTitleText|String||导航栏标题文字内容||
|navigationBarShadow|Object||导航栏阴影,配置参考下方
[
导航栏阴影
](
/collocation/pages?id=navigationBarShadow
)
|
app-uvue
不支持|
|navigationBarShadow|Object||导航栏阴影,配置参考下方
[
导航栏阴影
](
/collocation/pages?id=navigationBarShadow
)
|
uni-app x
不支持|
|navigationStyle|String|default|导航栏样式,仅支持 default/custom。custom即取消默认的原生导航栏,需看
[
使用注意
](
/collocation/pages?id=customnav
)
|微信小程序 7.0+、百度小程序、H5、App(2.0.3+)|
|disableScroll|Boolean|false|设置为 true 则页面整体不能上下滚动(bounce效果),只在页面配置中有效,在globalStyle中设置无效|微信小程序(iOS)、百度小程序(iOS)|
|backgroundColor|HexColor|#ffffff|窗口的背景色|微信小程序、百度小程序、抖音小程序、飞书小程序、京东小程序|
|backgroundTextStyle|String|dark|下拉 loading 的样式,仅支持 dark/light|
app-uvue
不支持|
|backgroundTextStyle|String|dark|下拉 loading 的样式,仅支持 dark/light|
uni-app x
不支持|
|enablePullDownRefresh|Boolean|false|是否开启下拉刷新,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
。||
|onReachBottomDistance|Number|50|页面上拉触底事件触发时距页面底部距离,单位只支持px,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
|
app-uvue
不支持|
|onReachBottomDistance|Number|50|页面上拉触底事件触发时距页面底部距离,单位只支持px,详见
[
页面生命周期
](
/tutorial/page.html#lifecycle
)
|
uni-app x
不支持|
|backgroundColorTop|HexColor|#ffffff|顶部窗口的背景色(bounce回弹区域)|仅 iOS 平台|
|backgroundColorBottom|HexColor|#ffffff|底部窗口的背景色(bounce回弹区域)|仅 iOS 平台|
|disableSwipeBack|Boolean|false|是否禁用滑动返回|App-iOS(3.4.0+)|
|titleImage|String||导航栏图片地址(替换当前文字标题),支付宝小程序内必须使用https的图片链接地址|支付宝小程序、H5、App(
app-uvue
不支持)|
|transparentTitle|String|none|导航栏透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明|支付宝小程序、H5、APP(
app-uvue
不支持)|
|titleImage|String||导航栏图片地址(替换当前文字标题),支付宝小程序内必须使用https的图片链接地址|支付宝小程序、H5、App(
uni-app x
不支持)|
|transparentTitle|String|none|导航栏透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明|支付宝小程序、H5、APP(
uni-app x
不支持)|
|titlePenetrate|String|NO|导航栏点击穿透|支付宝小程序、H5|
|app-plus|Object||设置编译到 App 平台的特定样式,配置项参考下方
[
app-plus
](
/collocation/pages?id=app-plus
)
|App|
|h5|Object||设置编译到 H5 平台的特定样式,配置项参考下方
[
H5
](
/collocation/pages?id=h5
)
|H5|
...
...
@@ -358,7 +358,7 @@ uni-app 2.9+ 新增 leftWindow, topWindow, rightWindow 配置。用于解决宽
|mp-qq|Object||设置编译到 mp-qq 平台的特定样式|QQ小程序|
|mp-kuaishou|Object||设置编译到 mp-kuaishou 平台的特定样式|快手小程序|
|mp-jd|Object||设置编译到 mp-jd 平台的特定样式|京东小程序|
|usingComponents|Object||引用小程序组件,参考
[
小程序组件
](
/tutorial/miniprogram-subject.html#小程序自定义组件支持
)
|App(
app-uvue
不支持)、微信小程序、支付宝小程序、百度小程序、京东小程序|
|usingComponents|Object||引用小程序组件,参考
[
小程序组件
](
/tutorial/miniprogram-subject.html#小程序自定义组件支持
)
|App(
uni-app x
不支持)、微信小程序、支付宝小程序、百度小程序、京东小程序|
|leftWindow|Boolean|true|当存在 leftWindow时,当前页面是否显示 leftWindow|H5|
|topWindow|Boolean|true|当存在 topWindow 时,当前页面是否显示 topWindow|H5|
|rightWindow|Boolean|true|当存在 rightWindow时,当前页面是否显示 rightWindow|H5|
...
...
@@ -430,16 +430,16 @@ uni-app 2.9+ 新增 leftWindow, topWindow, rightWindow 配置。用于解决宽
|属性|类型|默认值|描述|平台兼容|
|:-|:-|:-|:-|:-|
|background|HexColor|#FFFFFF|窗体背景色。无论vue页面还是nvue页面,在App上都有一个父级原生窗体,该窗体的背景色生效时间快于页面里的css生效时间|App (vue 页面需要将 body 背景色设为透明,app-uvue 不支持)|
|titleNView|Object||导航栏 ,详见:
[
导航栏
](
/collocation/pages?id=app-titleNView
)
|App(
app-uvue
不支持)、H5|
|subNVues|Object||原生子窗体,详见:
[
原生子窗体
](
/collocation/pages?id=app-subNVues
)
|App 1.9.10+(
app-uvue
不支持)|
|titleNView|Object||导航栏 ,详见:
[
导航栏
](
/collocation/pages?id=app-titleNView
)
|App(
uni-app x
不支持)、H5|
|subNVues|Object||原生子窗体,详见:
[
原生子窗体
](
/collocation/pages?id=app-subNVues
)
|App 1.9.10+(
uni-app x
不支持)|
|bounce|String||页面回弹效果,设置为 "none" 时关闭效果。|App-vue(nvue Android无页面级bounce效果,仅list、recycle-list、waterfall等滚动组件有bounce效果)|
|popGesture|String|close|侧滑返回功能,可选值:"close"(启用侧滑返回)、"none"(禁用侧滑返回)|App-iOS|
|softinputNavBar|String|auto|iOS软键盘上完成工具栏的显示模式,设置为 "none" 时关闭工具栏。|App-iOS|
|softinputMode|String|adjustPan|软键盘弹出模式,支持 adjustResize、adjustPan 两种模式|App(
app-uvue
不支持)|
|pullToRefresh|Object||下拉刷新|App(
app-uvue
不支持)|
|scrollIndicator|String||滚动条显示策略,设置为 "none" 时不显示滚动条。|App(
app-uvue
不支持)|
|animationType|String|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
/api/router?id=animation
)
。|App(
app-uvue
不支持)|
|animationDuration|Number|300|窗口显示动画的持续时间,单位为 ms。|App(
app-uvue
不支持)|
|softinputMode|String|adjustPan|软键盘弹出模式,支持 adjustResize、adjustPan 两种模式|App(
uni-app x
不支持)|
|pullToRefresh|Object||下拉刷新|App(
uni-app x
不支持)|
|scrollIndicator|String||滚动条显示策略,设置为 "none" 时不显示滚动条。|App(
uni-app x
不支持)|
|animationType|String|pop-in|窗口显示的动画效果,详见:
[
窗口动画
](
/api/router?id=animation
)
。|App(
uni-app x
不支持)|
|animationDuration|Number|300|窗口显示动画的持续时间,单位为 ms。|App(
uni-app x
不支持)|
**Tips**
-
`.nvue`
页面仅支持
`titleNView、pullToRefresh、scrollIndicator`
配置,其它配置项暂不支持
...
...
@@ -998,7 +998,7 @@ h5 平台下拉刷新动画,只有 circle 类型。
|selectedColor|HexColor|是||tab 上的文字选中时的颜色||
|backgroundColor|HexColor|是||tab 的背景色||
|borderStyle|String|否|black|tabbar 上边框的颜色,可选值 black/white,也支持其他颜色值|App 2.3.4+ 、H5 3.0.0+|
|blurEffect|String|否|none|iOS 高斯模糊效果,可选值 dark/extralight/light/none(参考:
[
使用说明
](
https://ask.dcloud.net.cn/article/36617
)
)|App 2.4.0+ 支持(
app-uvue
不支持)、H5 3.0.0+(只有最新版浏览器才支持)|
|blurEffect|String|否|none|iOS 高斯模糊效果,可选值 dark/extralight/light/none(参考:
[
使用说明
](
https://ask.dcloud.net.cn/article/36617
)
)|App 2.4.0+ 支持(
uni-app x
不支持)、H5 3.0.0+(只有最新版浏览器才支持)|
|list|Array|是||tab 的列表,详见 list 属性说明,最少2个、最多5个 tab||
|position|String|否|bottom|可选值 bottom、top|top 值仅微信小程序支持|
|fontSize|String|否|10px|文字默认大小|App 2.3.4+、H5 3.0.0+|
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录