Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dull-sloths-bow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@solid-devtools/overlay": patch
---

Fixed README.md to update process for enabling babel plugin at overlay.
10 changes: 5 additions & 5 deletions packages/overlay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ attachDevtoolsOverlay({

Don't worry about wrapping it with a `isDev` guard, the Overlay takes care of that for you. It should be excluded from production builds automatically.

### Enabling the Babel plugin
### Enabling the autoname

Enabling the [babel plugin](https://github.com/thetarnav/solid-devtools/tree/main/packages/transform#readme) is optional, but can offer some extra improvements.
Enabling the autoname setting is optional, but can display name of SolidJS's reactive state in overlay.

To enable it you need to add it to plugins array in your `.vite.config.ts` file:

Expand All @@ -62,19 +62,19 @@ To enable it you need to add it to plugins array in your `.vite.config.ts` file:

import { defineConfig } from 'vite'
import solid from 'vite-plugin-solid'
import devtools from '@solid-devtools/transform'
import devtools from 'solid-devtools/vite'

export default defineConfig({
plugins: [
devtools({
name: true,
autoname: true,
}),
solid(),
],
})
```

[**See transform options**](https://github.com/thetarnav/solid-devtools/tree/main/packages/transform#options)
[**See vite plugin**](https://github.com/thetarnav/solid-devtools/blob/main/packages/main/src/vite/vite.ts)

## Changelog

Expand Down