wehub-resource-sync
55 lines
1.1 KiB
Markdown
55 lines
1.1 KiB
Markdown
# Vite Guide
|
|
|
|
## As a script tag
|
|
|
|
Add the script tag to your `index.html`.
|
|
|
|
Refer to the [CDN Guide](https://github.com/aidenybai/react-scan/blob/main/docs/installation/cdn.md) for the available URLs.
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<script src="https://unpkg.com/react-scan/dist/auto.global.js"></script>
|
|
|
|
<!-- rest of your scripts go under -->
|
|
</head>
|
|
<body>
|
|
<!-- ... -->
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
## As a module import
|
|
|
|
In your project entrypoint (e.g. `src/index`, `src/main`):
|
|
|
|
```jsx
|
|
// src/index
|
|
import { scan } from "react-scan"; // must be imported before React and React DOM
|
|
import React from "react";
|
|
|
|
scan({
|
|
enabled: true,
|
|
});
|
|
```
|
|
|
|
If you want react-scan to also run in production, use the react-scan/all-environments import path
|
|
|
|
```diff
|
|
- import { scan } from "react-scan";
|
|
+ import { scan } from "react-scan/all-environments";
|
|
```
|
|
|
|
|
|
> [!CAUTION]
|
|
> React Scan must be imported before React (and other React renderers like React DOM) in your entire project, as it needs to hijack React DevTools before React gets to access it.
|
|
|
|
## Vite plugin
|
|
|
|
TODO
|
|
|
|
## Preserving component names
|
|
|
|
TODO
|