Skip to content

Commit 9b913ed

Browse files
authored
Add Solid documentation and SolidStart implementation (#3837)
1 parent 86f0100 commit 9b913ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+7267
-827
lines changed

.changeset/fast-nights-rescue.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@urql/solid': patch
3+
---
4+
5+
Use `@solid-primitives/utils` for `access` and `MaybeAccessor` utilities instead of custom implementations. This aligns the package with standard Solid ecosystem conventions.

.changeset/tall-paths-roll.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
'@urql/solid-start': minor
3+
---
4+
5+
Initial release of `@urql/solid-start` - URQL integration built with SolidStart's native primitives.
6+
7+
Get started with:
8+
9+
- **`createQuery`** - GraphQL queries using SolidStart's `query()` and `createAsync()`
10+
- **`createMutation`** - GraphQL mutations using SolidStart's `action()` and `useAction()`
11+
- **`createSubscription`** - Real-time GraphQL subscriptions
12+
- **`Provider`** and **`useClient`** - Context-based client access
13+
- **Reactive variables** - All parameters accept signals/accessors for automatic re-execution
14+
- **Full SSR support** - Works seamlessly with SolidStart's server-side rendering
15+
- **TypeScript support** - Complete type safety with GraphQL types
16+
- **Uses `@solid-primitives/utils`** - Leverages standard Solid ecosystem utilities

docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ apps through ["Normalized Caching"](./graphcache/normalized-caching.md).
1717
`urql` can be understood as a collection of connected parts and packages.
1818
When we only need to install a single package for our framework of choice. We're then able to
1919
declaratively send GraphQL requests to our API. All framework packages — like `urql` (for React),
20-
`@urql/preact`, `@urql/svelte`, and `@urql/vue` — wrap the [core package,
20+
`@urql/preact`, `@urql/svelte`, `@urql/solid`/`@urql/solid-start` and `@urql/vue` — wrap the [core package,
2121
`@urql/core`](./basics/core.md), which we can imagine as the brain
2222
of `urql` with most of its logic. As we progress with implementing `urql` into our application,
2323
we're later able to extend it by adding ["addon packages", which we call
@@ -33,6 +33,8 @@ We have **Getting Started** guides for:
3333
- [**React/Preact**](./basics/react-preact.md) covers how to work with the bindings for React/Preact.
3434
- [**Vue**](./basics/vue.md) covers how to work with the bindings for Vue 3.
3535
- [**Svelte**](./basics/svelte.md) covers how to work with the bindings for Svelte.
36+
- [**Solid**](./basics/solid.md) covers how to work with the bindings for Solid.
37+
- [**SolidStart**](./basics/solid-start.md) covers how to work with the bindings for SolidStart.
3638
- [**Core Package**](./basics/core.md) covers the shared "core APIs" and how we can use them directly
3739
in Node.js or imperatively.
3840

0 commit comments

Comments
 (0)