Skip to content

Latest commit

 

History

History
108 lines (90 loc) · 2.89 KB

README.zh-CN.md

File metadata and controls

108 lines (90 loc) · 2.89 KB

vue-cli-plugin-eruda

npm npm

A Vue CLI 3+ plugin of eruda.

English

安装

使用一下命令安装插件,Vue CLI,

npm install --save-dev vue-cli-plugin-eruda

# 如果你全局安装了Vue CLI
vue add erudu

全局变量

启用插件后,会提供一个全局变量用于调用eruda的API.

var eruda = require("eruda");
window.eruda === undefined && (window.eruda = eruda);

插件选项

// vue.config.js
module.exports = {
  // ... your configs 

  pluginOptions: {
    eruda: {
      // options
    }
  }
}
Options key Type Description
enable boolean 默认情况下,当NODE_ENV !== 'production'时开启插件. 你可以传true或者false去强制开启/关闭。
exclude regexp | regexp[] 用于排除你不需要注入eruda插件的入口文件(entry)。多页时使用(使用`vue.config.js`的`pages`选项定制)
plugins string[] 开启eruda插件。你可以传递完整包名['eruda-fps'] 或者简写['fps']。
container element 用于插件初始化的 Dom 元素,如果不设置,默认创建 div 作为容器直接置于 html 根结点下面。
tool string[] | string 指定要初始化哪些面板,默认加载所有。
autoScale=true boolean 自动缩放eruda以适应不同的viewport
useShadowDom=true boolean 使用shadowdom封装css
defaults object 默认配置项

可用的 defaults 选项:

Name Type Desc
transparency number Transparency, 0 to 1
displaySize number Display size, 0 to 100
theme string Theme, defaults to Light or Dark in dark mode

container, tool, autoScale, useShadowDom, defaults是eruda默认配置项,你可以在这里查看更多信息 。

License

MIT