Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@rn-devtools/react-query-plugin

A React Query tab for rn-devtools. Mirrors your app’s TanStack Query state in the devtools UI and lets you refetch/invalidate/reset/remove queries, edit data, toggle online/offline, and simulate loading/error.

Installation

To install the plugin, ensure the version of @tanstack/react-query-devtools matches your @tanstack/react-query version.

npm install @rn-devtools/react-query-plugin 
npm install --save-dev @tanstack/react-query-devtools
# or
yarn add @rn-devtools/react-query-plugin 
yarn add -D @tanstack/react-query-devtools

Usage

  1. Native (in your app)

Hook the plugin into your QueryClient and rn-devtools connection.

// App.tsx
import React from "react";
import { Platform } from "react-native"
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { useReactQueryDevtools } from "@rn-devtools/react-query-plugin/native";
import { useReactNativeDevtools } from "@rn-devtools/plugin-sdk";

const client = new QueryClient();

export default function App() {
  useReactNativeDevtools({
    socketURL: "http://10.0.2.2:35515",
    deviceName: Platform.OS || "web",
    platform: Platform.OS || "web",
    deviceId: Platform.OS || "web",
    extraDeviceInfo: { appVersion: "1.0.0" },
    plugins: ({ socket, deviceId }) => {
      useReactQueryDevtools({ queryClient: client, socket, deviceId });
    },
  });

  return (
    <QueryClientProvider client={qc}>
      {/* your app */}
    </QueryClientProvider>
  );
}
  1. Web (devtools UI)

Add the plugin to your rn-devtools config so it appears as a tab.

// rn-devtools.config.js

export default {
  plugins: ["@rn-devtools/react-query-plugin"],
};