-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
56 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Nuxt DevTools <sup>Alpha Preview</sup> | ||
|
||
Tools to enhance your development experience with Nuxt. Transparent, infomative, extensible and joyful. | ||
|
||
> **Note**: Experimental and under heavy development. APIs are subject to change. | ||
## Installation | ||
|
||
Nuxt DevTools is currently only available in edge versions (releases on every commit to `main`). | ||
|
||
Requires Nuxt 3.1.0 or higher. | ||
|
||
```bash | ||
npm i -D @nuxt/devtools-edge | ||
``` | ||
|
||
```ts | ||
// nuxt.config.ts | ||
export default defineNuxtConfig({ | ||
modules: [ | ||
'@nuxt/devtools-edge', | ||
], | ||
}) | ||
``` | ||
|
||
Then open your app in browser. Click the Nuxt icon on the bottom to open the DevTools. | ||
|
||
## Module Authors | ||
|
||
Nuxt DevTools is designed to be extensible. You can add your own modules's integration to the DevTools. | ||
|
||
> **Warning**: API and subject to change. | ||
### Contributing to View | ||
|
||
Currently the only way to contribute to Nuxt DevTools View is via iframe. You need to serve your module's view yourself and then register it to the DevTools. | ||
|
||
```ts | ||
nuxt.hook('devtools:customTabs', (tabs) => { | ||
tabs.push({ | ||
name: 'my-module', | ||
title: 'My Module', | ||
icon: 'carbon:apps', // any icon name from Iconify | ||
view: { | ||
type: 'iframe', | ||
src: '/url-to-your-module-view', | ||
}, | ||
}) | ||
}) | ||
``` | ||
|
||
## License | ||
|
||
[MIT](./LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters