TypeScript JavaScript Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.circleci try to setup junit reports for circle (#1802) Mar 17, 2018
.github [apollo-bot] Update the Templates with docs label (#1785) Mar 13, 2018
examples chore(deps): update dependency flow-bin to v0.68.0 Mar 16, 2018
scripts officially drop .mjs support [again] (#1801) Mar 17, 2018
src Fixed issue 1716 where Mutation updated state after unmounting. (#1799) Mar 17, 2018
test Fixed issue 1716 where Mutation updated state after unmounting. (#1799) Mar 17, 2018
typings Fix a lot of tests. Tweak graphql HoC types to accomodate more use cases Jan 30, 2018
.flowconfig Cleanup master for bundle size and flow (#1387) Dec 8, 2017
.gitignore Refactored internal implementations to drive HOCs by Components inste… Feb 26, 2018
.npmignore Package now consists of ES2015 and commonjs (#1576) Jan 25, 2018
.prettierignore clean up formatting and force it everywhere (#1698) Feb 22, 2018
CONTRIBUTING.md Browser (#1578) Jan 25, 2018
Changelog.md officially drop .mjs support [again] (#1801) Mar 17, 2018
LICENSE Intial build (#1) Apr 16, 2016
README.md Browser (#1578) Jan 25, 2018
ROADMAP.md clean up formatting and force it everywhere (#1698) Feb 22, 2018
dangerfile.ts clean up formatting and force it everywhere (#1698) Feb 22, 2018
jest.browser.umd.config.js Fix non esm imports (#1684) Feb 17, 2018
jest.cjs.config.js Fix non esm imports (#1684) Feb 17, 2018
jest.preact.config.json officially drop .mjs support [again] (#1801) Mar 17, 2018
jest.server.umd.config.js Fix non esm imports (#1684) Feb 17, 2018
package-lock.json try to setup junit reports for circle (#1802) Mar 17, 2018
package.json try to setup junit reports for circle (#1802) Mar 17, 2018
renovate.json chore(deps): Add timezone to Renovate config (#920) Aug 1, 2017
rollup.config.js fix bundlesize (#1650) Feb 17, 2018
tsconfig.json officially drop .mjs support [again] (#1801) Mar 17, 2018
tslint.json clean up formatting and force it everywhere (#1698) Feb 22, 2018


React Apollo npm version Get on Slack

React Apollo allows you to fetch data from your GraphQL server and use it in building complex and reactive UIs using the React framework. React Apollo may be used in any context that React may be used. In the browser, in React Native, or in Node.js when you want to do server-side rendering.

React Apollo unlike many other tools in the React ecosystem requires no complex build setup to get up and running. As long as you have a GraphQL server you can get started building out your application with React immediately. React Apollo works out of the box with both create-react-app and React Native with a single install and with no extra hassle configuring Babel or other JavaScript tools.

React Apollo is:

  1. Incrementally adoptable, so that you can drop it into an existing JavaScript app and start using GraphQL for just part of your UI.
  2. Universally compatible, so that Apollo works with any build setup, any GraphQL server, and any GraphQL schema.
  3. Simple to get started with, you can start loading data right away and learn about advanced features later.
  4. Inspectable and understandable, so that you can have great developer tools to understand exactly what is happening in your app.
  5. Built for interactive apps, so your users can make changes and see them reflected in the UI immediately.
  6. Small and flexible, so you don't get stuff you don't need. The core is under 25kb compressed.
  7. Community driven, Apollo is driven by the community and serves a variety of use cases. Everything is planned and developed in the open.

Get started today on the app you’ve been dreaming of, and let React Apollo take you to the moon!


It is simple to install React Apollo and related libraries.

# installing the preset package and react integration
npm install apollo-client-preset react-apollo graphql-tag graphql --save

# installing each piece independently
npm install apollo-client apollo-cache-inmemory apollo-link-http react-apollo graphql-tag graphql ---save

That’s it! You may now use React Apollo in any of your React environments.

For an amazing developer experience you may also install the Apollo Client Developer tools for Chrome which will give you inspectability into your React Apollo data.


Looking for apollo 1.x docs? See here.

To get started you will first want to create an instance of ApolloClient and then you will want to provide that client to your React component tree using the <ApolloProvider/> component. Finally, we will show you a basic example of connecting your GraphQL data to your React components with the graphql() enhancer function.

First we want an instance of ApolloClient. We can import the class from apollo-client. To get started, create an ApolloClient instance and point it at your GraphQL server:

import { ApolloClient } from 'apollo-client';
import { HttpLink } from 'apollo-link-http';
import { InMemoryCache } from 'apollo-cache-inmemory';

const client = new ApolloClient({
  // By default, this client will send queries to the
  //  `/graphql` endpoint on the same host
  // Pass the configuration option { uri: YOUR_GRAPHQL_API_URL } to the `HttpLink` to connect
  // to a different host
  link: new HttpLink(),
  cache: new InMemoryCache(),

Migrating from 1.x? See the 2.0 migration guide.

Next you will want to add a <ApolloProvider/> component to the root of your React component tree. This component provides the React Apollo functionality to all the other components in the application without passing it explicitly. To use an <ApolloProvider/> with your newly constructed client see the following:

import { ApolloProvider } from 'react-apollo';

  <ApolloProvider client={client}>
    <MyRootComponent />

Now you may create components in this React tree that are connected to your GraphQL API.

Finally, to demonstrate the power of React Apollo in building interactive UIs let us connect one of your components to your GraphQL server using the graphql() component enhancer:

You'll need install graphql-tag to use gql module:

npm install graphql-tag --save
import { graphql } from 'react-apollo';
import gql from 'graphql-tag';

function TodoApp({ data: { todos, refetch } }) {
  return (
      <button onClick={() => refetch()}>Refresh</button>
      <ul>{todos && todos.map(todo => <li key={todo.id}>{todo.text}</li>)}</ul>

export default graphql(gql`
  query TodoAppQuery {
    todos {

With that your <TodoApp/> component is now connected to your GraphQL API. Whenever some other component modifies the data in your cache, this component will automatically be updated with the new data.

To learn more about querying with React Apollo be sure to start reading the documentation article on Queries. If you would like to see all of the features React Apollo supports be sure to check out the complete API reference.

There is also an excellent Full-stack React + GraphQL Tutorial on the Apollo developer blog.


For a complete React Apollo API reference visit the documentation website at: http://dev.apollodata.com/react/api.html

All of the documentation for React Apollo including usage articles and helpful recipes lives on: http://dev.apollodata.com/react/