diff --git a/packages/core/README.md b/packages/core/README.md index bbd5135..c4f3d6d 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,12 +1,12 @@

-vite-plugin-reactjs-inspector +vite-plugin-reactjs-inspector

NPM Version NPM Downloads - License + License

@@ -15,24 +15,12 @@ ## 📖 Introduction -A vite plugin which provides the ability that to jump to the local IDE when you click the element of browser automatically. It supports Vue2 & 3 & SSR. - -

-vite-plugin-reactjs-inspector -

+A vite plugin which provides the ability that to jump to the local IDE when you click the element of browser automatically. ## 📦 Installation ```bash - -# vite-plugin-reactjs-inspector - -pnpm install vite-plugin-reactjs-inspector -D - -# unplugin-vue-inspector - -pnpm install unplugin-vue-inspector -D - +npm install vite-plugin-reactjs-inspector -D ``` ## 🦄 Usage @@ -49,53 +37,3 @@ export default defineConfig({ plugins: [react(), VitePluginReactInspector()], }) ``` -### Options - - -```ts -interface VitePluginInspectorOptions { - /** - * Default enable state - * @default false - */ - enabled?: boolean - - /** - * Define a combo key to toggle inspector - * @default 'control-shift' on windows, 'meta-shift' on other os - * - * any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by - - * examples: control-shift, control-o, control-alt-s meta-x control-meta - * Some keys have native behavior (e.g. alt-s opens history menu on firefox). - * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended. - * You can also disable it by setting `false`. - */ - toggleComboKey?: string | false - - /** - * Toggle button visibility - * @default 'active' - */ - toggleButtonVisibility?: 'always' | 'active' | 'never' - - /** - * Toggle button display position - * @default top-right - */ - toggleButtonPos?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' - - /** - * append an import to the module id ending with `appendTo` instead of adding a script into body - * useful for frameworks that do not support trannsformIndexHtml hook (e.g. Nuxt3) - * - * WARNING: only set this if you know exactly what it does. - */ - appendTo?: string | RegExp - - /** - * Customize openInEditor host (e.g. http://localhost:3000) - * @default false - */ - openInEditorHost?: string | false -} -```