You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.md
+30-35Lines changed: 30 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,59 +3,54 @@ title: Installation
3
3
id: installation
4
4
---
5
5
6
-
You can install TanStack Pacer with any [NPM](https://npmjs.com)package manager.
6
+
TanStack Pacer is compatible with various front-end frameworks. Install the corresponding adapter for your framework using your preferred package manager:
7
7
8
-
Only install one of the following packages depending on your use case:
8
+
<!-- ::start:tabs variant="package-managers" -->
9
9
10
-
## React
10
+
react: @tanstack/react-pacer
11
+
solid: @tanstack/solid-pacer
12
+
angular: @tanstack/angular-pacer
11
13
12
-
```sh
13
-
npm install @tanstack/react-pacer
14
-
```
14
+
<!-- ::end:tabs -->
15
15
16
-
TanStack Pacer is compatible with React v16.8+
16
+
Each framework package re-exports everything from the core `@tanstack/pacer` package, so there is no need to install the core package separately.
17
17
18
-
## Solid
18
+
> [!NOTE]
19
+
> If you are not using a framework, you can install the core `@tanstack/pacer` package directly for use with vanilla JavaScript.
19
20
20
-
```sh
21
-
npm install @tanstack/solid-pacer
22
-
```
21
+
<!-- ::start:framework -->
23
22
24
-
TanStack Pacer is compatible with Solid v1.9.5+
23
+
# React
25
24
26
-
## Angular
25
+
## Devtools
27
26
28
-
```sh
29
-
npm install @tanstack/angular-pacer
30
-
```
27
+
Developer tools are available using [TanStack Devtools](https://tanstack.com/devtools/latest). Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect and monitor your pacers.
31
28
32
-
TanStack Pacer is compatible with Angular v16+
29
+
# Solid
33
30
34
-
## Vanilla JS
31
+
## Devtools
35
32
36
-
```sh
37
-
npm install @tanstack/pacer
38
-
```
33
+
Developer tools are available using [TanStack Devtools](https://tanstack.com/devtools/latest). Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect and monitor your pacers.
39
34
40
-
Install the the core `@tanstack/pacer` package to use with any framework or without a framework. Each framework package up above will also re-export everything from this core package.
35
+
<!-- ::end:framework -->
41
36
42
-
> [!IMPORTANT]
43
-
> There's no need to install the `@tanstack/pacer` core package if you've already installed one of the above framework packages.
37
+
<!-- ::start:tabs variant="package-manager" -->
44
38
45
-
## Devtools (Optional)
39
+
react: @tanstack/react-devtools
40
+
react: @tanstack/react-pacer-devtools
41
+
solid: @tanstack/solid-devtools
42
+
solid: @tanstack/solid-pacer-devtools
46
43
47
-
To use the devtools for debugging and monitoring, install both the framework devtools and the Pacer devtools packages:
0 commit comments