Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,22 +74,22 @@ npm install @tanstack/devtools # no framework, just vanilla js
### React

```tsx
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'

function App() {
return (
<div>
<h1>My App</h1>
<TanstackDevtools
<TanStackDevtools
plugins={[
{
name: 'Tanstack Query',
name: 'TanStack Query',
render: <ReactQueryDevtoolsPanel />,
},
{
name: 'Tanstack Router',
name: 'TanStack Router',
render: <TanStackRouterDevtoolsPanel router={router} />,
},
]}
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,20 @@ import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
import { FormDevtools } from '@tanstack/react-form'

import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

import App from './App'

createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools
<TanStackDevtools
config={{ hideUntilHover: true, }}
eventBusConfig={{ debug: true }}
plugins={[
{
name: 'Tanstack Form',
name: 'TanStack Form',
render: <FormDevtools />,
},
]}
Expand Down
20 changes: 10 additions & 10 deletions docs/framework/react/basic-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ Install the [TanStack Devtools](https://www.npmjs.com/package/@tanstack/react-de
npm i @tanstack/react-devtools
```

Next in the root of your application import the `TanstackDevtools` from the required framework adapter (in this case @tanstack/react-devtools).
Next in the root of your application import the `TanStackDevtools` from the required framework adapter (in this case @tanstack/react-devtools).

```tsx
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

import App from './App'

createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools />
<TanStackDevtools />
</StrictMode>,
)
```

Import the desired devtools and provide it to the `TanstackDevtools` component along with a label for the menu.
Import the desired devtools and provide it to the `TanStackDevtools` component along with a label for the menu.

Currently TanStack offers:

Expand All @@ -40,7 +40,7 @@ Currently TanStack offers:
```tsx
import { createRoot } from 'react-dom/client'

import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
Expand All @@ -53,18 +53,18 @@ createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools
<TanStackDevtools
plugins={[
{
name: 'Tanstack Query',
name: 'TanStack Query',
render: <ReactQueryDevtoolsPanel />,
},
{
name: 'Tanstack Router',
name: 'TanStack Router',
render: <TanStackRouterDevtoolsPanel />,
},
{
name: 'Tanstack Form',
name: 'TanStack Form',
render: <ReactFormDevtoolsPanel />,
},
]}
Expand All @@ -73,6 +73,6 @@ createRoot(document.getElementById('root')!).render(
)
```

Finally add any additional configuration you desire to the `TanstackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../configuration.md) section.
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../configuration.md) section.

A complete working example can be found in our [basic example](https://tanstack.com/devtools/latest/docs/framework/react/examples/basic).
10 changes: 5 additions & 5 deletions docs/framework/react/guides/custom-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Custom plugins
id: custom-plugins
---

Tanstack devtools allows you to create your own custom plugins by emitting and listening to our event bus.
TanStack devtools allows you to create your own custom plugins by emitting and listening to our event bus.

## Prerequisite

Expand Down Expand Up @@ -144,7 +144,7 @@ createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools
<TanStackDevtools
plugins={[
{
// Name it what you like, this is how it will appear in the Menu
Expand All @@ -160,11 +160,11 @@ createRoot(document.getElementById('root')!).render(

## Debugging

Both the TansTack `TanstackDevtools` component and the TanStack `EventClient` come with built in debug mode which will log to the console the emitted event as well as the EventClient status.
Both the TansTack `TanStackDevtools` component and the TanStack `EventClient` come with built in debug mode which will log to the console the emitted event as well as the EventClient status.

TanstackDevtool's debugging mode can be activated like so:
TanStackDevtool's debugging mode can be activated like so:
```tsx
<TanstackDevtools
<TanStackDevtools
eventBusConfig={{ debug: true }}
plugins={[
{
Expand Down
18 changes: 9 additions & 9 deletions docs/framework/solid/basic-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ Install the [TanStack Devtools](https://www.npmjs.com/package/@tanstack/solid-de
npm i @tanstack/solid-devtools
```

Next in the root of your application import the `TanstackDevtools` from the required framework adapter (in this case @tanstack/solid-devtools).
Next in the root of your application import the `TanStackDevtools` from the required framework adapter (in this case @tanstack/solid-devtools).

```tsx
import { TanstackDevtools } from '@tanstack/solid-devtools'
import { TanStackDevtools } from '@tanstack/solid-devtools'

import App from './App'

createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools />
<TanStackDevtools />
</StrictMode>,
)
```

Import the desired devtools and provide it to the `TanstackDevtools` component along with a label for the menu.
Import the desired devtools and provide it to the `TanStackDevtools` component along with a label for the menu.

Currently TanStack offers:

Expand All @@ -40,7 +40,7 @@ Currently TanStack offers:
```tsx
import { render } from 'solid-js/web';

import { TanstackDevtools } from '@tanstack/solid-devtools'
import { TanStackDevtools } from '@tanstack/solid-devtools'

import { SolidQueryDevtoolsPanel } from '@tanstack/solid-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/solid-router-devtools'
Expand All @@ -52,14 +52,14 @@ render(() => (
<>
<App />

<TanstackDevtools
<TanStackDevtools
plugins={[
{
name: 'Tanstack router',
name: 'TanStack router',
render: () => <TanStackRouterDevtoolsPanel />,
},
{
name: 'Tanstack Form',
name: 'TanStack Form',
render: () => <SolidFormDevtoolsPanel />,
},
]}
Expand All @@ -68,6 +68,6 @@ render(() => (
), document.getElementById('root')!);
```

Finally add any additional configuration you desire to the `TanstackDevtools` component, more information can be found under the [TanStack Devtools Configuration](https://tanstack.com/devtools/) section.
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](https://tanstack.com/devtools/) section.

A complete working example can be found in our [examples section](https://tanstack.com/devtools/latest/docs/framework/solid/examples).
10 changes: 5 additions & 5 deletions docs/framework/solid/reference/functions/tanstackdevtools.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: TanstackDevtools
title: TanstackDevtools
id: TanStackDevtools
title: TanStackDevtools
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: TanstackDevtools()
# Function: TanStackDevtools()

```ts
function TanstackDevtools(__namedParameters): Element
function TanStackDevtools(__namedParameters): Element
```

Defined in: [devtools.tsx:96](https://github.com/TanStack/devtools/blob/main/packages/solid-devtools/src/devtools.tsx#L96)
Expand All @@ -17,7 +17,7 @@ Defined in: [devtools.tsx:96](https://github.com/TanStack/devtools/blob/main/pac

### \_\_namedParameters

`TanstackDevtoolsInit`
`TanStackDevtoolsInit`

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ title: "@tanstack/solid-devtools"

## Functions

- [TanstackDevtools](functions/tanstackdevtools.md)
- [TanStackDevtools](functions/tanstackdevtools.md)
16 changes: 8 additions & 8 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ To get up and running install the correct adapter for your framework:
Then import the devtools into the root of your application:

```javascript
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

function App() {
return (
<>
<YourApp />
<TanstackDevtools />
<TanStackDevtools />
</>
)
}
Expand All @@ -28,13 +28,13 @@ function App() {
And you're done! If you want to add custom plugins, you can do so by using the `plugins` prop:

```javascript
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

function App() {
return (
<>
<YourApp />
<TanstackDevtools plugins={[
<TanStackDevtools plugins={[
// Add your custom plugins here
]} />
</>
Expand All @@ -44,21 +44,21 @@ function App() {

For example, if you want to add TanStack query & router you could do so in the following way:
```javascript
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'

function App() {
return (
<QueryClientProvider client={queryClient}>
<YourApp />
<TanstackDevtools plugins={[
<TanStackDevtools plugins={[
{
name: 'Tanstack Query',
name: 'TanStack Query',
render: <ReactQueryDevtoolsPanel />,
},
{
name: 'Tanstack Router',
name: 'TanStack Router',
render: <TanStackRouterDevtoolsPanel />,
},
]} />
Expand Down
8 changes: 4 additions & 4 deletions examples/react/basic/src/setup.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
createRoute,
createRouter,
} from '@tanstack/react-router'
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

const rootRoute = createRootRoute({
component: () => (
Expand Down Expand Up @@ -63,14 +63,14 @@ export default function DevtoolsExample() {
return (
<>
<QueryClientProvider client={queryClient}>
<TanstackDevtools
<TanStackDevtools
plugins={[
{
name: 'Tanstack Query',
name: 'TanStack Query',
render: <ReactQueryDevtoolsPanel />,
},
{
name: 'Tanstack Router',
name: 'TanStack Router',
render: <TanStackRouterDevtoolsPanel router={router} />,
},
]}
Expand Down
4 changes: 2 additions & 2 deletions examples/react/custom-devtools/src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'

import App from './App'
import CustomDevtoolPanel from './CustomDevtoolsPanel'
Expand All @@ -9,7 +9,7 @@ createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />

<TanstackDevtools
<TanStackDevtools
eventBusConfig={{ debug: true }}
plugins={[
{
Expand Down
8 changes: 4 additions & 4 deletions examples/react/start/src/components/devtools.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
import { TanstackDevtools } from '@tanstack/react-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'
import { StudioPlugin } from './prisma-plugin'
import ClientPlugin from './client-plugin'

Expand All @@ -11,17 +11,17 @@ export default function DevtoolsExample() {
return (
<>
<QueryClientProvider client={queryClient}>
<TanstackDevtools
<TanStackDevtools
eventBusConfig={{
debug: true,
}}
plugins={[
{
name: 'Tanstack Query',
name: 'TanStack Query',
render: <ReactQueryDevtoolsPanel />,
},
{
name: 'Tanstack Router',
name: 'TanStack Router',
render: <TanStackRouterDevtoolsPanel />,
},
{
Expand Down
4 changes: 2 additions & 2 deletions examples/react/start/src/router.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { createRouter as createTanstackRouter } from '@tanstack/react-router'
import { createRouter as createTanStackRouter } from '@tanstack/react-router'

// Import the generated route tree
import { routeTree } from './routeTree.gen'

// Create a new router instance
export const createRouter = () => {
return createTanstackRouter({
return createTanStackRouter({
routeTree,
scrollRestoration: true,
defaultPreloadStaleTime: 0,
Expand Down
Loading