diff --git a/README.md b/README.md index 92cc13f0..b9d15c4e 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ 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' @@ -82,14 +82,14 @@ function App() { return (

My App

- , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, ]} diff --git a/docs/configuration.md b/docs/configuration.md index 36cf37f0..dc3f50eb 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -90,7 +90,7 @@ 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' @@ -98,12 +98,12 @@ createRoot(document.getElementById('root')!).render( - , }, ]} diff --git a/docs/framework/react/basic-setup.md b/docs/framework/react/basic-setup.md index 3ae0bcae..b831a4d9 100644 --- a/docs/framework/react/basic-setup.md +++ b/docs/framework/react/basic-setup.md @@ -13,10 +13,10 @@ 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' @@ -24,12 +24,12 @@ createRoot(document.getElementById('root')!).render( - + , ) ``` -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: @@ -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' @@ -53,18 +53,18 @@ createRoot(document.getElementById('root')!).render( - , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, { - name: 'Tanstack Form', + name: 'TanStack Form', render: , }, ]} @@ -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). diff --git a/docs/framework/react/guides/custom-plugins.md b/docs/framework/react/guides/custom-plugins.md index 1b36cf19..d3ec5e26 100644 --- a/docs/framework/react/guides/custom-plugins.md +++ b/docs/framework/react/guides/custom-plugins.md @@ -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 @@ -144,7 +144,7 @@ createRoot(document.getElementById('root')!).render( - - + , ) ``` -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: @@ -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' @@ -52,14 +52,14 @@ render(() => ( <> - , }, { - name: 'Tanstack Form', + name: 'TanStack Form', render: () => , }, ]} @@ -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). diff --git a/docs/framework/solid/reference/functions/tanstackdevtools.md b/docs/framework/solid/reference/functions/tanstackdevtools.md index 0673c66b..c9dcaca3 100644 --- a/docs/framework/solid/reference/functions/tanstackdevtools.md +++ b/docs/framework/solid/reference/functions/tanstackdevtools.md @@ -1,14 +1,14 @@ --- -id: TanstackDevtools -title: TanstackDevtools +id: TanStackDevtools +title: TanStackDevtools --- -# 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) @@ -17,7 +17,7 @@ Defined in: [devtools.tsx:96](https://github.com/TanStack/devtools/blob/main/pac ### \_\_namedParameters -`TanstackDevtoolsInit` +`TanStackDevtoolsInit` ## Returns diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index d4a421cd..ba505f55 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -13,4 +13,4 @@ title: "@tanstack/solid-devtools" ## Functions -- [TanstackDevtools](functions/tanstackdevtools.md) +- [TanStackDevtools](functions/tanstackdevtools.md) diff --git a/docs/quick-start.md b/docs/quick-start.md index db704ce2..4fb50176 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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 ( <> - + ) } @@ -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 ( <> - @@ -44,7 +44,7 @@ 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' @@ -52,13 +52,13 @@ function App() { return ( - , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, ]} /> diff --git a/examples/react/basic/src/setup.tsx b/examples/react/basic/src/setup.tsx index cb6d3c06..91909a22 100644 --- a/examples/react/basic/src/setup.tsx +++ b/examples/react/basic/src/setup.tsx @@ -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: () => ( @@ -63,14 +63,14 @@ export default function DevtoolsExample() { return ( <> - , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, ]} diff --git a/examples/react/custom-devtools/src/index.tsx b/examples/react/custom-devtools/src/index.tsx index 3be7f3c4..e6195a24 100644 --- a/examples/react/custom-devtools/src/index.tsx +++ b/examples/react/custom-devtools/src/index.tsx @@ -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' @@ -9,7 +9,7 @@ createRoot(document.getElementById('root')!).render( - - , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, { diff --git a/examples/react/start/src/router.tsx b/examples/react/start/src/router.tsx index 54c35683..1b5fb67c 100644 --- a/examples/react/start/src/router.tsx +++ b/examples/react/start/src/router.tsx @@ -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, diff --git a/examples/react/time-travel/src/setup.tsx b/examples/react/time-travel/src/setup.tsx index bcec391b..90f85933 100644 --- a/examples/react/time-travel/src/setup.tsx +++ b/examples/react/time-travel/src/setup.tsx @@ -9,7 +9,7 @@ import { createRoute, createRouter, } from '@tanstack/react-router' -import { TanstackDevtools } from '@tanstack/react-devtools' +import { TanStackDevtools } from '@tanstack/react-devtools' import { ZustandTimeTravel } from './zustand-time-travel' const rootRoute = createRootRoute({ @@ -64,14 +64,14 @@ export default function DevtoolsExample() { return ( <> - , }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, { diff --git a/examples/solid/basic/src/setup.tsx b/examples/solid/basic/src/setup.tsx index 3d814a99..3d42407a 100644 --- a/examples/solid/basic/src/setup.tsx +++ b/examples/solid/basic/src/setup.tsx @@ -9,7 +9,7 @@ import { createRoute, createRouter, } from '@tanstack/solid-router' -import { TanstackDevtools } from '@tanstack/solid-devtools' +import { TanStackDevtools } from '@tanstack/solid-devtools' const rootRoute = createRootRoute({ component: () => ( @@ -62,10 +62,10 @@ const queryClient = new QueryClient() export default function DevtoolsExample() { return ( <> - @@ -73,7 +73,7 @@ export default function DevtoolsExample() { ), }, { - name: 'Tanstack Router', + name: 'TanStack Router', render: , }, ]} diff --git a/examples/solid/start/src/app.tsx b/examples/solid/start/src/app.tsx index e4aff2c3..5d1915ae 100644 --- a/examples/solid/start/src/app.tsx +++ b/examples/solid/start/src/app.tsx @@ -1,5 +1,5 @@ import { createSignal } from 'solid-js' -import { TanstackDevtools } from '@tanstack/solid-devtools' +import { TanStackDevtools } from '@tanstack/solid-devtools' import './app.css' export default function App() { @@ -7,7 +7,7 @@ export default function App() { return (
- +

Hello world!