## 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 →**](https://www.apollographql.com/docs/react/get-started?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme)
## ❓ 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 →](https://www.apollographql.com/docs/react/get-started?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) | | **Full Documentation** | Comprehensive guides and examples | [Read Docs →](https://www.apollographql.com/docs/react?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) | | **API Reference** | Complete API documentation | [Browse API →](https://www.apollographql.com/docs/react/api/apollo-client?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) | | **VS Code Extension** | Enhanced development experience | [Install Extension →](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo) | | **DevTools** | Debug your GraphQL apps | [Chrome](https://chrome.google.com/webstore/detail/apollo-client-devtools/jdkknkkbebbapilgoeccciglkfbmbnfm) \| [Firefox](https://addons.mozilla.org/en-US/firefox/addon/apollo-developer-tools/) | | **Free Course** | Learn GraphQL and Apollo Client | [Take Course →](https://odyssey.apollographql.com?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) | ## 💬 Get Support **Need help?** We're here for you: - [**Community Forum**](https://community.apollographql.com?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- Q\&A and discussions - [**GraphQL Discord**](https://discord.graphql.org) \- Real-time chat with the community ## 🧑‍🚀 About Apollo Deliver tomorrow's roadmap today with our comprehensive suite of API orchestration tools: - [**Apollo Client**](https://www.apollographql.com/docs/react?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- Type-safe apps with GraphQL-powered on-device caching ([React](https://www.apollographql.com/docs/react?utm_medium=github&utm_source=apollographql_apollo-client&utm_campaign=readme), [iOS](https://www.apollographql.com/docs/ios?utm_medium=github&utm_source=apollographql_apollo-client&utm_campaign=readme), [Kotlin](https://www.apollographql.com/docs/kotlin?utm_medium=github&utm_source=apollographql_apollo-client&utm_campaign=readme)) - [**Apollo Connectors**](https://www.apollographql.com/graphos/apollo-connectors?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- Compose all your GraphQL and REST APIs into one GraphQL endpoint - [**Apollo MCP Server**](https://www.apollographql.com/apollo-mcp-server?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- AI needs APIs. The fastest way to ship reliable AI experiences - [**Apollo Router**](https://www.apollographql.com/docs/router?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- Scale your APIs seamlessly with GraphQL Federation, Security, Auth, and more - [**GraphOS**](https://www.apollographql.com/graphos?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) \- Deploy, manage, govern, and explore your APIs ([start for free, no credit card needed](https://www.apollographql.com/pricing?utm_medium=github&utm_source=apollographql_apollo-client&utm_campaign=readme)) [**Explore the Complete Apollo Platform →**](https://www.apollographql.com/?utm_source=github&utm_medium=apollographql-_apollo-client&utm_campaign=readme) ## 🛠️ Maintained by | Name | Username | | ----------------- | ---------------------------------------------- | | Jeff Auriemma | [@bignimbus](https://github.com/bignimbus) | | Jerel Miller | [@jerelmiller](https://github.com/jerelmiller) | | Lenz Weber-Tronic | [@phryneas](https://github.com/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](./VERSIONING_POLICY.md). ## 🗺️ Roadmap We regularly update our [public roadmap](https://github.com/apollographql/apollo-client/blob/main/ROADMAP.md) 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](https://docs.google.com/forms/d/e/1FAIpQLSczNDXfJne3ZUOXjk9Ursm9JYvhTh1_nFTDfdq3XBAFWCzplQ/viewform?usp=pp_url&entry.1170701325=Apollo+Client&entry.204965213=Readme). 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**](https://apollosummit.dev/) Oct 6-8, 2026 • San Francisco _1000+ engineers, talks, workshops, and office hours_ [**View All Events →**](https://www.apollographql.com/events?utm_source=github&utm_medium=apollographql_apollo-client&utm_campaign=readme) ## 🏆 Contributing Thank you for your interest in submitting a Pull Request to Apollo Client! Read our [guidelines](https://github.com/apollographql/apollo-client/blob/main/CONTRIBUTING.md) first, and don't hesitate to get in touch. **New to open source?** Check out our [**Good First Issues**](https://github.com/apollographql/apollo-client/issues?q=is%3Aopen%20label%3A%22%3Abooks%3A%20good-first-issue%22) to get started. ## 🤝 Code of Conduct Please read our [Code of Conduct](https://community.apollographql.com/faq). 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](https://github.com/apollographql/apollo-client/blob/main/LICENSE). --- ## 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 ``` 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](https://www.apollographql.com/docs/). 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: - [Apollo Client](https://github.com/apollographql/apollo-client) - [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin) - [Apollo iOS](https://github.com/apollographql/apollo-ios) - [Apollo Server](https://github.com/apollographql/apollo-server) - [Apollo Router](https://github.com/apollographql/router) - [Apollo Federation](https://github.com/apollographql/federation) - [Rover CLI](https://github.com/apollographql/rover) To submit feedback about the documentation, please use the **Give Feedback** option at the bottom of documentation content pages.