@graphql-codegen/typescript-react-apollo

What is @graphql-codegen/typescript-react-apollo?

@graphql-codegen/typescript-react-apollo is a plugin for GraphQL Code Generator that generates TypeScript typings and React Apollo components/hooks from your GraphQL queries and schemas. This helps in creating type-safe GraphQL operations in React applications.

What are @graphql-codegen/typescript-react-apollo's main functionalities?

Generate TypeScript Types

Generates TypeScript types for your GraphQL queries, ensuring type safety and autocompletion in your code editor.

/* GraphQL Query */
const GET_USER = gql`
  query GetUser($id: ID!) {
    user(id: $id) {
      id
      name
      email
    }
  }
`;

/* Generated TypeScript Types */
export type GetUserQuery = {
  user: {
    id: string;
    name: string;
    email: string;
  };
};

export type GetUserQueryVariables = {
  id: string;
};

Generate React Apollo Hooks

Generates custom React hooks for your GraphQL queries, making it easy to fetch data in your React components.

/* Generated React Apollo Hook */
import { useQuery } from '@apollo/client';
import { GetUserQuery, GetUserQueryVariables } from './generated/graphql';

const useGetUser = (variables: GetUserQueryVariables) => {
  return useQuery<GetUserQuery, GetUserQueryVariables>(GET_USER, { variables });
};

/* Usage in a React Component */
const UserComponent = ({ userId }) => {
  const { data, loading, error } = useGetUser({ id: userId });

  if (loading) return <p>Loading...</p>;
  if (error) return <p>Error: {error.message}</p>;

  return (
    <div>
      <h1>{data.user.name}</h1>
      <p>{data.user.email}</p>
    </div>
  );
};

Generate React Apollo Components

Generates React components for your GraphQL queries, providing a declarative way to fetch and display data.

/* Generated React Apollo Component */
import { Query } from '@apollo/client/react/components';
import { GetUserQuery, GetUserQueryVariables } from './generated/graphql';

const GetUserComponent = ({ variables }: { variables: GetUserQueryVariables }) => (
  <Query<GetUserQuery, GetUserQueryVariables> query={GET_USER} variables={variables}>
    {({ data, loading, error }) => {
      if (loading) return <p>Loading...</p>;
      if (error) return <p>Error: {error.message}</p>;

      return (
        <div>
          <h1>{data.user.name}</h1>
          <p>{data.user.email}</p>
        </div>
      );
    }}
  </Query>
);

Other packages similar to @graphql-codegen/typescript-react-apollo

graphql-codegen-typescript

graphql-codegen-typescript is a plugin for GraphQL Code Generator that generates TypeScript typings for your GraphQL operations. It focuses on generating type-safe TypeScript code but does not provide React-specific hooks or components like @graphql-codegen/typescript-react-apollo.

apollo-client

apollo-client is a comprehensive state management library for JavaScript that enables you to manage both local and remote data with GraphQL. While it provides tools to work with GraphQL in React, it does not generate TypeScript types or React components/hooks automatically.

urql

urql is a highly customizable and versatile GraphQL client for React. It provides hooks and components for GraphQL operations but does not generate TypeScript types or React components/hooks automatically like @graphql-codegen/typescript-react-apollo.

README

The README file is missing