vConsole README

The project's README from github.com/Tencent/vConsole. As one markdown file: README.md.

English | 简体中文

vConsole

A lightweight, extendable front-end developer tool for mobile web page.

vConsole is framework-free, you can use it in Vue or React or any other framework application.

Now vConsole is the official debugging tool for WeChat Miniprograms.


Features

For details, please see the screenshots below.


Release Notes

Latest version: npm version

Detailed release notes for each version are available on Changelog.


Guide

See Tutorial for more usage details.

For installation, there are 2 primary ways of adding vConsole to a project:

$ npm install vconsole
import VConsole from 'vconsole';

const vConsole = new VConsole();
// or init with options
const vConsole = new VConsole({ theme: 'dark' });

// call `console` methods as usual
console.log('Hello world');

// remove it when you finish debugging
vConsole.destroy();

Method 2: Using CDN in HTML:

<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
<script>
  // VConsole will be exported to `window.VConsole` by default.
  var vConsole = new window.VConsole();
</script>

Available CDN:


Preview

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


Screenshots

Overview

Light theme

Dark theme

Log Panel

Log styling

Command line

System Panel

Performance info

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

Network Panel

Request details

Element Panel

Realtime HTML elements structure

Storage Panel

Add, edit, delete or copy Cookies / LocalStorage / SessionStorage


Documentation

vConsole:

Custom Plugin:


Third-party Plugins


Feedback

QQ Group: 497430533


License

The MIT License

vConsole (Tencent/vConsole)

Searching Database…

17.5K ·GitHub
Что это такое?Лёгкий расширяемый инструмент для фронтенд-разработчиков, чтобы отлаживать мобильные веб-страницы: консоль прямо на странице, которая показывает логи, сетевые запросы, элементы и хранилище прямо на телефоне.
Это расширение для браузера или код, который я добавляю на свою страницу?Код, который вы добавляете в свой проект, а не расширение: он не привязан к фреймворкам, работает во Vue, React или любом другом фреймворке и отрисовывает свою консоль прямо на странице.
Как добавить его в проект?Два способа: npm install vconsole (рекомендуется) и импортировать его, либо подключить CDN-скрипт через тег в HTML.
Нужно ли что-то особенное установить, чтобы пользоваться им?Ничего особенного: это обычный npm-пакет с небольшими рантайм-зависимостями (core-js, @babel/runtime, copy-text-to-clipboard), и не нужно запускать никакой сервер.
Он полезен только на мобильных или на компьютере тоже?Он рассчитан на мобильные веб-страницы, где полноценные devtools недоступны; будучи обычным скриптом, загружаемым вместе со страницей, он работает везде, где работает эта страница.
Он работает в WeChat Miniprograms или только на обычных мобильных страницах?И там, и там: теперь это официальное средство отладки для WeChat Miniprograms, а в репозитории рядом с обычной веб-сборкой есть отдельная сборка wx.
Можно пользоваться бесплатно, в том числе в коммерческих проектах?Да — он выпущен под лицензией MIT, так что его можно бесплатно использовать и встраивать в любой проект, включая коммерческий.
Что именно я могу с его помощью посмотреть?Логи консоли (log, info, error и другие), сетевые запросы из XMLHttpRequest, Fetch и sendBeacon, дерево HTML-элементов в реальном времени, сведения о системе и производительности, а также командную строку, чтобы вручную выполнять JS.
Можно ли редактировать значения в хранилище прямо из панели?Да — в панели Storage можно добавлять, изменять, удалять или копировать записи Cookies, LocalStorage и SessionStorage.
Могу ли я добавить свои панели или функции?Да, поддерживаются собственные плагины, и в документации описано, как написать свой; сообщество поддерживает дополнительные плагины вроде vconsole-webpack-plugin, vite-plugin-vconsole и плагина для vue-devtools.
Есть ли тёмная тема?Да — на обзорных скриншотах показаны и светлая, и тёмная темы.
Creator
Tencent
Size
5.1 MB
Stars
17.5K
Age
10y
Commits · 90 Days