Skip to main content

TypeScript React Apollo

Usage Requirements

In order to use this GraphQL Codegen plugin, please make sure that you have GraphQL operations (query / mutation / subscription and fragment) set as documents: ... in your codegen.yml.

Without loading your GraphQL operations (query, mutation, subscription and fragment), you won't see any change in the generated output.

This plugin generates React Apollo components and HOC with TypeScript typings.

It extends the basic TypeScript plugins: @graphql-codegen/typescript, @graphql-codegen/typescript-operations - and thus shares a similar configuration.

Installation

typescript-react-apollo plugin version
Using yarn
yarn add -D @graphql-codegen/typescript-react-apollo

API Reference

withComponent

type: boolean default: false

Customize the output by enabling/disabling the generated Component (deprecated since Apollo-Client v3). For more details: https://www.apollographql.com/docs/react/api/react/components/

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withComponent: true

withHOC

type: boolean default: false

Customize the output by enabling/disabling the HOC (deprecated since Apollo-Client v3). For more details: https://www.apollographql.com/docs/react/api/react/hoc/

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withHOC: true

withHooks

type: boolean default: true

Customized the output by enabling/disabling the generated React Hooks. For more details: https://www.apollographql.com/docs/react/api/react/hooks/

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withHooks: true

withMutationFn

type: boolean default: true

Customized the output by enabling/disabling the generated mutation function signature.

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withMutationFn: true

withRefetchFn

type: boolean default: false

Enable generating a function to be used with refetchQueries

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withRefetchFn: false

apolloReactCommonImportFrom

type: string default: @apollo/react-common

Customize the package where apollo-react common lib is loaded from.

apolloReactComponentsImportFrom

type: string default: @apollo/react-components

Customize the package where apollo-react component lib is loaded from.

apolloReactHocImportFrom

type: string default: @apollo/react-hoc

Customize the package where apollo-react HOC lib is loaded from.

apolloReactHooksImportFrom

type: string default: @apollo/react-hooks

Customize the package where apollo-react hooks lib is loaded from.

componentSuffix

type: string default: Component

You can specify a suffix that gets attached to the name of the generated component.

reactApolloVersion

type: number (values: 2, 3) default: 3

Sets the version of react-apollo. If you are using the old (deprecated) package of react-apollo, please set this configuration to 2. If you are using Apollo-Client v3, please set this to 3.

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
reactApolloVersion: 2

withResultType

type: boolean default: true

Customized the output by enabling/disabling the generated result type.

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withResultType: true

withMutationOptionsType

type: boolean default: true

Customized the output by enabling/disabling the generated mutation option type.

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
withMutationOptionsType: true

addDocBlocks

type: boolean default: true

Allows you to enable/disable the generation of docblocks in generated code. Some IDE's (like VSCode) add extra inline information with docblocks, you can disable this feature if your preferred IDE does not.

Usage Examples

generates:
path/to/file.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo
config:
addDocBlocks: true

defaultBaseOptions

type: object

noGraphQLTag

type: boolean default: false

Deprecated. Changes the documentMode to documentNode.

gqlImport

type: string default: graphql-tag#gql

Customize from which module will gql be imported from. This is useful if you want to use modules other than graphql-tag, e.g. graphql.macro.

Usage Examples

graphql.macro
config:
gqlImport: graphql.macro#gql
Gatsby
config:
gqlImport: gatsby#graphql

documentNodeImport

type: string default: graphql#DocumentNode

Customize from which module will DocumentNode be imported from. This is useful if you want to use modules other than graphql, e.g. @graphql-typed-document-node.

noExport

type: boolean default: false

Set this configuration to true if you wish to tell codegen to generate code with no export identifier.

dedupeOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to make sure to remove duplicate operation name suffix.

omitOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to disable auto add suffix of operation name, like Query, Mutation, Subscription, Fragment.

operationResultSuffix

type: string default: ``

Adds a suffix to generated operation result type names

documentVariablePrefix

type: string default: ``

Changes the GraphQL operations variables prefix.

documentVariableSuffix

type: string default: Document

Changes the GraphQL operations variables suffix.

fragmentVariablePrefix

type: string default: ``

Changes the GraphQL fragments variables prefix.

fragmentVariableSuffix

type: string default: FragmentDoc

Changes the GraphQL fragments variables suffix.

documentMode

type: DocumentMode default: graphQLTag

Declares how DocumentNode are created:

  • graphQLTag: graphql-tag or other modules (check gqlImport) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client
  • documentNode: document nodes will be generated as objects when we generate the templates.
  • documentNodeImportFragments: Similar to documentNode except it imports external fragments instead of embedding them.
  • external: document nodes are imported from an external file. To be used with importDocumentNodeExternallyFrom

Note that some plugins (like typescript-graphql-request) also supports string for this parameter.

optimizeDocumentNode

type: boolean default: true

If you are using documentNode: documentMode | documentNodeImportFragments, you can set this to true to apply document optimizations for your GraphQL document. This will remove all "loc" and "description" fields from the compiled document, and will remove all empty arrays (such as directives, arguments and variableDefinitions).

importOperationTypesFrom

type: string default: ``

This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using. This is useful if you wish to generate base types from typescript-operations plugin into a different file, and import it from there.

importDocumentNodeExternallyFrom

type: string default: ``

This config should be used if documentMode is external. This has 2 usage:

  • any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use graphql-tag in a separate file and export the generated document
  • 'near-operation-file': This is a special mode that is intended to be used with near-operation-file preset to import document nodes from those files. If these files are .graphql files, we make use of webpack loader.

Usage Examples

config:
documentMode: external
importDocumentNodeExternallyFrom: path/to/document-node-file
config:
documentMode: external
importDocumentNodeExternallyFrom: near-operation-file

pureMagicComment

type: boolean default: false

This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.

experimentalFragmentVariables

type: boolean default: false

If set to true, it will enable support for parsing variables on fragments.

scalars

type: ScalarsMap

Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type.

namingConvention

type: NamingConvention default: change-case-all#pascalCase

Allow you to override the naming convention of the output. You can either override all namings, or specify an object with specific custom naming convention per output. The format of the converter must be a valid module#method. Allowed values for specific output are: typeNames, enumValues. You can also use "keep" to keep all GraphQL names as-is. Additionally you can set transformUnderscore to true if you want to override the default behavior, which is to preserves underscores.

Available case functions in change-case-all are camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, lowerCase, localeLowerCase, lowerCaseFirst, spongeCase, titleCase, upperCase, localeUpperCase and upperCaseFirst See more

typesPrefix

type: string default: ``

Prefixes all the generated types.

Usage Examples

config:
typesPrefix: I

typesSuffix

type: string default: ``

Suffixes all the generated types.

Usage Examples

config:
typesSuffix: I

skipTypename

type: boolean default: false

Does not add __typename to the generated types, unless it was specified in the selection set.

Usage Examples

config:
skipTypename: true

nonOptionalTypename

type: boolean default: false

Automatically adds __typename field to the generated types, even when they are not specified in the selection set, and makes it non-optional

Usage Examples

config:
nonOptionalTypename: true

useTypeImports

type: boolean default: false

Will use import type {} rather than import {} when importing only types. This gives compatibility with TypeScript's "importsNotUsedAsValues": "error" option

Usage Example#

With React Hooks#

For the given input:

query Test {
feed {
id
commentCount
repository {
full_name
html_url
owner {
avatar_url
}
}
}
}

And the following configuration:

schema: YOUR_SCHEMA_HERE
documents: "./src/**/*.graphql"
generates:
./generated-types.ts:
plugins:
- typescript
- typescript-operations
- typescript-react-apollo

Codegen will pre-compile the GraphQL operation into a DocumentNode object, and generate a ready-to-use React Hook for each operation you have.

In you application code, you can import it from the generated file, and use the React Hook in your component code:

import { useTest } from './generated-types';
export const MyComponent: React.FC = () => {
const { data, error, loading } = useTest();
return (<div> ... </div>)
};

Generate Data Component#

Codegen also supports generating data Components (deprecated in @apollo/client v3), you can turn it on this way:

config:
withComponent: true

Generate HOC#

Codegen also supports generating High-Order-Components (deprecated in @apollo/client v3), you can turn it on this way:

config:
withHOC: true