diff --git a/docs/component/page-meta.md b/docs/component/page-meta.md index 708c817165c6a1d1ec2d122a1fe02c85511a3021..21ac14dfe12a79a01739233665590f0bec7a19aa 100644 --- a/docs/component/page-meta.md +++ b/docs/component/page-meta.md @@ -1,11 +1,23 @@ #### page-meta -页面属性配置节点,用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 [navigation-bar](https://uniapp.dcloud.io/component/navigation-bar) 组件一同使用。 +页面属性配置节点,用于指定页面的一些属性、监听页面事件。可部分替代pages.json的功能。 -HBuilderX 2.6.3+ 支持 +从微信基础库2.9.0开始,新增了`page-meta`组件,它是一个特殊的标签,有点类似html里的header标签。页面的背景色、原生导航栏的参数,都可以写在`page-meta`里。HBuilderX 2.6.3+ 支持了这个组件,并且全平台都实现了。 +从某种意义讲,`page-meta`对pages.json有一定替代作用,可以让页面的配置和页面内容代码写在一个vue文件中。它还可以实现通过变量绑定来控制页面配置。但它的性能不如pages.json的配置,在新页面加载时,渲染速度还是pages.json方式的写法更快。 -|属性|类型|默认值|必填|说明|最低版本 +`page-meta`只能是页面内的第一个节点。可以配合 [navigation-bar](https://uniapp.dcloud.io/component/navigation-bar) 组件一同使用。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√ 2.6.3+|2.6.3+|√ 2.9.0+|√|√|√|√| + +从HBuilderX 2.9.3起,编译到所有平台均支持`page-meta`,但编译到微信时,受微信基础库版本限制;编译到其他平台不受平台版本限制。 + +**属性说明** +|属性|类型|默认值|必填|说明|版本要求 |:-|:-|:-|:-|:-|:-| |background-text-style|string||否|下拉背景字体、loading 图的样式,仅支持 dark 和 light|微信基础库 2.9.0| |background-color|string||否|窗口的背景色,必须为十六进制颜色值|微信基础库 2.9.0| @@ -15,13 +27,14 @@ HBuilderX 2.6.3+ 支持 |scroll-duration|number|300|否|滚动动画时长|微信基础库 2.9.0| |page-style|string|""|否|页面根节点样式,页面根节点是所有页面节点的祖先节点,相当于 HTML 中的 body 节点|微信基础库 2.9.0| |root-font-size|string|""|否|页面的根字体大小,页面中的所有 rem 单位,将使用这个字体大小作为参考值,即 1rem 等于这个字体大小|微信基础库 2.9.0| -|@resize||eventhandle||否|页面尺寸变化时会触发 resize 事件, event.detail = { size: { windowWidth, windowHeight } }|微信基础库 2.9.0| -|@scroll||eventhandle||否|页面滚动时会触发 scroll 事件, event.detail = { scrollTop }|微信基础库 2.9.0| -|@scrolldone|eventhandle||否|如果通过改变 scroll-top 属性来使页面滚动,页面滚动结束后会触发 scrolldone 事件|微信基础库 2.9.0| +|@resize||eventhandle|否|页面尺寸变化时会触发 resize 事件, event.detail = { size: { windowWidth, windowHeight } }|微信基础库 2.9.0| +|@scroll||eventhandle|否|页面滚动时会触发 scroll 事件, event.detail = { scrollTop }|微信基础库 2.9.0| +|@scrolldone|eventhandle|否|如果通过改变 scroll-top 属性来使页面滚动,页面滚动结束后会触发 scrolldone 事件|微信基础库 2.9.0| **注意** -- `` 会覆盖 page.json 配置 +- `` 目前支持的配置仅为上表所列,并不支持所有 page.json 的配置 +- `` 与 pages.json 的设置相冲突时,会覆盖 page.json 的配置 #### 示例代码