|
1 | | - |
| 1 | +<div align="center"> |
| 2 | + <img src="./media/header_devtools.png" > |
| 3 | +</div> |
2 | 4 |
|
3 | | -# [TanStack](https://tanstack.com) Devtools v0 |
| 5 | +<br /> |
4 | 6 |
|
5 | | -Coming soon... |
6 | | - |
7 | | -<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent"> |
8 | | - <img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack" /> |
9 | | -</a> |
10 | | -<!-- <a href="https://github.com/tanstack/devtools/actions?devtools=workflow%3A%22react-devtools+tests%22"> |
11 | | - <img src="https://github.com/tanstack/devtools/workflows/react-devtools%20tests/badge.svg" /> |
12 | | -</a> --> |
| 7 | +<div align="center"> |
13 | 8 | <a href="https://npmjs.com/package/@tanstack/devtools" target="\_parent"> |
14 | 9 | <img alt="" src="https://img.shields.io/npm/dm/@tanstack/react-devtools.svg" /> |
15 | 10 | </a> |
| 11 | +<a href="https://github.com/TanStack/devtools" target="\_parent"> |
| 12 | + <img alt="" src="https://img.shields.io/github/stars/TanStack/devtools.svg?style=social&label=Star" alt="GitHub stars" /> |
| 13 | +</a> |
16 | 14 | <a href="https://bundlephobia.com/result?p=@tanstack/react-devtools@latest" target="\_parent"> |
17 | 15 | <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-devtools@latest" /> |
18 | 16 | </a> |
| 17 | +</div> |
| 18 | + |
| 19 | +<div align="center"> |
19 | 20 | <a href="#badge"> |
20 | 21 | <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"> |
21 | 22 | </a> |
22 | | -<a href="https://github.com/tanstack/devtools/discussions"> |
23 | | - <img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" /> |
| 23 | + <a href="#badge"> |
| 24 | + <img src="https://img.shields.io/github/v/release/tanstack/devtools" alt="Release"/> |
| 25 | + </a> |
| 26 | +<a href="https://twitter.com/tan_stack"> |
| 27 | + <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/> |
24 | 28 | </a> |
25 | | -<a href="https://github.com/tanstack/devtools" target="\_parent"> |
26 | | - <img alt="" src="https://img.shields.io/github/stars/tanstack/react-devtools.svg?style=social&label=Star" /> |
27 | | -</a> |
28 | | -<a href="https://twitter.com/tannerlinsley" target="\_parent"> |
29 | | - <img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" /> |
30 | | -</a> |
31 | | - |
32 | | -## Enjoy this library? |
33 | | - |
34 | | -Try other [TanStack](https://tanstack.com) libraries: |
35 | | - |
36 | | -- [TanStack Router](https://github.com/TanStack/router) <img alt="" src="https://img.shields.io/github/stars/tanstack/router.svg" /> |
37 | | -- [TanStack Query](https://github.com/TanStack/query) <img alt="" src="https://img.shields.io/github/stars/tanstack/query.svg" /> |
38 | | -- [TanSack Table](https://github.com/TanStack/table) <img alt="" src="https://img.shields.io/github/stars/tanstack/table.svg" /> |
39 | | -- [TanStack Virtual](https://github.com/TanStack/virtual) <img alt="" src="https://img.shields.io/github/stars/tanstack/virtual.svg" /> |
40 | | -- [TanStack Form](https://github.com/TanStack/form) <img alt="" src="https://img.shields.io/github/stars/tanstack/form.svg" /> |
41 | | -- [TanStack Store](https://github.com/TanStack/store) <img alt="" src="https://img.shields.io/github/stars/tanstack/store.svg" /> |
42 | | -- [TanStack Ranger](https://github.com/TanStack/ranger) <img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg" /> |
43 | | -- [TanStack Pacer](https://github.com/TanStack/pacer) <img alt="" src="https://img.shields.io/github/stars/tanstack/pacer.svg" /> |
44 | | -- [TanStack Devtools](https://github.com/TanStack/devtools) <img alt="" src="https://img.shields.io/github/stars/tanstack/devtools.svg" /> |
45 | | -- [TanStack Config](https://github.com/TanStack/config) <img alt="" src="https://img.shields.io/github/stars/tanstack/config.svg" /> |
46 | | - |
47 | | -## Visit [tanstack.com/devtools](https://tanstack.com/devtools) for docs, guides, API and more! |
48 | | - |
49 | | -You may know **TanSack Devtools** by our adapter names, too! |
50 | | - |
51 | | -- [**React Devtools**](https://tanstack.com/devtools/latest/docs/framework/react/basic-setup) |
52 | | -- [**Solid Devtools**](https://tanstack.com/devtools/latest/docs/framework/solid/basic-setup) |
53 | | - |
54 | | -## Summary |
55 | | - |
56 | | -TanStack Devtools is a powerful set of tools designed to help developers inspect and debug applications built with various frameworks, including React, Solid, and Vanilla JS. It provides a unified interface to monitor application state, track changes, and identify issues in real-time. |
57 | | - |
58 | | -It is built with a plugin architecture, allowing for easy extension and customization. The devtools vite plugin can be integrated into your application, which enhances the development experience by providing better console logs, a server event bus, and improved debugging capabilities. |
59 | | - |
60 | | -## Quick Features |
61 | | - |
62 | | -- Inspect and debug your application's state and behavior in real-time |
63 | | -- Support for multiple frameworks (React, Solid, Vanilla JS, etc.) |
64 | | -- Plugin architecture to extend functionality |
65 | | -- Production mode support with tree-shaking to remove devtools code |
66 | | -- Customizable UI |
67 | | -- Event bus for communication between the devtools and your application |
68 | | -- Go-to-source functionality for easy debugging |
69 | | -- Works seamlessly with TanStack Query, Router, and other TanStack libraries |
70 | | - |
71 | | -## Installation |
72 | | - |
73 | | -Install one of the following packages based on your framework of choice: |
74 | | - |
75 | | -```bash |
76 | | -# Npm |
77 | | -npm install @tanstack/react-devtools |
78 | | -npm install @tanstack/solid-devtools |
79 | | -npm install @tanstack/devtools # no framework, just vanilla js |
80 | | -``` |
81 | | - |
82 | | -## Usage |
83 | | - |
84 | | -### React |
85 | | - |
86 | | -```tsx |
87 | | -import { TanStackDevtools } from '@tanstack/react-devtools' |
88 | | -import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools' |
89 | | -import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools' |
90 | | - |
91 | | -function App() { |
92 | | - return ( |
93 | | - <div> |
94 | | - <h1>My App</h1> |
95 | | - <TanStackDevtools |
96 | | - plugins={[ |
97 | | - { |
98 | | - name: 'TanStack Query', |
99 | | - render: <ReactQueryDevtoolsPanel />, |
100 | | - }, |
101 | | - { |
102 | | - name: 'TanStack Router', |
103 | | - render: <TanStackRouterDevtoolsPanel router={router} />, |
104 | | - }, |
105 | | - ]} |
106 | | - /> |
107 | | - </div> |
108 | | - ) |
109 | | -} |
110 | | -``` |
111 | | - |
112 | | -## Development |
113 | | - |
114 | | -To contribute to the development of TanStack Devtools, you can clone the repository and run the following commands: |
115 | | - |
116 | | -```bash |
117 | | -pnpm install |
118 | | -pnpm dev |
119 | | -``` |
120 | | - |
121 | | -Then go to any of the example directories and run: |
122 | | - |
123 | | -```bash |
124 | | -pnpm dev |
125 | | -``` |
126 | | - |
127 | | -## How to help? |
128 | | - |
129 | | -### [Become a Sponsor](https://github.com/sponsors/tannerlinsley/) |
| 29 | +</div> |
| 30 | + |
| 31 | +<div align="center"> |
| 32 | + |
| 33 | +### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) |
| 34 | +</div> |
| 35 | + |
| 36 | +# TanStack Devtools |
| 37 | + |
| 38 | +A debugging toolkit that provides a unified interface for inspecting, monitoring, and extending your applications. |
| 39 | + |
| 40 | +- Inspect and debug state and behavior in real time |
| 41 | +- Works with React, Solid, Vanilla JS, and more |
| 42 | +- Extensible plugin architecture with customizable UI |
| 43 | +- Seamless integration with TanStack Query, Router, and other libraries |
| 44 | + |
| 45 | +### <a href="https://tanstack.com/devtools">Read the docs →</b></a> |
| 46 | + |
| 47 | +## Get Involved |
| 48 | + |
| 49 | +- We welcome issues and pull requests! |
| 50 | +- Participate in [GitHub discussions](https://github.com/TanStack/devtools/discussions) |
| 51 | +- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ) |
| 52 | +- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions |
| 53 | + |
| 54 | +## Partners |
| 55 | + |
| 56 | +<table align="center"> |
| 57 | + <tr> |
| 58 | + <td> |
| 59 | + <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" > |
| 60 | + <picture> |
| 61 | + <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" /> |
| 62 | + <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" /> |
| 63 | + <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" /> |
| 64 | + </picture> |
| 65 | + </a> |
| 66 | + </td> |
| 67 | + <td> |
| 68 | + <a href="https://www.cloudflare.com?utm_source=tanstack"> |
| 69 | + <picture> |
| 70 | + <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" /> |
| 71 | + <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" /> |
| 72 | + <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" /> |
| 73 | + </picture> |
| 74 | + </a> |
| 75 | + </td> |
| 76 | + </tr> |
| 77 | +</table> |
| 78 | + |
| 79 | +<div align="center"> |
| 80 | +<img src="./media/partner_logo.svg" alt="Devtools & you?" height="65"> |
| 81 | +<p> |
| 82 | +We're looking for TanStack Devtools Partners to join our mission! Partner with us to push the boundaries of TanStack Devtools and build amazing things together. |
| 83 | +</p> |
| 84 | +<a href="mailto:partners@tanstack.com?subject=TanStack Devtools Partnership"><b>LET'S CHAT</b></a> |
| 85 | +</div> |
| 86 | + |
| 87 | +## Explore the TanStack Ecosystem |
| 88 | + |
| 89 | +- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages |
| 90 | +- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store |
| 91 | +- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state |
| 92 | +- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching |
| 93 | +- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching |
| 94 | +- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives |
| 95 | +- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state |
| 96 | +- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming |
| 97 | +- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store |
| 98 | +- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids |
| 99 | +- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering |
| 100 | + |
| 101 | +… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a> |
130 | 102 |
|
131 | 103 | <!-- USE THE FORCE LUKE --> |
0 commit comments