nextjs-plugin-graphql weekly downloads statistics

Next.js + GraphQL Documents

Next.js plugin for preprocessing GraphQL Documents (operations, fragments and SDL)

Installation

npm

pnpm

yarn

Usage

Create a next.config.js in your project

Optionally add Next.js configuration as a parameter

And now in your components you can import .graphql | .gql files

Options

graphqlOptions

The plugins supports all available options of graphql-tools webpack loader. Check out the documentation for the list of options.

Example with options:

Typescript

Typescript is unable to interpret imported graphql files, so nextjs-plugin-graphql includes definitions for graphql files (.graphql/.gql). Per the recommendations of the Next.js maintainers you should not reference these types in the next-env.d.ts file. You can instead create a typings directory inside your src directory. Then simple create a definitions file (ie: index.d.ts) and reference the definitions there. There shouldn't be any need to adjust your tsconfig.json for your project.

src/typings/index.d.ts

Contributors

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT

Description from the npm listing.