Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
db6619b1
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3216
Star
106
Fork
815
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
94
列表
看板
标记
里程碑
合并请求
70
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
94
Issue
94
列表
看板
标记
里程碑
合并请求
70
合并请求
70
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
db6619b1
编写于
10月 20, 2022
作者:
Q
qiang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: composition-api for Vue2
上级
b960f305
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
122 addition
and
0 deletion
+122
-0
docs/tutorial/_sidebar.md
docs/tutorial/_sidebar.md
+1
-0
docs/tutorial/vue-composition-api.md
docs/tutorial/vue-composition-api.md
+121
-0
未找到文件。
docs/tutorial/_sidebar.md
浏览文件 @
db6619b1
...
...
@@ -15,6 +15,7 @@
*
[
组件
](
/tutorial/vue-components.md
)
*
[
API
](
/tutorial/vue-api.md
)
*
[
vuex
](
/tutorial/vue-vuex.md
)
*
[
组合式 API
](
/tutorial/vue-composition-api.md
)
*
[
vue3
](
/tutorial/vue3-basics.md
)
*
[
基础
](
/tutorial/vue3-basics.md
)
*
[
组件
](
/tutorial/vue3-components.md
)
...
...
docs/tutorial/vue-composition-api.md
0 → 100644
浏览文件 @
db6619b1
## 组合式 API
目前 uni-app(Vue2) 基于 Vue 2.6,组合式 API 由
[
@vue/composition-api
](
https://github.com/vuejs/composition-api
)
支持,script setup 由
[
unplugin-vue2-script-setup
](
https://github.com/antfu/unplugin-vue2-script-setup
)
支持。
### 环境准备
升级 uni-app 编译器到 3.6.7 alpha
*
HBuilderX 创建的项目直接升级 HBuilderX 到最新 alpha 版即可
*
CLI 创建的项目参考
[
https://uniapp.dcloud.net.cn/quickstart-cli.html#cliversion
](
https://uniapp.dcloud.net.cn/quickstart-cli.html#cliversion
)
升级依赖到最新 alpha 版
### 使用组合式API
1.
使用 npm/yarn 安装 @vue/composition-api,此包目前仅用于提供语法提示等,编译器内部内置修改过的固定版本。
```
shell
npm
install
@vue/composition-api
# or
yarn add @vue/composition-api
```
2.
在 main.js/ts 文件内增加安装 @vue/composition-api 插件
::: preview
> main.js
```
js
import
'
./composition-api
'
import
Vue
from
'
vue
'
import
App
from
'
./App.vue
'
Vue
.
config
.
productionTip
=
false
const
app
=
new
(
typeof
App
===
'
function
'
?
App
:
Vue
.
extend
(
Object
.
assign
({
mpType
:
'
app
'
},
App
)))
app
.
$mount
()
```
> composition-api.js
```
js
import
Vue
from
'
vue
'
import
VueCompositionAPI
from
'
@vue/composition-api
'
Vue
.
use
(
VueCompositionAPI
)
```
:::
3.
使用 npm/yarn 安装 @dcloudio/uni-app
```
shell
npm
install
@dcloudio/uni-app@alpha
# or
yarn add @dcloudio/uni-app@alpha
```
4.
从 @vue/composition-api 包内导入并使用基础的组合式API,具体的兼容性仍需参考:
[
@vue/composition-api
](
https://github.com/vuejs/composition-api#browser-compatibility
)
。从 @dcloudio/uni-app 包内导入 uni-app 其他生命周期API。
```
js
import
{
defineComponent
,
ref
}
from
'
@vue/composition-api
'
import
{
onReady
}
from
'
@dcloudio/uni-app
'
export
default
defineComponent
({
setup
()
{
const
title
=
ref
(
'
Hello
'
)
onReady
(()
=>
{
console
.
log
(
'
onReady
'
)
})
return
{
title
}
}
})
```
### 使用 Script Setup
1.
使用 npm/yarn 安装 unplugin-vue2-script-setup
```
shell
npm
install
unplugin-vue2-script-setup
-D
# or
yarn add unplugin-vue2-script-setup
-D
```
2.
在 vue.config.js 配置 ScriptSetup 插件,以下为基础配置,其他具体配置请参考
[
unplugin-vue2-script-setup
](
https://github.com/antfu/unplugin-vue2-script-setup
)
```
js
const
ScriptSetup
=
require
(
'
unplugin-vue2-script-setup/webpack
'
).
default
module
.
exports
=
{
parallel
:
false
,
configureWebpack
:
{
plugins
:
[
ScriptSetup
({
/* options */
}),
],
},
chainWebpack
(
config
)
{
// disable type check and let `vue-tsc` handles it
config
.
plugins
.
delete
(
'
fork-ts-checker
'
)
},
}
```
3.
改用 Script Setup 写法导入 API
```
vue
<
script
setup
lang=
"ts"
>
import
{
ref
}
from
'
@vue/composition-api
'
import
{
onReady
}
from
'
@dcloudio/uni-app
'
const
title
=
ref
(
'
Hello
'
)
onReady
(()
=>
{
console
.
log
(
'
onReady
'
)
})
</
script
>
```
### 与 TypesSript 一起使用
*
CLI 项目:创建项目时需选择 TS 模板,与 Script Setup 一同使用时会禁用默认的类型检查,具体请参考
[
unplugin-vue2-script-setup
](
https://github.com/antfu/unplugin-vue2-script-setup
)
*
HBuilderX 项目:使用 TS 时目前不可单独使用 Script Setup,需同时使用 defineComponent。
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录