graphql-react

A GraphQL client for React using modern context and hooks APIs that’s lightweight (< 4 kB) but powerful; the first Relay and Apollo alternative with server side rendering.

The API can also be used to custom load, cache and server side render any data, even from non-GraphQL sources.

• Setup
• Examples
• Support
• API

Setup

First, polyfill any required globals (see Support) that are missing in your server and client environments.

Next.js setup

See the next-graphql-react setup instructions.

Custom React setup

To install with npm, run:

npm install graphql-react

Create a single Cache instance and use the Provider component to provide it for your app.

To server side render your app, use the waterfallRender function from react-waterfall-render.

Examples

• Official Next.js example.
• Next.js example deployed at graphql-react.vercel.app.

Here is a basic example using the GitHub GraphQL API, with tips commented:

// While named imports are available, deep imports result in a small bundle size
// regardless of the (often dubious) tree-shaking abilities of your bundler.
import useAutoLoad from 'graphql-react/public/useAutoLoad.js';
import useCacheEntry from 'graphql-react/public/useCacheEntry.js';
import useLoadGraphQL from 'graphql-react/public/useLoadGraphQL.js';
import useWaterfallLoad from 'graphql-react/public/useWaterfallLoad.js';
import { useCallback } from 'react';

// The query is just a string; no need to use `gql` from `graphql-tag`. The
// special comment before the string allows editor syntax highlighting, Prettier
// formatting and linting. The cache system doesn’t require `__typename` or `id`
// fields to be queried.
const query = /* GraphQL */ `
  query ($repoId: ID!) {
    repo: node(id: $repoId) {
      ... on Repository {
        stargazers {
          totalCount
        }
      }
    }
  }
`;

export default function GitHubRepoStars({ repoId }) {
  const cacheKey = `GitHubRepoStars-${repoId}`;
  const cacheValue = useCacheEntry(cacheKey);

  // A hook for loading GraphQL is available, but custom hooks for loading non
  // GraphQL (e.g. fetching from a REST API) can be made.
  const loadGraphQL = useLoadGraphQL();

  const load = useCallback(
    () =>
      // To be DRY, utilize a custom hook for each API your app loads from, e.g.
      // `useLoadGraphQLGitHub`.
      loadGraphQL(
        cacheKey,
        // Fetch URI.
        'https://api.github.com/graphql',
        // Fetch options.
        {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
            Accept: 'application/json',
            Authorization: `Bearer ${process.env.GITHUB_ACCESS_TOKEN}`,
          },
          body: JSON.stringify({
            query,
            variables: {
              repoId,
            },
          }),
        }
      ),
    [cacheKey, loadGraphQL, repoId]
  );

  // This hook automatically keeps the cache entry loaded from when the
  // component mounts, reloading it if it’s staled or deleted. It also aborts
  // loading if the arguments change or the component unmounts; very handy for
  // auto-suggest components!
  useAutoLoad(cacheKey, load);

  // Waterfall loading can be used to load data when server side rendering,
  // enabled automagically by `next-graphql-react`. To learn how this works or
  // to set it up for a non-Next.js app, see:
  // https://github.com/jaydenseric/react-waterfall-render
  const isWaterfallLoading = useWaterfallLoad(cacheKey, load);

  // When waterfall loading it’s efficient to skip rendering, as the app will
  // re-render once this step of the waterfall has loaded. If more waterfall
  // loading happens in children, those steps of the waterfall are awaited and
  // the app re-renders again, and so forth until there’s no more loading for
  // the final server side render.
  return isWaterfallLoading
    ? null
    : cacheValue
    ? cacheValue.errors
      ? // Unlike many other GraphQL libraries, detailed loading errors are
        // cached and can be server side rendered without causing a
        // server/client HTML mismatch error.
        'Error!'
      : cacheValue.data.repo.stargazers.totalCount
    : // In this situation no cache value implies loading. Use the
      // `useLoadingEntry` hook to manage loading in detail.
      'Loading…';
}

Support

• Node.js: ^12.20 || >= 14.13
• Browsers: > 0.5%, not OperaMini all, not IE > 0, not dead

Consider polyfilling:

• AbortController
• CustomEvent
• Event
• EventTarget
• fetch
• FormData
• performance

API

• class Cache
  • Cache instance property store
  • Cache event delete
  • Cache event prune
  • Cache event set
  • Cache event stale
• class Loading
  • Loading instance property store
  • Loading event end
  • Loading event start
• class LoadingCacheValue
  • LoadingCacheValue instance property abortController
  • LoadingCacheValue instance property promise
  • LoadingCacheValue instance property timeStamp
• function cacheDelete
• function cacheEntryDelete
• function cacheEntryPrune
• function cacheEntrySet
• function cacheEntryStale
• function cachePrune
• function cacheStale
• function fetchGraphQL
• function fetchOptionsGraphQL
• function Provider
• function useAutoAbortLoad
• function useAutoLoad
• function useCache
• function useCacheEntry
• function useCacheEntryPrunePrevention
• function useLoadGraphQL
• function useLoading
• function useLoadingEntry
• function useLoadOnDelete
• function useLoadOnMount
• function useLoadOnStale
• function useWaterfallLoad
• member CacheContext
• member HydrationTimeStampContext
• member LoadingContext
• constant HYDRATION_TIME_MS
• type CacheKey
• type CacheKeyMatcher
• type CacheValue
• type FetchOptions
• type GraphQLOperation
• type GraphQLResult
• type GraphQLResultError
• type HighResTimeStamp
• type Loader
• type LoadGraphQL
• type ReactNode

class Cache

Cache store.

Examples

Ways to import.

import { Cache } from 'graphql-react';

import Cache from 'graphql-react/public/Cache.js';

Ways to require.

const { Cache } = require('graphql-react');

const Cache = require('graphql-react/public/Cache.js');

Construct a new instance.

const cache = new Cache();

Cache instance property store

Store of cache keys and values.

Type: object

Cache event delete

Signals that a cache store entry was deleted. The event name starts with the cache key of the deleted entry, followed by /delete.

Type: CustomEvent

Cache event prune

Signals that a cache store entry will be deleted unless the event is canceled via event.preventDefault(). The event name starts with the cache key of the entry being pruned, followed by /prune.

Type: CustomEvent

Cache event set

Signals that a cache store entry was set. The event name starts with the cache key of the set entry, followed by /set.

Type: CustomEvent

Cache event stale

Signals that a cache store entry is now stale (often due to a mutation) and should probably be reloaded. The event name starts with the cache key of the stale entry, followed by /stale.

Type: CustomEvent

class Loading

Loading store.

Examples

Ways to import.

import { Loading } from 'graphql-react';

import Loading from 'graphql-react/public/Loading.js';

Ways to require.

const { Loading } = require('graphql-react');

const Loading = require('graphql-react/public/Loading.js');

Construct a new instance.

const loading = new Loading();

Loading instance property store

Loading store, keyed by cache key. Multiple loading cache values for the same key are set in the order they started.

Type: object<CacheKey, Set<LoadingCacheValue>>

Loading event end

Signals the end of loading a cache value; either the loading finished and the cache value was set, the loading was aborted, or there was an error. The event name starts with the cache key, followed by /end.

Type: CustomEvent

Loading event start

Signals the start of loading a cache value. The event name starts with the cache key, followed by /start.

Type: CustomEvent

class LoadingCacheValue

Controls a loading cache value.

Fires

• Loading event start
• Cache event set
• Loading event end

Examples

Ways to import.

import { LoadingCacheValue } from 'graphql-react';

import LoadingCacheValue from 'graphql-react/public/LoadingCacheValue.js';

Ways to require.

const { LoadingCacheValue } = require('graphql-react');

const LoadingCacheValue = require('graphql-react/public/LoadingCacheValue.js');

LoadingCacheValue instance property abortController

Aborts this loading and skips setting the loading result as the cache value. Has no affect after loading ends.

Type: AbortController

LoadingCacheValue instance property promise

Resolves the loading result, after the cache value has been set if the loading wasn’t aborted. Shouldn’t reject.

Type: Promise<*>

LoadingCacheValue instance property timeStamp

When this loading started.

Type: HighResTimeStamp

function cacheDelete

Deletes cache entries. Useful after a user logs out.

Fires

• Cache event delete

Examples

Ways to import.

import { cacheDelete } from 'graphql-react';

import cacheDelete from 'graphql-react/public/cacheDelete.js';

Ways to require.

const { cacheDelete } = require('graphql-react');

const cacheDelete = require('graphql-react/public/cacheDelete.js');

function cacheEntryDelete

Deletes a cache entry.

Fires

• Cache event delete

Examples

Ways to import.

import { cacheEntryDelete } from 'graphql-react';

import cacheEntryDelete from 'graphql-react/public/cacheEntryDelete.js';

Ways to require.

const { cacheEntryDelete } = require('graphql-react');

const cacheEntryDelete = require('graphql-react/public/cacheEntryDelete.js');

function cacheEntryPrune

Prunes a cache entry, if no prune event listener cancels the cache entry deletion via event.preventDefault().

Fires

• Cache event prune
• Cache event delete

Examples

Ways to import.

import { cacheEntryPrune } from 'graphql-react';

import cacheEntryPrune from 'graphql-react/public/cacheEntryPrune.js';

Ways to require.

const { cacheEntryPrune } = require('graphql-react');

const cacheEntryPrune = require('graphql-react/public/cacheEntryPrune.js');

function cacheEntrySet

Sets a cache entry.

Fires

• Cache event set

Examples

Ways to import.

import { cacheEntrySet } from 'graphql-react';

import cacheEntrySet from 'graphql-react/public/cacheEntrySet.js';

Ways to require.

const { cacheEntrySet } = require('graphql-react');

const cacheEntrySet = require('graphql-react/public/cacheEntrySet.js');

function cacheEntryStale

Stales a cache entry, signalling it should probably be reloaded.

Fires

• Cache event stale

Examples

Ways to import.

import { cacheEntryStale } from 'graphql-react';

import cacheEntryStale from 'graphql-react/public/cacheEntryStale.js';

Ways to require.

const { cacheEntryStale } = require('graphql-react');

const cacheEntryStale = require('graphql-react/public/cacheEntryStale.js');

function cachePrune

Prunes cache entries. Useful after a mutation.

Fires

• Cache event prune
• Cache event delete

Examples

Ways to import.

import { cachePrune } from 'graphql-react';

import cachePrune from 'graphql-react/public/cachePrune.js';

Ways to require.

const { cachePrune } = require('graphql-react');

const cachePrune = require('graphql-react/public/cachePrune.js');

function cacheStale

Stales cache entries. Useful after a mutation.

Fires

• Cache event stale

Examples

Ways to import.

import { cacheStale } from 'graphql-react';

import cacheStale from 'graphql-react/public/cacheStale.js';

Ways to require.

const { cacheStale } = require('graphql-react');

const cacheStale = require('graphql-react/public/cacheStale.js');

function fetchGraphQL

Fetches a GraphQL operation, always resolving a GraphQL result suitable for use as a cache value, even if there are errors. Loading errors are added to the GraphQL result errors property, and have an extensions property containing client: true, along with code and sometimes error-specific properties:

Returns: Promise<GraphQLResult> — Resolves a result suitable for use as a cache value. Shouldn’t reject.

Examples

Ways to import.

import { fetchGraphQL } from 'graphql-react';

import fetchGraphQL from 'graphql-react/public/fetchGraphQL.js';

Ways to require.

const { fetchGraphQL } = require('graphql-react');

const fetchGraphQL = require('graphql-react/public/fetchGraphQL.js');

function fetchOptionsGraphQL

Creates default fetch options for a GraphQL operation. If the GraphQL operation contains files to upload, the options will be for a GraphQL multipart request, otherwise they will be for a regular GraphQL POST request.

This utility exists for user convenience and isn’t used directly by the graphql-react API. If there is no chance the GraphQL operation contains files, avoid using this utility for a smaller bundle size.

Returns: FetchOptions — fetch options.

Examples

Ways to import.

import { fetchOptionsGraphQL } from 'graphql-react';

import fetchOptionsGraphQL from 'graphql-react/public/fetchOptionsGraphQL.js';

Ways to require.

const { fetchOptionsGraphQL } = require('graphql-react');

const fetchOptionsGraphQL = require('graphql-react/public/fetchOptionsGraphQL.js');

function Provider

A React component to provide all the React context required to enable the entire graphql-react API:

• Hydration time stamp context
• Cache context
• Loading context

Returns: ReactNode — React virtual DOM node.

Examples

Ways to import.

import { Provider } from 'graphql-react';

import Provider from 'graphql-react/public/Provider.js';

Ways to require.

const { Provider } = require('graphql-react');

const Provider = require('graphql-react/public/Provider.js');

Provide a Cache instance for an app.

import { Cache, Provider } from 'graphql-react';
import React from 'react';

const cache = new Cache();

const App = ({ children }) => <Provider cache={cache}>{children}</Provider>;

function useAutoAbortLoad

A React hook to create a memoized loader from another, that automatically aborts previous loading that started via this hook when new loading starts via this hook, the hook arguments change, or the component unmounts.

Returns: Loader — Memoized function that starts the loading.

Examples

Ways to import.

import { useAutoAbortLoad } from 'graphql-react';

import useAutoAbortLoad from 'graphql-react/public/useAutoAbortLoad.js';

Ways to require.

const { useAutoAbortLoad } = require('graphql-react');

const useAutoAbortLoad = require('graphql-react/public/useAutoAbortLoad.js');

function useAutoLoad

A React hook to prevent a cache entry from being pruned while the component is mounted and automatically keep it loaded. Previous loading that started via this hook aborts when new loading starts via this hook, the hook arguments change, or the component unmounts.

Returns: Loader — Memoized loader created from the load argument, that automatically aborts the last loading when the memoized function changes or the component unmounts.

See

• useCacheEntryPrunePrevention, used by this hook.
• useAutoAbortLoad, used by this hook.
• useLoadOnMount, used by this hook.
• useLoadOnStale, used by this hook.
• useLoadOnDelete, used by this hook.
• useWaterfallLoad, often used alongside this hook for SSR loading.

Examples

Ways to import.

import { useAutoLoad } from 'graphql-react';

import useAutoLoad from 'graphql-react/public/useAutoLoad.js';

Ways to require.

const { useAutoLoad } = require('graphql-react');

const useAutoLoad = require('graphql-react/public/useAutoLoad.js');

function useCache

A React hook to get the cache context.

Returns: Cache — The cache.

Examples

Ways to import.

import { useCache } from 'graphql-react';

import useCache from 'graphql-react/public/useCache.js';

Ways to require.

const { useCache } = require('graphql-react');

const useCache = require('graphql-react/public/useCache.js');

function useCacheEntry

A React hook to get a cache value using its cache key.

Returns: CacheValue — Cache value, if present.

Examples

Ways to import.

import { useCacheEntry } from 'graphql-react';

import useCacheEntry from 'graphql-react/public/useCacheEntry.js';

Ways to require.

const { useCacheEntry } = require('graphql-react');

const useCacheEntry = require('graphql-react/public/useCacheEntry.js');

function useCacheEntryPrunePrevention

A React hook to prevent a cache entry from being pruned, by canceling the cache entry deletion for prune events with event.preventDefault().

Examples

Ways to import.

import { useCacheEntryPrunePrevention } from 'graphql-react';

import useCacheEntryPrunePrevention from 'graphql-react/public/useCacheEntryPrunePrevention.js';

Ways to require.

const { useCacheEntryPrunePrevention } = require('graphql-react');

const useCacheEntryPrunePrevention = require('graphql-react/public/useCacheEntryPrunePrevention.js');

function useLoadGraphQL

A React hook to get a function for loading a GraphQL operation.

Returns: LoadGraphQL — Loads a GraphQL operation.

Examples

Ways to import.

import { useLoadGraphQL } from 'graphql-react';

import useLoadGraphQL from 'graphql-react/public/useLoadGraphQL.js';

Ways to require.

const { useLoadGraphQL } = require('graphql-react');

const useLoadGraphQL = require('graphql-react/public/useLoadGraphQL.js');

function useLoading

A React hook to get the loading context.

Returns: Loading — Loading.

Examples

Ways to import.

import { useLoading } from 'graphql-react';

import useLoading from 'graphql-react/public/useLoading.js';

Ways to require.

const { useLoading } = require('graphql-react');

const useLoading = require('graphql-react/public/useLoading.js');

function useLoadingEntry

A React hook to get the loading cache values for a given cache key.

Returns: Set<LoadingCacheValue> | undefined — Loading cache values, if present.

Examples

Ways to import.

import { useLoadingEntry } from 'graphql-react';

import useLoadingEntry from 'graphql-react/public/useLoadingEntry.js';

Ways to require.

const { useLoadingEntry } = require('graphql-react');

const useLoadingEntry = require('graphql-react/public/useLoadingEntry.js');

function useLoadOnDelete

A React hook to load a cache entry after it’s deleted, if there isn’t loading for the cache key that started after.

Examples

Ways to import.

import { useLoadOnDelete } from 'graphql-react';

import useLoadOnDelete from 'graphql-react/public/useLoadOnDelete.js';

Ways to require.

const { useLoadOnDelete } = require('graphql-react');

const useLoadOnDelete = require('graphql-react/public/useLoadOnDelete.js');

function useLoadOnMount

A React hook to automatically load a cache entry after the component mounts or the cache context or any of the arguments change, except during the hydration time if the hydration time stamp context is populated and the cache entry is already populated.

Examples

Ways to import.

import { useLoadOnMount } from 'graphql-react';

import useLoadOnMount from 'graphql-react/public/useLoadOnMount.js';

Ways to require.

const { useLoadOnMount } = require('graphql-react');

const useLoadOnMount = require('graphql-react/public/useLoadOnMount.js');

function useLoadOnStale

A React hook to load a cache entry after becomes stale, if there isn’t loading for the cache key that started after.

Examples

Ways to import.

import { useLoadOnStale } from 'graphql-react';

import useLoadOnStale from 'graphql-react/public/useLoadOnStale.js';

Ways to require.

const { useLoadOnStale } = require('graphql-react');

const useLoadOnStale = require('graphql-react/public/useLoadOnStale.js');

function useWaterfallLoad

A React hook to load a cache entry if the waterfall render context is populated, i.e. when waterfall rendering for either a server side render or to preload components in a browser environment.

Returns: boolean — Did loading start. If so, it’s efficient for the component to return null since this render will be discarded anyway for a re-render onces the loading ends.

See

• useAutoLoad, often used alongside this hook.

Examples

Ways to import.

import { useWaterfallLoad } from 'graphql-react';

import useWaterfallLoad from 'graphql-react/public/useWaterfallLoad.js';

Ways to require.

const { useWaterfallLoad } = require('graphql-react');

const useWaterfallLoad = require('graphql-react/public/useWaterfallLoad.js');

member CacheContext

React context for a Cache instance.

Type: object

Examples

Ways to import.

import { CacheContext } from 'graphql-react';

import CacheContext from 'graphql-react/public/CacheContext.js';

Ways to require.

const { CacheContext } = require('graphql-react');

const CacheContext = require('graphql-react/public/CacheContext.js');

member HydrationTimeStampContext

React context for the client side hydration time stamp.

Type: object

Examples

Ways to import.

import { HydrationTimeStampContext } from 'graphql-react';

import HydrationTimeStampContext from 'graphql-react/public/HydrationTimeStampContext.js';

Ways to require.

const { HydrationTimeStampContext } = require('graphql-react');

const HydrationTimeStampContext = require('graphql-react/public/HydrationTimeStampContext.js');

member LoadingContext

React context for a Loading instance.

Type: object

Examples

Ways to import.

import { LoadingContext } from 'graphql-react';

import LoadingContext from 'graphql-react/public/LoadingContext.js';

Ways to require.

const { LoadingContext } = require('graphql-react');

const LoadingContext = require('graphql-react/public/LoadingContext.js');

constant HYDRATION_TIME_MS

Number of milliseconds after the first client render that’s considered the hydration time; during which the useAutoLoad React hook won’t load if the cache entry is already populated.

Type: number

Examples

Ways to import.

import { HYDRATION_TIME_MS } from 'graphql-react';

import HYDRATION_TIME_MS from 'graphql-react/public/HYDRATION_TIME_MS.js';

Ways to require.

const { HYDRATION_TIME_MS } = require('graphql-react');

const HYDRATION_TIME_MS = require('graphql-react/public/HYDRATION_TIME_MS.js');

type CacheKey

A unique key to access a cache value.

Type: string

type CacheKeyMatcher

Matches a cache key against a custom condition.

Type: Function

Returns: boolean — Does the cache key match the custom condition.

type CacheValue

A cache value. If server side rendering, it should be JSON serializable for client hydration. It should contain information about any errors that occurred during loading so they can be rendered, and if server side rendering, be hydrated on the client.

Type: *

type FetchOptions

fetch options, called init in official specs.

Type: object

See

• MDN fetch parameters docs.
• Polyfillable fetch options. Don’t use other options if fetch is polyfilled for Node.js or legacy browsers.

type GraphQLOperation

A GraphQL operation. Additional properties may be used; all are sent to the GraphQL server.

Type: object

type GraphQLResult

A GraphQL result.

Type: object

See

• GraphQL spec for a response.

type GraphQLResultError

A GraphQL result error; either created by the GraphQL server, or by whatever loaded the GraphQL on the client (e.g. fetchGraphQL).

Type: object

See

• GraphQL spec for response errors.

type HighResTimeStamp

Milliseconds since the performance time origin (when the current JavaScript environment started running).

Type: number

See

• MDN DOMHighResTimeStamp docs.

type Loader

Starts loading a cache value.

Type: Function

Returns: LoadingCacheValue — The loading cache value.

type LoadGraphQL

Loads a GraphQL operation, using the GraphQL fetcher.

Type: Loader

Returns: LoadingCacheValue — The loading cache value.

type ReactNode

A React virtual DOM node; anything that can be rendered.

Type: undefined | null | boolean | number | string | React.Element | Array<ReactNode>