urql is an implementation of a GraphQL client, built to be both easy to use for newcomers to
GraphQL, as well as extensible, to grow to support dynamic single-app applications and highly
customized GraphQL infrastructure. In short,
urql prioritizes usability and adaptability.
urql can be understood as a collection of connected parts and packages. When getting started we only need to install a single package for our
framework of choice. We're then able to declaratively send GraphQL requests to our API.
All framework packages — like
@urql/svelte — wrap the core
package, which we can imagine as the brain of
urql with most of its
As we progress with implementing
urql into our application, we're later able to extend it by
adding "addon packages", which we call Exchanges
This documentation is split into groups or sections that cover different levels of usage or areas of interest.
- Basics is the section where we find the "Getting Started" guide and usage patterns for our framework of choice.
- Main Concepts then explains more about how
urqlfunctions, what it's made up of, and covers the main aspects of the
Clientand GraphQL clients in general, on the "Philosophy" page.
- Advanced covers all more uncommon use-cases and contains guides that we won't need immediately
when we get started with
- Graphcache documents one of the most important addons to
urql, which adds "Normalized Caching" support to the
Clientand enables more complex use-cases, smarter caching, and more dynamic apps to function.
- Showcase aims to list users of
urql, third-party packages, and other helpful resources, like tutorials and guides.
- API contains a detailed list of all helpers, utilities, components, and other parts of each of
urql's packages, which may contain all details of each part and package.
We hope you grow to love