uni-vue-devtools.md

## uni-vue-devtools

`uni-vue-devtools` 是基于 [vue-devtools](https://devtools.vuejs.org/) 开发的 `uni-app` 项目调试工具。

相当于 chrome 的 devtools，它提供了2个特色功能：
- 可以方便的查看 data、修改 data 并在页面上实时查看效果
- 可以审查自定义的 vue 组件

**平台差异说明**

|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|√|√|√|√|√|√|√|√|

**注意事项：**

- `uni-vue-devtools` 只能审查自定义的 vue 组件，不能审查内置基础组件。
- 目前仅支持 `HBuilderX 3.7.0` 及 `cli 3.0.0-alpha-3070020230114001+` 创建的 `Vue3` 项目。
- App、小程序端暂不支持 `script setup` 语法糖。

### 使用方法

#### HBuilderX

HBuilderX 运行菜单下针对每个运行平台有一个 `运行时自动打开 Vue Devtools` 按钮，\
![](https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/ad6b4788-9a66-48ef-a211-e34754fd0917.png)\
勾选后，运行到对应平台时会自动开启 Vue Devtools。服务启动后，会自动打开一个弹窗，并显示待连接状态\
  ![](
https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/424b3030-b67d-4e74-a7c2-abf0cd7b1d2a.png)

对应平台项目运行后会与该弹窗建立连接。
![](
https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/2344dba2-7522-4a4c-bf46-c2bf806a31fc.png)

如果您不需要默认开启 Vue Devtools，但是开发过程中临时需要 Devtools 调试，可点击控制台右上角 Vue 图标按钮，

![](
https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/6168453a-e15c-4c4d-8846-6026debce5de.png)

此时会以 Devtools 模式重启开发服务。

**Tips:**

* 如果调试弹窗已打开且未置于前台，可通过点击控制台 vue 图标将 Devtools 弹窗激活到前台。

#### CLI

##### 1. 安装

  ```shell
  npm install @dcloudio/uni-vue-devtools --save-dev
  ```

##### 2. 运行项目

  ```shell
  npm run dev:%PLATFORM% --devtools
  ```

  服务启动后，会自动在默认浏览器打开一个页面，并显示待连接状态\
  ![](https://web-assets.dcloud.net.cn/unidoc/zh/uni-vue-devtools-waiting-connect.png)

  对应平台项目运行后会与该页面建立连接\
  ![](https://web-assets.dcloud.net.cn/unidoc/zh/uni-vue-devtools-connected.png)