Skip to content

Commit 91f627c

Browse files
committed
Add grayscale icons and update extension icon based on TanStack Query detection
1 parent d78521c commit 91f627c

10 files changed

Lines changed: 168 additions & 417 deletions

File tree

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# TanStack Query Chrome DevTools
1+
# TanStack Query DevTools
22

3-
A professional Chrome DevTools extension for debugging TanStack Query applications across all frameworks.
3+
A professional browser extension for debugging TanStack Query applications across all frameworks.
44

55
[![Chrome Web Store](https://img.shields.io/badge/Chrome%20Web%20Store-Available-blue?style=flat-square&logo=google-chrome)](https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai)
6+
[![Firefox Add-ons](https://img.shields.io/badge/Firefox%20Add--ons-Available-orange?style=flat-square&logo=firefox)](https://addons.mozilla.org/en-US/firefox/addon/tanstack-query-devtools/)
7+
[![Edge Add-ons](https://img.shields.io/badge/Edge%20Add--ons-Available-blue?style=flat-square&logo=microsoft-edge)](https://microsoftedge.microsoft.com/addons/detail/tanstack-query-devtools/edmdpkgkacmjopodhfolmphdenmddobj)
68

79
## ✨ Features
810

@@ -18,25 +20,32 @@ A professional Chrome DevTools extension for debugging TanStack Query applicatio
1820

1921
## Quick Start
2022

21-
1. **Install** the extension from [Chrome Web Store](https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai)
22-
2. **Setup your application** to expose the query client globally:
23-
24-
```typescript
25-
// Add this line where you create your query client
26-
window.__TANSTACK_QUERY_CLIENT__ = queryClient;
27-
```
23+
1. **Install** the extension from your browser's extension store:
24+
- [Chrome Web Store](https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai)
25+
- [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/tanstack-query-devtools/)
26+
- [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/tanstack-query-devtools/edmdpkgkacmjopodhfolmphdenmddobj)
2827

29-
3. **For TypeScript projects**, create a `global.d.ts` file in your project root:
28+
2. **Setup your application** to expose the query client globally:
3029

3130
```typescript
32-
interface Window {
33-
__TANSTACK_QUERY_CLIENT__: import("@tanstack/query-core").QueryClient;
31+
const queryClient = new QueryClient({
32+
/* ... */
33+
});
34+
35+
// This code is only for TypeScript
36+
declare global {
37+
interface Window {
38+
__TANSTACK_QUERY_CLIENT__: import("@tanstack/query-core").QueryClient;
39+
}
3440
}
41+
42+
// This code is for all users
43+
window.__TANSTACK_QUERY_CLIENT__ = queryClient;
3544
```
3645

37-
4. **Open** Chrome DevTools (F12) in your application
38-
5. **Navigate** to the "TanStack Query" tab
39-
6. **Start debugging** with real-time query inspection!
46+
3. **Open** browser DevTools (F12) in your application
47+
4. **Navigate** to the "TanStack Query" tab
48+
5. **Start debugging** with real-time query inspection!
4049

4150
## 🏗️ Technical Architecture
4251

@@ -48,7 +57,7 @@ Web Application (TanStack Query)
4857
Injected Script (Application Context)
4958
↓ Message Passing
5059
Content Script (Bridge)
51-
Chrome APIs
60+
Browser APIs
5261
Background Service Worker
5362
↓ DevTools Connection
5463
React DevTools Panel
@@ -65,15 +74,21 @@ npm install
6574
# Build extension
6675
npm run build
6776

68-
# Load extension in Chrome
69-
# 1. Open chrome://extensions/
70-
# 2. Enable "Developer mode"
71-
# 3. Click "Load unpacked"
72-
# 4. Select the `dist` folder
77+
# Load extension in your browser
78+
# Chrome: chrome://extensions/ → Enable "Developer mode" → "Load unpacked" → Select `dist` folder
79+
# Firefox: about:debugging → "This Firefox" → "Load Temporary Add-on" → Select `dist/manifest.json`
80+
# Edge: edge://extensions/ → Enable "Developer mode" → "Load unpacked" → Select `dist` folder
7381
```
7482

7583
## 🔗 Links
7684

85+
### Extension Stores
86+
7787
- [Chrome Web Store](https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai)
88+
- [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/tanstack-query-devtools/)
89+
- [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/tanstack-query-devtools/edmdpkgkacmjopodhfolmphdenmddobj)
90+
91+
### Documentation
92+
7893
- [TanStack Query Documentation](https://tanstack.com/query)
79-
- [Chrome Extension Development](https://developer.chrome.com/docs/extensions/)
94+
- [Browser Extension Development](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions)

memory-bank

0 commit comments

Comments
 (0)