react-grep
v0.3.3
Published
Hold CMD to see React component names + file:line overlaid on any element
Maintainers
Readme
- Inspect - Hold
Cmd(Mac) /Ctrl(Windows/Linux) and hover over any element to see the React component name and source file location - Toggle source - Tap
Shift(while holding modifier) to switch between the component definition and the call site where it's rendered - Copy -
Cmd+Shift+Clickto copy the active file path and line number to your clipboard
Zero dependencies. Works with any React app in development mode.
Install
# npm
npm install react-grep
# pnpm
pnpm add react-grep
# yarn
yarn add react-grep
# bun
bun add react-grepUsage
ESM import
import "react-grep";That's it. The inspector activates automatically on page load.
If you need manual control:
import { init, destroy } from "react-grep";
init();
destroy();Script tag
<script src="https://unpkg.com/react-grep/dist/index.global.js"></script>The inspector starts automatically when the script loads.
Compatibility
react-grep works with any React app that uses react-dom in development mode. It reads React's internal fiber tree, so no framework-specific plugin is needed.
| Framework / Bundler | Status | | -------------------------------- | ---------------------- | | Vite + React | Tested | | Next.js 16 (Turbopack) | Tested | | Next.js 16 (Webpack) | Tested | | React Router v7 (framework mode) | Tested | | Gatsby | Tested | | esbuild | Tested | | Custom Webpack / Rollup | Untested, should work | | Create React App | Deprecated | | React Native | Not supported (no DOM) |
Next.js has dedicated support for server component names and Turbopack indexed source maps.
Source map resolution is automatic. If your dev server serves source maps (inline or external), react-grep will resolve bundled locations back to original files.
How it works
react-grep reads React's internal fiber tree to find component names and source locations (_debugSource / _debugStack). This data is only available in development builds of React. Production builds strip it out.
When the modifier key is held:
- The hovered DOM element is highlighted with a blue overlay
- A tooltip shows the component name, file path, and call site (if available)
- Tap
Shiftto toggle between the component source and call site. The active source is highlighted, the inactive one is dimmed Cmd+Shift+Clickcopies the activefile:lineto clipboard (without toggling)
API
init()
Start the inspector. Called automatically on import, only needed if you previously called destroy().
destroy()
Stop the inspector and remove all event listeners and DOM elements.
