@buoy-gg/highlight-updates
v7.0.40
Published
Highlight observed React Native renders and inspect available render diagnostics.
Maintainers
Readme
@buoy-gg/highlight-updates
Highlight observed React component updates in development builds and inspect the available render details.
Part of Buoy. Install the package, complete account setup, and follow the integration steps below.
Install
npm install @buoy-gg/core @buoy-gg/highlight-updatesBefore you start
Use a development build with @buoy-gg/core and a Free or Pro Buoy account key. From your app’s directory, sign in:
npx --package=@buoy-gg/core buoy loginFor Expo, initialize Buoy before rendering the menu:
import { Buoy } from "@buoy-gg/core";
Buoy.init({ licenseKey: process.env.EXPO_PUBLIC_BUOY_KEY });The login command writes the Expo key to .env.local. For React Native CLI, pass the key from your app’s environment configuration; React Native does not load .env.local automatically. Mount FloatingDevTools inside the same providers as your screens and restart the development server after installation. The Quick Start shows the complete root component setup.
Quick start
import { FloatingDevTools } from "@buoy-gg/core";
export default function App() {
return (
<>
<YourApp />
<FloatingDevTools />
</>
);
}That's it — the Render Highlighter appears in the floating menu. It's a standalone implementation: no React DevTools connection, no Chrome tab, no Flipper required.
Prefer to drive it yourself?
import { HighlightUpdatesController } from "@buoy-gg/highlight-updates";
HighlightUpdatesController.toggle();Check the integration
In a development build, open the tool and update a visible component’s state. Confirm that an update is highlighted. Capture depends on React’s development hooks; Pro does not make those hooks available in a release build.
What you get
- Render overlays with the cause — observed updates flash a bounding box with the available mount, state, props, or parent-update classification.
- Hook value tracking — when state caused the render, see the before → after values of the exact
useStateoruseReducerthat changed. - Overlay mode — lightweight real-time highlights while you interact with the app; perfect for spotting unnecessary re-renders.
- Modal mode — full inspector with render history, filtering, and detailed per-render cause breakdowns for deep debugging sessions.
- Powers Bench's render capture — with
@buoy-gg/perf-monitorinstalled, benchmark recordings capture per-component render counts and durations. - Filters out the framework noise — you see your components, not
View/Textinternals.
Desktop & AI
To connect a React Native app to Buoy Desktop or MCP, install @buoy-gg/external-sync and follow the Desktop connection guide. Sign in to Desktop separately. MCP setup also requires a process account and Pro access. Available remote actions depend on the tool and app integration.
Account and plan requirements
Use a Free or Pro Buoy account. History limits and paid features vary by tool; see pricing. Production access requires Pro where supported. Development-only hooks and actions remain unavailable in release builds.
Proprietary software. © Buoy LLC. Terms
