Skip to content

Commit 44a8410

Browse files
authored
chore: capitalize "TanStack" consistently (#35)
1 parent 1f915a8 commit 44a8410

File tree

24 files changed

+93
-93
lines changed

24 files changed

+93
-93
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,22 +74,22 @@ npm install @tanstack/devtools # no framework, just vanilla js
7474
### React
7575

7676
```tsx
77-
import { TanstackDevtools } from '@tanstack/react-devtools'
77+
import { TanStackDevtools } from '@tanstack/react-devtools'
7878
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
7979
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
8080

8181
function App() {
8282
return (
8383
<div>
8484
<h1>My App</h1>
85-
<TanstackDevtools
85+
<TanStackDevtools
8686
plugins={[
8787
{
88-
name: 'Tanstack Query',
88+
name: 'TanStack Query',
8989
render: <ReactQueryDevtoolsPanel />,
9090
},
9191
{
92-
name: 'Tanstack Router',
92+
name: 'TanStack Router',
9393
render: <TanStackRouterDevtoolsPanel router={router} />,
9494
},
9595
]}

docs/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,20 +90,20 @@ import { StrictMode } from 'react'
9090
import { createRoot } from 'react-dom/client'
9191
import { FormDevtools } from '@tanstack/react-form'
9292

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

9595
import App from './App'
9696

9797
createRoot(document.getElementById('root')!).render(
9898
<StrictMode>
9999
<App />
100100

101-
<TanstackDevtools
101+
<TanStackDevtools
102102
config={{ hideUntilHover: true, }}
103103
eventBusConfig={{ debug: true }}
104104
plugins={[
105105
{
106-
name: 'Tanstack Form',
106+
name: 'TanStack Form',
107107
render: <FormDevtools />,
108108
},
109109
]}

docs/framework/react/basic-setup.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ Install the [TanStack Devtools](https://www.npmjs.com/package/@tanstack/react-de
1313
npm i @tanstack/react-devtools
1414
```
1515

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

1818
```tsx
19-
import { TanstackDevtools } from '@tanstack/react-devtools'
19+
import { TanStackDevtools } from '@tanstack/react-devtools'
2020

2121
import App from './App'
2222

2323
createRoot(document.getElementById('root')!).render(
2424
<StrictMode>
2525
<App />
2626

27-
<TanstackDevtools />
27+
<TanStackDevtools />
2828
</StrictMode>,
2929
)
3030
```
3131

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

3434
Currently TanStack offers:
3535

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

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

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

56-
<TanstackDevtools
56+
<TanStackDevtools
5757
plugins={[
5858
{
59-
name: 'Tanstack Query',
59+
name: 'TanStack Query',
6060
render: <ReactQueryDevtoolsPanel />,
6161
},
6262
{
63-
name: 'Tanstack Router',
63+
name: 'TanStack Router',
6464
render: <TanStackRouterDevtoolsPanel />,
6565
},
6666
{
67-
name: 'Tanstack Form',
67+
name: 'TanStack Form',
6868
render: <ReactFormDevtoolsPanel />,
6969
},
7070
]}
@@ -73,6 +73,6 @@ createRoot(document.getElementById('root')!).render(
7373
)
7474
```
7575

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

7878
A complete working example can be found in our [basic example](https://tanstack.com/devtools/latest/docs/framework/react/examples/basic).

docs/framework/react/guides/custom-plugins.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Custom plugins
33
id: custom-plugins
44
---
55

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

88
## Prerequisite
99

@@ -144,7 +144,7 @@ createRoot(document.getElementById('root')!).render(
144144
<StrictMode>
145145
<App />
146146

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

161161
## Debugging
162162

163-
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.
163+
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.
164164

165-
TanstackDevtool's debugging mode can be activated like so:
165+
TanStackDevtool's debugging mode can be activated like so:
166166
```tsx
167-
<TanstackDevtools
167+
<TanStackDevtools
168168
eventBusConfig={{ debug: true }}
169169
plugins={[
170170
{

docs/framework/solid/basic-setup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ Install the [TanStack Devtools](https://www.npmjs.com/package/@tanstack/solid-de
1313
npm i @tanstack/solid-devtools
1414
```
1515

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

1818
```tsx
19-
import { TanstackDevtools } from '@tanstack/solid-devtools'
19+
import { TanStackDevtools } from '@tanstack/solid-devtools'
2020

2121
import App from './App'
2222

2323
createRoot(document.getElementById('root')!).render(
2424
<StrictMode>
2525
<App />
2626

27-
<TanstackDevtools />
27+
<TanStackDevtools />
2828
</StrictMode>,
2929
)
3030
```
3131

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

3434
Currently TanStack offers:
3535

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

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

4545
import { SolidQueryDevtoolsPanel } from '@tanstack/solid-query-devtools'
4646
import { TanStackRouterDevtoolsPanel } from '@tanstack/solid-router-devtools'
@@ -52,14 +52,14 @@ render(() => (
5252
<>
5353
<App />
5454

55-
<TanstackDevtools
55+
<TanStackDevtools
5656
plugins={[
5757
{
58-
name: 'Tanstack router',
58+
name: 'TanStack router',
5959
render: () => <TanStackRouterDevtoolsPanel />,
6060
},
6161
{
62-
name: 'Tanstack Form',
62+
name: 'TanStack Form',
6363
render: () => <SolidFormDevtoolsPanel />,
6464
},
6565
]}
@@ -68,6 +68,6 @@ render(() => (
6868
), document.getElementById('root')!);
6969
```
7070

71-
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.
71+
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.
7272

7373
A complete working example can be found in our [examples section](https://tanstack.com/devtools/latest/docs/framework/solid/examples).

docs/framework/solid/reference/functions/tanstackdevtools.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
id: TanstackDevtools
3-
title: TanstackDevtools
2+
id: TanStackDevtools
3+
title: TanStackDevtools
44
---
55

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

8-
# Function: TanstackDevtools()
8+
# Function: TanStackDevtools()
99

1010
```ts
11-
function TanstackDevtools(__namedParameters): Element
11+
function TanStackDevtools(__namedParameters): Element
1212
```
1313

1414
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
1717

1818
### \_\_namedParameters
1919

20-
`TanstackDevtoolsInit`
20+
`TanStackDevtoolsInit`
2121

2222
## Returns
2323

docs/framework/solid/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ title: "@tanstack/solid-devtools"
1313

1414
## Functions
1515

16-
- [TanstackDevtools](functions/tanstackdevtools.md)
16+
- [TanStackDevtools](functions/tanstackdevtools.md)

docs/quick-start.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ To get up and running install the correct adapter for your framework:
1313
Then import the devtools into the root of your application:
1414

1515
```javascript
16-
import { TanstackDevtools } from '@tanstack/react-devtools'
16+
import { TanStackDevtools } from '@tanstack/react-devtools'
1717

1818
function App() {
1919
return (
2020
<>
2121
<YourApp />
22-
<TanstackDevtools />
22+
<TanStackDevtools />
2323
</>
2424
)
2525
}
@@ -28,13 +28,13 @@ function App() {
2828
And you're done! If you want to add custom plugins, you can do so by using the `plugins` prop:
2929

3030
```javascript
31-
import { TanstackDevtools } from '@tanstack/react-devtools'
31+
import { TanStackDevtools } from '@tanstack/react-devtools'
3232

3333
function App() {
3434
return (
3535
<>
3636
<YourApp />
37-
<TanstackDevtools plugins={[
37+
<TanStackDevtools plugins={[
3838
// Add your custom plugins here
3939
]} />
4040
</>
@@ -44,21 +44,21 @@ function App() {
4444

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

5151
function App() {
5252
return (
5353
<QueryClientProvider client={queryClient}>
5454
<YourApp />
55-
<TanstackDevtools plugins={[
55+
<TanStackDevtools plugins={[
5656
{
57-
name: 'Tanstack Query',
57+
name: 'TanStack Query',
5858
render: <ReactQueryDevtoolsPanel />,
5959
},
6060
{
61-
name: 'Tanstack Router',
61+
name: 'TanStack Router',
6262
render: <TanStackRouterDevtoolsPanel />,
6363
},
6464
]} />

examples/react/basic/src/setup.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
createRoute,
1010
createRouter,
1111
} from '@tanstack/react-router'
12-
import { TanstackDevtools } from '@tanstack/react-devtools'
12+
import { TanStackDevtools } from '@tanstack/react-devtools'
1313

1414
const rootRoute = createRootRoute({
1515
component: () => (
@@ -63,14 +63,14 @@ export default function DevtoolsExample() {
6363
return (
6464
<>
6565
<QueryClientProvider client={queryClient}>
66-
<TanstackDevtools
66+
<TanStackDevtools
6767
plugins={[
6868
{
69-
name: 'Tanstack Query',
69+
name: 'TanStack Query',
7070
render: <ReactQueryDevtoolsPanel />,
7171
},
7272
{
73-
name: 'Tanstack Router',
73+
name: 'TanStack Router',
7474
render: <TanStackRouterDevtoolsPanel router={router} />,
7575
},
7676
]}

examples/react/custom-devtools/src/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { StrictMode } from 'react'
22
import { createRoot } from 'react-dom/client'
3-
import { TanstackDevtools } from '@tanstack/react-devtools'
3+
import { TanStackDevtools } from '@tanstack/react-devtools'
44

55
import App from './App'
66
import CustomDevtoolPanel from './CustomDevtoolsPanel'
@@ -9,7 +9,7 @@ createRoot(document.getElementById('root')!).render(
99
<StrictMode>
1010
<App />
1111

12-
<TanstackDevtools
12+
<TanStackDevtools
1313
eventBusConfig={{ debug: true }}
1414
plugins={[
1515
{

0 commit comments

Comments
 (0)