apollo-client Documentation

The industry-leading GraphQL client for TypeScript, JavaScript, React, Vue, Angular, and more. Apollo Client delivers powerful caching, intuitive APIs, and...

19,812 stars TypeScript TypeScript 1 file Β· ~2,995 tokens #apollo-client#apollographql#graphql#graphql-client#typescript
RAW Doc

1. Project Overview & Quickstart (apollographql/apollo-client)

File: README.md

Apollo Client

The industry-leading GraphQL client for TypeScript, JavaScript, React, Vue, Angular, and more. Apollo Client delivers powerful caching, intuitive APIs, and comprehensive developer tools to accelerate your app development.

➑️ Get Started with Apollo Client β†’

❓ Why Choose Apollo Client?

βœ… Zero-config caching - Intelligent caching out of the box
βœ… Framework agnostic - Works with React, Vue, Angular, Svelte, and vanilla JavaScript
βœ… TypeScript-first - Full type safety and IntelliSense support
βœ… React 19 ready - Supports Suspense, RSC, Compiler, and more
βœ… Production-tested - Powers countless apps worldwide that serve millions of end users

πŸš€ Quick Start

sh
npm install @apollo/client graphql

Apollo Client Skill

Give your AI agent specialized Apollo Client knowledge and setup guidance:

sh
npx skills add apollographql/skills --skill apollo-client

πŸ’‘ Resources

Resource Description Link
Getting Started Guide Complete setup and first query Start Here β†’
Full Documentation Comprehensive guides and examples Read Docs β†’
API Reference Complete API documentation Browse API β†’
VS Code Extension Enhanced development experience Install Extension β†’
DevTools Debug your GraphQL apps Chrome | Firefox
Free Course Learn GraphQL and Apollo Client Take Course β†’

πŸ’¬ Get Support

Need help? We're here for you:

πŸ§‘β€πŸš€ About Apollo

Deliver tomorrow's roadmap today with our comprehensive suite of API orchestration tools:

Explore the Complete Apollo Platform β†’

πŸ› οΈ Maintained by

Name Username
Jeff Auriemma @bignimbus
Jerel Miller @jerelmiller
Lenz Weber-Tronic @phryneas

Versioning Policy

While Apollo Client follows SemVer, it might introduce changes like changing transpilation targets, updating dependencies or dropping support for older versions of dependencies in minor releases. For more details, see our Versioning Policy.

πŸ—ΊοΈ Roadmap

We regularly update our public roadmap with the status of our work-in-progress and upcoming features.

πŸ“£ Tell us what you think

β˜‘οΈ Apollo Client User Survey
What do you like best about Apollo Client? What needs to be improved? Please tell us by taking a one-minute survey. Your responses will help us understand Apollo Client usage and allow us to serve you better.

πŸ—“οΈ Events

Join these live events to meet other GraphQL users and learn more:

πŸŽͺ Apollo Summit 2026
Oct 6-8, 2026 β€’ San Francisco
1000+ engineers, talks, workshops, and office hours

View All Events β†’

πŸ† Contributing

Thank you for your interest in submitting a Pull Request to Apollo Client! Read our guidelines first, and don't hesitate to get in touch.

New to open source? Check out our Good First Issues to get started.

🀝 Code of Conduct

Please read our Code of Conduct. This applies to any space run by Apollo, including our GitHub repositories, the Apollo GraphOS Discord, the Apollo GraphQL Forum. The Code of Conduct reflects our commitment to making the Apollo Community a welcoming and safe space in which individuals can interact.

πŸͺͺ License

Source code in this repository is available under the terms of the MIT License. Read the full text here.


File: docs/source/api/react/components.mdx


title: 'Components' sidebar_title: 'Components (deprecated)'

import QueryOptions from '../../../shared/query-options.mdx';
import QueryResult from '../../../shared/query-result.mdx';
import MutationOptions from '../../../shared/mutation-options.mdx';
import MutationResult from '../../../shared/mutation-result.mdx';
import SubscriptionOptions from '../../../shared/subscription-options.mdx';
import SubscriptionResult from '../../../shared/subscription-result.mdx';

NOTE: React Apollo's render prop components are deprecated. They will continue to receive bug fixes until March 2020, after which they will no longer be maintained by Apollo.

Installation

text
npm install @apollo/react-components

`Query`

Props

The Query component accepts the following props. query is required.

Render prop function

The render prop function that you pass to the children prop of Query is called with an object (QueryResult) that has the following properties. This object contains your query result, plus some helpful functions for refetching, dynamic polling, and pagination.

`Mutation`

The Mutation component accepts the following props. Only mutation is required.

Render prop function

The render prop function that you pass to the children prop of Mutation is called with the mutate function and an object with the mutation result. The mutate function is how you trigger the mutation from your UI. The object contains your mutation result, plus loading and error state.

`Subscription`

Props

The Subscription component accepts the following props. Only subscription is required.

Render prop function

The render prop function that you pass to the children prop of Subscription is called with an object that has the following properties.

2. Official Technical Reference & Guides (apollographql/docs)

This repository contains an archived version of the documentation platform for the Apollo Documentation site. It is no longer actively maintained, and the content here may be outdated. The project has undergone significant updates, and the latest documentation platform is now maintained in a private repository.

To update documentation content for Apollo’s open-source and source-available SDKs and libraries, you can submit pull requests to the relevant repository:

To submit feedback about the documentation, please use the Give Feedback option at the bottom of documentation content pages.