react-grab README

The project's README from github.com/aidenybai/react-grab. As one markdown file: README.md.

React Grab

version downloads

Copy any UI element for your agent.

React Grab points agents to the actual source behind each selection. Agents are 2× faster and more accurate when using React Grab.

Website →

Quick Start

Run this at your project root:

npx grab@latest init

How It Works

React Grab turns a browser selection into source context your agent can use:

  1. Hover any UI element in your app.
  2. Press ⌘C or Ctrl+C.
  3. Paste the copied context into your agent.

The copied context includes the selected element and its component stack with source locations:

[<a class="ml-auto inline-block text-sm" href="#">Forgot your password?</a> in LoginForm (at components/login-form.tsx:46:19)]

Manual Installation

If you cannot use the CLI, install React Grab manually for your framework:

Next.js (App router)

Add this inside your app/layout.tsx:

import Script from "next/script";

export default function RootLayout({ children }) {
  return (
    <html>
      <head>
        {process.env.NODE_ENV === "development" && (
          <Script
            src="//unpkg.com/react-grab/dist/index.global.js"
            crossOrigin="anonymous"
            strategy="beforeInteractive"
          />
        )}
      </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>
        {process.env.NODE_ENV === "development" && (
          <Script
            src="//unpkg.com/react-grab/dist/index.global.js"
            crossOrigin="anonymous"
            strategy="beforeInteractive"
          />
        )}
      </Head>
      <body>
        <Main />
        <NextScript />
      </body>
    </Html>
  );
}

Vite

Add this at the top of your main entry file (e.g., src/main.tsx):

if (import.meta.env.DEV) {
  import("react-grab");
}

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");
}

Build your own React Grab

Build a custom interface with the selection engine from react-grab/primitives. Use its APIs for hit testing, source context, page freezing, clipboard access, and editor navigation.

Customize hit testing

Scope hit testing to a container or replace the default element filter with your own rules.

import { getElementAtPoint, isElementGrabbable } from "react-grab/primitives";

export const getPickerTarget = (
  event: PointerEvent,
  appElement: Element,
  toolbarElement: Element,
): Element | null =>
  getElementAtPoint(event.clientX, event.clientY, {
    container: appElement,
    filter: (candidate) => isElementGrabbable(candidate) && !toolbarElement.contains(candidate),
  });

Add data-react-grab-ignore to your picker interface so hit testing skips its subtree.

Resources & Contributing Back

Want to try it out? Check out our demo.

Looking to contribute back? Check out the Contributing Guide.

Want to talk to the community? Hop in our Discord and share your ideas and what you've built 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.

Thank you to Andrew Luetgers for donating the grab npm package name.

react-grab (aidenybai/react-grab)

Searching Database…

这是什么?React Grab 让你在运行中的 React 应用里把鼠标悬停在任意界面元素上,按下 Cmd+C 或 Ctrl+C,就能复制该元素精确的源代码位置和组件栈,然后直接粘贴到你的 AI 编程助手中作为上下文。
它是浏览器扩展,还是要添加到代码里的包?它不是浏览器扩展,而是一个小型包,你可以通过命令行工具或手动添加代码片段的方式把它安装到 React 应用中,它会在运行中的开发版本里注入一个选取覆盖层。
我该如何把它添加到项目中?在项目根目录运行安装命令即可自动完成安装;也可以手动添加:在 Next.js App Router 中添加到 app/layout.tsx,在 Pages Router 中添加到 pages/document.tsx,在 Vite 中添加到入口文件顶部,或者在 Webpack 中安装该包后,在入口文件顶部导入。
目前实际支持哪些框架?手动安装说明目前只涵盖 Next.js(App 和 Pages 路由)、Vite 和 Webpack;其他构建配置尚无文档说明,需要使用 primitives API 自行构建自定义选取器。
使用 React Grab 时,AI 代理为什么会更快?README 中说明,使用 React Grab 时 AI 代理的速度快 2 倍,准确度也更高,因为它会直接指向所选界面元素背后的真实源代码,而不是让代理自己去搜索。
我能否让某些界面部分不可被选中?可以,为元素添加 data-react-grab-ignore 属性,React Grab 的命中检测就会跳过该元素及其所有子元素。
安装前能先试用在线演示吗?可以,README 中有一个官方演示链接,无需在你自己的项目中安装任何内容即可试用。
What are similar projects?vConsole, bolt.new, inspector, qiankun, linaria, react-scan, bb, eruda
Creator
aidenybai
Size
87.8 MB
Stars
7.7K
Age
1y
Commits · 90 Days