Skip to content

Commit 8a201b1

Browse files
authored
Merge branch 'master' into fix-movable-position
2 parents 71257bc + cc216d1 commit 8a201b1

121 files changed

Lines changed: 3924 additions & 1491 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs-vitepress/.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const sidebar = {
1818
{ text: "快速开始", link: "/guide/basic/start" },
1919
{ text: "介绍", link: "/guide/basic/intro" },
2020
{ text: "单文件开发", link: "/guide/basic/single-file" },
21-
{ text: "IDE 高亮配置", link: "/guide/basic/ide" },
21+
{ text: "IDE 支持", link: "/guide/basic/ide" },
2222
{ text: "模板语法", link: "/guide/basic/template" },
2323
{ text: "CSS 处理", link: "/guide/basic/css" },
2424
{ text: "数据响应", link: "/guide/basic/reactive" },

docs-vitepress/api/app-config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ mpx.config.webRouteConfig = {
158158
```
159159

160160
## webConfig
161-
web 环境下的一些配置,如路由模式,页面切换动画效果等
161+
web 环境下的一些配置,如路由模式
162162

163163
- **用法**:
164164
```js
@@ -169,3 +169,4 @@ mpx.config.webConfig.routeConfig = {
169169
// 禁用页面切换动画
170170
mpx.config.webConfig.disablePageTransition = true
171171
```
172+
此处的 `disablePageTransition` 后续将被废弃,请使用编译阶段的[disablePageTransition](./compile.md#webconfig)进行配置

docs-vitepress/api/compile.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -824,8 +824,17 @@ module.exports = defineConfig({
824824

825825
transRpxFn 配置用于自定义输出 web 时对于 rpx 样式单位的转换逻辑,常见的方式有转换为 vw 或转换为 rem
826826

827+
`{useSSR: boolean}`
828+
829+
useSSR 默认值为 `false`,当 SSR 模式下使用异步分包时,需要将 useSSR 设置为 `true`, 其他场景不需要。
830+
831+
`{disablePageTransition: boolean}`
832+
833+
用于配置禁用/开启页面切换动画,默认禁用
834+
835+
827836
```js
828-
// vue.config.js
837+
// mpx.config.js
829838
module.exports = defineConfig({
830839
pluginOptions: {
831840
mpx: {
@@ -834,7 +843,11 @@ module.exports = defineConfig({
834843
transRpxFn: function (match, $1) {
835844
if ($1 === '0') return $1
836845
return `${$1 * +(100 / 750).toFixed(8)}vw`
837-
}
846+
},
847+
// 当 SSR 模式下使用异步分包时
848+
useSSR: true,
849+
// 开启页面切换动画
850+
disablePageTransition: false
838851
}
839852
}
840853
}

docs-vitepress/api/extend.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,24 @@ mpx-fetch提供了一个实例**xfetch** ,该实例包含以下api
1414

1515
config 可指定以下属性:
1616
- **url**
17-
17+
1818
`string`
19-
19+
2020
设置请求url
2121
- **method**
2222

2323
`string`
24-
24+
2525
设置请求方式,默认为GET
2626
- **data**
2727

2828
`object`
29-
29+
3030
设置请求参数
3131
- **params**
3232

3333
`object`
34-
34+
3535
设置请求参数,参数会以 Query String 的形式进行传递
3636
- **header**
3737

@@ -40,14 +40,14 @@ mpx-fetch提供了一个实例**xfetch** ,该实例包含以下api
4040
设置请求的 header,header 中不能设置 Referer。
4141
`content-type` 默认为 `application/json`
4242
- **timeout**
43-
43+
4444
`number`
45-
45+
4646
单位为毫秒。若不传,默认读取app.json文件中__networkTimeout属性。 对于超时的处理可在 catch 方法中进行
4747
- **emulateJSON**
4848

4949
`boolean`
50-
50+
5151
设置为 true 时,等价于 header = {'content-type': 'application/x-www-form-urlencoded'}
5252
- **usePre**
5353

@@ -483,7 +483,7 @@ useFetch().fetch({
483483
| closeBLEConnection |:white_check_mark:|:white_check_mark:|:x:|:x:|
484484
| createBLEConnection |:white_check_mark:|:white_check_mark:|:x:|:x:|
485485
| onBLEConnectionStateChange |:white_check_mark:|:white_check_mark:|:x:|:x:|
486-
| createIntersectionObserver |:white_check_mark:|:white_check_mark:|:x:|:x:|
486+
| createIntersectionObserver |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
487487
| createSelectorQuery |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
488488
| getExtConfig |:white_check_mark:|:white_check_mark:|:x:|:x:|
489489
| getExtConfigSync |:white_check_mark:|:white_check_mark:|:x:|:x:|
@@ -565,6 +565,7 @@ useFetch().fetch({
565565
| onNetworkStatusChange |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
566566
| offNetworkStatusChange |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
567567
| createVideoContext |:white_check_mark:|:white_check_mark:|:white_check_mark:|:x:|
568+
| onLazyLoadError |:white_check_mark:|:white_check_mark:|:x:|:white_check_mark:|
568569
## webview-bridge
569570
Mpx 支持小程序跨平台后,多个平台的小程序里都提供了 webview 组件,webview 打开的 H5 页面可以通过小程序提供的 API 来与小程序通信以及调用一些小程序的能力,但是各家小程序对于 webview 提供的API是不一样的。
570571

@@ -694,20 +695,20 @@ Mpx框架项目包体积可以进行分组、分包、页面、冗余Npm包等
694695
`Array<object>`
695696

696697
配置体积计算分组,以输入分组为维度对体积进行分析,当没有该配置时结果中将不会包含分组体积信息
697-
698+
698699
- name
699-
700+
700701
`string`
701702

702703
分组名称
703704

704705
- threshold
705-
706+
706707
`string | object`
707708

708709
分组相关体积阈值,若不配置则该分组不校验体积阈值,同时也支持对分组中占各分包体积阈值
709710

710-
711+
711712
```html
712713
// 分组体积限额 500KB
713714
threshold: '500KB'
@@ -719,32 +720,32 @@ Mpx框架项目包体积可以进行分组、分包、页面、冗余Npm包等
719720
}
720721
}
721722
```
722-
723+
723724
- entryRules
724-
725+
725726
`object`
726-
727+
727728
配置分组 entry 匹配规则,小程序中所有的页面和组件都可被视为 entry
728-
729+
729730
- include: 包含符合条件的入口文件,默认为空数组,规则数组中支持函数、正则、字符串
730731
- exclude: 剔除符合条件的入口文件,默认为空数组,规则数组中支持函数、正则、字符串
731-
732-
732+
733+
733734
```html
734735
include: [/@someGroup\/some-npm-package/],
735736
exclude: [/@someGroup\/some-two-pack/]
736737
```
737-
738+
738739
- noEntryRules
739740

740741
`object`
741742

742743
配置计算分组中纯 js 入口引入的体积(不包含组件和页面)
743-
744+
744745
- include: 包含符合条件的 js 文件,默认为空数组,规则数组中支持函数、正则、字符串
745746
- exclude: 剔除符合条件的 js 文件,默认为空数组,规则数组中支持函数、正则、字符串
746-
747-
747+
748+
748749
```html
749750
include: [/@someGroup\/some-npm-package/],
750751
exclude: [/@someGroup\/some-two-pack/]
@@ -982,7 +983,7 @@ function t(key: string, choice?: number, values: Array | Object): TranslateResul
982983
}
983984
}
984985
}
985-
986+
986987
createComponent({
987988
setup(){
988989
const { t } = useI18n({
63.5 KB
Loading
80.5 KB
Loading

docs-vitepress/guide/advance/async-subpackage.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@
1010
* 支付宝小程序
1111
* 字节小程序
1212
* Web
13+
* RN
1314

1415
在非上述平台,异步分包代码会默认降级。
1516

1617
## 跨分包自定义组件引用
1718
>一个分包使用其他分包的自定义组件时,由于其他分包还未下载或注入,其他分包的组件处于不可用的状态。通过为其他分包的自定义组件设置 占位组件,
1819
我们可以先渲染占位组件作为替代,在分包下载完成后再进行替换。
19-
>
20+
>
2021
在 Mpx 中使用跨分包自定义组件引用通过?root声明组件所属异步分包即可使用,示例如下:
2122
```html
2223
<!--/packageA/pages/index.mpx-->
@@ -33,7 +34,7 @@
3334
}
3435
</script>
3536
```
36-
- 注意项:目前该能力已在微信、支付宝和Web环境下支持,其他环境下框架将进行自动降级。
37+
- 注意项:目前该能力已在微信、支付宝、Web和RN环境下支持,其他环境下框架将进行自动降级。
3738

3839
## 跨分包 JS 代码引用
3940
>一个分包中的代码引用其它分包的代码时,为了不让下载阻塞代码运行,我们需要异步获取引用的结果

docs-vitepress/guide/advance/platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ onShow|是
630630
onHide|是
631631
onUnload|是
632632
onError|是
633-
onServerPrefetch
633+
onServerPrefetch|
634634
created|是
635635
attached|是
636636
ready|是

docs-vitepress/guide/basic/component.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,6 @@ createComponent({
151151
})
152152
</script>
153153
```
154-
// TODO data 的注意项
155-
156154

157155
### computed
158156

0 commit comments

Comments
 (0)