Repository files navigation

A highly customisable and versatile GraphQL client

• 📦One package to get a working GraphQL client in React, Preact, Vue, Solid and Svelte
• ⚙️ Fullycustomisable behaviourvia "exchanges"
• 🗂 Logical but simple default behaviour and document caching
• 🌱 Normalized caching via@urql/exchange-graphcache
• 🔬 Easy debugging with theurql devtools browser extensions

urql is a GraphQL client that exposes a set of helpers for several frameworks. It's built to be highly customisable and versatile soyou can take it from getting started with your first GraphQL project all the way to building complex apps and experimenting with GraphQL clients.

📃 For more information,check out the docs.

BigCommerce

WunderGraph

The Guild

BeatGig

The urql project was founded byFormidable and is actively developedby the urql GraphQL team.

If you'd like to get involved,check out our Contributor's guide.

All new releases and updates are listed on GitHub with full changelogs. Each package in thisrepository further contains an independentCHANGELOG.md file with the historical changelog, forinstance,here’s@urql/core’schangelog.

If you’re upgrading to v4,check out our migration guide, posted as anissue.

New releases are prepared usingchangesets,which are changelog entries added to each PR, and we have “Version Packages” PRs that once mergedwill release new versions ofurql packages. You can use@canary releases fromnpm if you’dlike to get a preview of the merged changes.

The documentation contains everything you need to know abouturql, and contains several sections in order of importancewhen you first get started:

• Basics — contains the"Getting Started" guide and all you need to know when first usingurql.
• Architecture — explains howurql functions and is built.
• Advanced — covers more uncommon use-cases and things you don't immediately need when getting started.
• Graphcache — documents"Normalized Caching" support which enables more complex apps and use-cases.
• API — the API documentation for each individual package.

Furthermore, all APIs and packages are self-documented using TSDocs. If you’re using a languageserver for TypeScript, the documentation for each API should pop up in your editor when hoveringurql’s code and APIs.

You can find the raw markdown files inside this repository'sdocs folder.