README_CN.md

English | 简体中文

vConsole

一个轻量、可拓展、针对手机网页的前端开发者调试面板。

vConsole 是框架无关的，可以在 Vue、React 或其他任何框架中使用。

现在 vConsole 是微信小程序的官方调试工具。

---

功能特性

• 日志(Logs)： console.log|info|error|...
• 网络(Network)： XMLHttpRequest, Fetch, sendBeacon
• 节点(Element)： HTML 节点树
• 存储(Storage)： Cookies, LocalStorage, SessionStorage
• 手动执行 JS 命令行
• 自定义插件

详情可参考下方的截图。

---

版本说明

最新版本：

每个版本的详细说明请参阅 Changelog。

---

上手

详细使用方法请参阅使用教程。

将 vConsole 添加到项目中主要有以下方式：

方法一：使用 npm（推荐）

$ npm install vconsole

Import 并初始化后，即可使用 console.log 功能，如 Chrome devtools 上一样。

import VConsole from 'vconsole';

const vConsole = new VConsole();
// 或者使用配置参数来初始化，详情见文档
const vConsole = new VConsole({ theme: 'dark' });

// 接下来即可照常使用 `console` 等方法
console.log('Hello world');

// 结束调试后，可移除掉
vConsole.destroy();

方法二：使用 CDN 直接插入到 HTML

<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
<script>
  // VConsole 默认会挂载到 `window.VConsole` 上
  var vConsole = new window.VConsole();
</script>

可用的 CDN：

• https://unpkg.com/vconsole@latest/dist/vconsole.min.js
• https://cdn.jsdelivr.net/npm/vconsole@latest/dist/vconsole.min.js

---

手机预览

http://wechatfe.github.io/vconsole/demo.html

---

截图

概览

浅色主题

深色主题

Log 面板

Log 样式

命令行

System 面板

Performance 信息

输入日志到不同的 log 面板

console.log('output to Log panel.')
console.log('[system]', 'output to System panel.')

Network 面板

请求、回包的详情

Element 面板

查看 HTML 对象结构

Storage 面板

添加、编辑、删除、复制 Cookies / LocalStorage / SessionStorage

---

文档

vConsole 本体：

• 使用教程
• 公共属性及方法
• 内置插件：属性及方法

自定义插件：

• 插件：入门
• 插件：编写插件
• 插件：Event 事件列表

---

第三方插件列表

• vConsole-sources
• vconsole-webpack-plugin
• vconsole-stats-plugin
• vconsole-vue-devtools-plugin
• vconsole-outputlog-plugin
• vite-plugin-vconsole

---

交流反馈

QQ 群：497430533

---

License

The MIT License