Skip to content

gt12889/react-grab

 
 

Repository files navigation

React Grab

size version downloads

React Grab allows you to select an element and copy its context (like HTML, React component, and file source)

It makes tools like Cursor, Claude Code, Copilot run up to 55% faster

Demo

Install

Install using Cursor

Get started in 1 minute by adding this script tag to your app:

<script src="//unpkg.com/react-grab/dist/index.global.js" crossorigin="anonymous" data-enabled="true" ></script>

If you're using a React framework or build tool, view instructions below:

Next.js (App router)

Add this inside of your app/layout.tsx:

import Script from "next/script"; export default function RootLayout({ children }) { return ( <html> <head> {/* put this in the <head> */} {process.env.NODE_ENV === "development" && ( <Script src="//unpkg.com/react-grab/dist/index.global.js" crossOrigin="anonymous" strategy="beforeInteractive" data-enabled="true" /> )} {/* rest of your scripts go under */} </head> <body>{children}</body> </html> ); }

Next.js (Pages router)

Add this into your pages/_document.tsx:

import { Html, Head, Main, NextScript } from "next/document"; export default function Document() { return ( <Html lang="en"> <Head> {/* put this in the <Head> */} {process.env.NODE_ENV === "development" && ( <Script src="//unpkg.com/react-grab/dist/index.global.js" crossOrigin="anonymous" strategy="beforeInteractive" data-enabled="true" /> )} {/* rest of your scripts go under */} </Head> <body> <Main /> <NextScript /> </body> </Html> ); }

Vite

Your index.html could look like this:

<!doctype html> <html lang="en"> <head> <script type="module"> // first npm i react-grab // then in head: if (import.meta.env.DEV) { import("react-grab"); } </script> </head> <body> <div id="root"></div> <script type="module" src="/src/main.tsx"></script> </body> </html>

Webpack

First, install React Grab:

npm install react-grab

Then add this at the top of your main entry file (e.g., src/index.tsx or src/main.tsx):

if (process.env.NODE_ENV === "development") { import("react-grab"); }

Extending React Grab

React Grab provides an public customization API. Check out the type definitions to see all available options for extending React Grab.

import { init } from "react-grab/core"; const api = init({ theme: { enabled: true, // disable all UI by setting to false hue: 180, // shift colors by 180 degrees (pink → cyan/turquoise) crosshair: { enabled: false, // disable crosshair }, elementLabel: { // when hovering over an element backgroundColor: "#000000", textColor: "#ffffff", }, }, onElementSelect: (element) => { console.log("Selected:", element); }, onCopySuccess: (elements, content) => { console.log("Copied to clipboard:", content); }, onStateChange: (state) => { console.log("Active:", state.isActive); }, }); api.activate(); api.copyElement(document.querySelector(".my-element")); console.log(api.getState());

Resources & Contributing Back

Want to try it out? Check the our demo.

Looking to contribute back? Check the Contributing Guide out.

Want to talk to the community? Hop in our Discord and share your ideas and what you've build with React Grab.

Find a bug? Head over to our issue tracker and we'll do our best to help. We love pull requests, too!

We expect all contributors to abide by the terms of our Code of Conduct.

→ Start contributing on GitHub

License

React Grab is MIT-licensed open-source software.

About

Grab any element on in your app and give it to Cursor, Claude Code, etc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 94.0%
  • HTML 3.9%
  • CSS 1.6%
  • Other 0.5%