Skip to content

Commit 84e3848

Browse files
authored
Merge branch 'main' into fix/replaceEqualDeep-object-create
2 parents bc4f4e5 + ed12e18 commit 84e3848

File tree

21 files changed

+843
-243
lines changed

21 files changed

+843
-243
lines changed

docs/config.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,21 @@
5858
"label": "Overview",
5959
"to": "framework/solid/overview"
6060
},
61+
{
62+
"label": "Quick Start",
63+
"to": "framework/solid/quick-start"
64+
},
65+
{
66+
"label": "Installation",
67+
"to": "framework/solid/installation"
68+
},
6169
{
6270
"label": "Devtools",
6371
"to": "framework/solid/devtools"
72+
},
73+
{
74+
"label": "TypeScript",
75+
"to": "framework/solid/typescript"
6476
}
6577
]
6678
},

docs/framework/solid/devtools.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ Wave your hands in the air and shout hooray because Solid Query comes with dedic
77

88
When you begin your Solid Query journey, you'll want these devtools by your side. They help visualize all of the inner workings of Solid Query and will likely save you hours of debugging if you find yourself in a pinch!
99

10-
> Also note that you can use these devtools to observe queries, but **not mutations** (yet).
11-
1210
## Install and Import the Devtools
1311

1412
The devtools are a separate package that you need to install:
@@ -29,7 +27,7 @@ You can import the devtools like this:
2927
import { SolidQueryDevtools } from '@tanstack/solid-query-devtools'
3028
```
3129

32-
By default, Solid Query Devtools are only included in bundles when `process.env.NODE_ENV === 'development'`, so you don't need to worry about excluding them during a production build.
30+
By default, Solid Query Devtools are only included in bundles when `isServer === true` ([`isServer`](https://github.com/solidjs/solid/blob/a72d393a07b22f9b7496e5eb93712188ccce0d28/packages/solid/web/src/index.ts#L37) comes from the `solid-js/web` package), so you don't need to worry about excluding them during a production build.
3331

3432
## Floating Mode
3533

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
id: installation
3+
title: Installation
4+
---
5+
6+
You can install Solid Query via [NPM](https://npmjs.com/),
7+
or a good ol' `<script>` via
8+
[ESM.sh](https://esm.sh/).
9+
10+
### NPM
11+
12+
```bash
13+
$ npm i @tanstack/solid-query
14+
# or
15+
$ pnpm add @tanstack/solid-query
16+
# or
17+
$ yarn add @tanstack/solid-query
18+
# or
19+
$ bun add @tanstack/solid-query
20+
```
21+
22+
> Wanna give it a spin before you download? Try out the [simple](../examples/simple) or [basic](../examples/basic) examples!
23+
24+
### CDN
25+
26+
If you're not using a module bundler or package manager, you can also use this library via an ESM-compatible CDN such as [ESM.sh](https://esm.sh/). Simply add a `<script type="module">` tag to the bottom of your HTML file:
27+
28+
```html
29+
<script type="module">
30+
import { QueryClient } from 'https://esm.sh/@tanstack/solid-query'
31+
</script>
32+
```
33+
34+
### Requirements
35+
36+
Solid Query is optimized for modern browsers. It is compatible with the following browsers config
37+
38+
```
39+
Chrome >= 91
40+
Firefox >= 90
41+
Edge >= 91
42+
Safari >= 15
43+
iOS >= 15
44+
Opera >= 77
45+
```
46+
47+
> Depending on your environment, you might need to add polyfills. If you want to support older browsers, you need to transpile the library from `node_modules` yourselves.

0 commit comments

Comments
 (0)