You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-41Lines changed: 41 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# React Native In-App DevTools
1
+
# BugBubble - React Native In-App DevTools
2
2
3
3
An in-app debugging tool for React Native development. Monitor network requests, WebSocket events, console logs, and analytics events in real-time with a beautiful, draggable UI. Built with TypeScript, zero configuration required, and designed to never crash your app.
4
4
@@ -9,7 +9,7 @@ This library currently supports logging for the following:
9
9
- ✅ **Network Requests**: Automatically intercepts all `fetch()` and `XMLHttpRequest` calls
Add the `RNInAppDevTools` component to your app's root component. **All configuration options are completely optional** - the component works with sensible defaults:
58
+
Add the `BugBubble` component to your app's root component. **All configuration options are completely optional** - the component works with sensible defaults:
- ✅ **WebSocket Events**: All WebSocket connections and events (automatic)
103
-
- ⚠️ **Analytics Events**: Must be explicitly logged using `InAppDevToolsLogger.logAnalytics()` (see below)
103
+
- ⚠️ **Analytics Events**: Must be explicitly logged using `BugBubbleLogger.logAnalytics()` (see below)
104
104
105
105
**Note**: While network, console, and WebSocket logs are automatically intercepted, you can also use explicit logging methods if needed for custom scenarios.
106
106
@@ -115,23 +115,23 @@ A floating button will appear on your screen. **Tap it to open the debugger, or
115
115
-**Network Requests**: Automatically intercepted - no code changes needed
116
116
-**Console Logs**: Automatically intercepted - no code changes needed
117
117
-**WebSocket Events**: Automatically intercepted - no code changes needed
118
-
-**Analytics Events**: **Must be explicitly logged** - use `InAppDevToolsLogger.logAnalytics()`
118
+
-**Analytics Events**: **Must be explicitly logged** - use `BugBubbleLogger.logAnalytics()`
119
119
120
120
While network, console, and WebSocket logs are automatically captured, explicit logging methods are also available for all log types if you need to manually log events in custom scenarios.
121
121
122
122
### Explicit Logging API
123
123
124
-
**Analytics events must be explicitly logged**. For network, console, and WebSocket, explicit logging is optional but available for custom scenarios. Use the `InAppDevToolsLogger` API:
124
+
**Analytics events must be explicitly logged**. For network, console, and WebSocket, explicit logging is optional but available for custom scenarios. Use the `BugBubbleLogger` API:
BugBubbleLogger.logConsole('error', 'Failed to fetch data', error);
173
+
BugBubbleLogger.logConsole('warn', 'Deprecated API used');
174
174
```
175
175
176
176
### Configuration
177
177
178
-
**All configuration options are completely optional**. The library works with sensible defaults out of the box. Configuration is passed as a prop to the `RNInAppDevTools` component:
178
+
**All configuration options are completely optional**. The library works with sensible defaults out of the box. Configuration is passed as a prop to the `BugBubble` component:
@@ -408,24 +408,24 @@ This library is designed to **never crash your app**. All operations are wrapped
408
408
409
409
## Best Practices
410
410
411
-
1.**Minimal Setup Works**: All configuration is optional - you can use `<RNInAppDevTools />` without any config:
411
+
1.**Minimal Setup Works**: All configuration is optional - you can use `<BugBubble />` without any config:
412
412
413
413
```tsx
414
-
{__DEV__&& <RNInAppDevTools />}
414
+
{__DEV__&& <BugBubble />}
415
415
```
416
416
417
-
2.**Analytics Requires Explicit Logging**: Remember that analytics events must be explicitly logged using `InAppDevToolsLogger.logAnalytics()`. Network, console, and WebSocket logs are automatically intercepted.
417
+
2.**Analytics Requires Explicit Logging**: Remember that analytics events must be explicitly logged using `BugBubbleLogger.logAnalytics()`. Network, console, and WebSocket logs are automatically intercepted.
418
418
419
419
3.**Initialize in Development Only**: Only include the debugger in non-production environments:
420
420
421
421
```tsx
422
-
{__DEV__&& <RNInAppDevTools />}
422
+
{__DEV__&& <BugBubble />}
423
423
```
424
424
425
425
4.**Customize Only When Needed**: Only pass config options when you need to override defaults:
426
426
427
427
```tsx
428
-
<RNInAppDevTools
428
+
<BugBubble
429
429
config={{
430
430
maxLogs: 500, // Only if you want to change from default 1000
431
431
trackingOptions: {
@@ -442,7 +442,7 @@ This library is designed to **never crash your app**. All operations are wrapped
442
442
443
443
### Debugger Not Appearing
444
444
445
-
- Ensure you've added `<RNInAppDevTools />` component to your app
445
+
- Ensure you've added `<BugBubble />` component to your app
446
446
- Check that you're not in production mode (consider wrapping with `__DEV__`)
447
447
- Verify that `trackingOptions.enabled` is set to `true` in config (default: true)
Copy file name to clipboardExpand all lines: example/README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Example App
2
2
3
-
This example app demonstrates all the features of `react-native-in-app-devtools` library. It showcases automatic interception of console logs, network requests, and WebSocket events, as well as explicit logging capabilities.
3
+
This example app demonstrates all the features of `@lokal-dev/react-native-bugbubble` library. It showcases automatic interception of console logs, network requests, and WebSocket events, as well as explicit logging capabilities.
4
4
5
5
## Prerequisites
6
6
@@ -60,7 +60,7 @@ When you run the example app, you'll see:
60
60
61
61
1.**Title and Subtitle**: "React Native In-App DevTools" with "Comprehensive Feature Demo"
62
62
63
-
2.**Info Banner**: A blue banner explaining that automatic interception works out of the box, and explicit logging is available via `InAppDevToolsLogger`
63
+
2.**Info Banner**: A blue banner explaining that automatic interception works out of the box, and explicit logging is available via `BugBubbleLogger`
0 commit comments