Basic usage


Make sure you've completed Getting Started first, ./gqless refers to the folder created there

Using GraphQL data within React components is straightforward.

  • Updates components when data changes
  • Suspends components whilst data is being fetched


First install @gqless/react into your project's dependencies:

yarn add @gqless/react


NOTE: Class components aren't supported

First, wrap components that are going to use GraphQL data inside graphql():

import { graphql } from '@gqless/react'
const Component = graphql(() => <div />)

Next, ensure the component is within a Suspense fallback. See here for more

import { Suspense } from 'react'
// For example, wrap the App component
const App = () => (
<Suspense fallback={<span>loading...</span>}>
<Component />

Now simply use data inside the component:

import { query } from './gqless'
const Component = graphql(() => <div>{query.hello}</div>)


Updating the cache when a button is pressed:

import { query } from './gqless'
import { graphql } from '@gqless/react'
const App = graphql(() => {
return (
<button onClick={() => (query.hello = 'Updates')}></button>
Last updated on by Sam Denty