graphql-hooks

graphql-hooks

🎣 Minimal hooks-first graphql client.

Features

• 🥇 First-class hooks API
• 🔥 No more render props hell
• ⚖️ Lightweight; only what you really need
• ️️♻️ Promise-based API (works with async / await)
• ⏳ Handle loading and error states with ease

Install

npm install graphql-hooks

or

yarn add graphql-hooks

Quick Start

First you'll need to create a client and wrap your app with the provider:

import { createClient, ClientContext } from 'graphql-hooks';

const client = createClient({
  endpoint: '/graphql'
});

function App() {
  return (
    <ClientContext.Provider value={client}>
      {/* children */}
    </ClientContext.Provider>
  );
}

Now in your child components you can make use of useQuery

import { useQuery } from 'graphql-hooks';

const HOMEPAGE_QUERY = `query HomePage($limit: Int) {
  users(limit: $limit) {
    id
    name
  }
}`;

function MyComponent() {
  const { loading, error, data } = useQuery(HOMEPAGE_QUERY, {
    variables: {
      limit: 10
    }
  });

  if (loading) return 'Loading...';
  if (error) return 'Something Bad Happened';

  return (
    <ul>
      {data.users.map(({ id, name }) => (
        <li key={id}>{name}</li>
      ))}
    </ul>
  );
}

TOC

• APIs
  • createClient
  • ClientContext
  • useClient
  • useQuery
  • useManualQuery
  • useMutation
• Guides
  • SSR
  • Authentication
  • Refetching a query
  • Fragments

API

createClient

ClientContext

useClient

useQuery

useManualQuery

useMutation

Guides

SSR

Authentication

Refetching a query

Fragments