babel-plugin-react-relay

babel-plugin-react-relay

Babel plugin for Relay with support for multiple source types

How does this relate to babel-relay-plugin?

This package uses babel-relay-plugin internally but makes usage more convenient and extends its functionality. For example you no longer need to have a build/babelRelayPlugin.js script.

Install

$ npm install -D babel-plugin-react-relay

Configuration

Step 1: Add babel plugin

Add the following to your .babelrc file or the corresponding babel configuration.

{
	"plugins": ["react-relay"]
}

Step 2: Configure schema source

Add one of the following source options to your package.json file.

JSON

Imports a static GraphQL schema exported as a JSON file

{
  "react-relay-schema": "./exported-schema.json"
}

URL

You can also provide a URL to a schema endpoint. Use this method if you're using graph.cool.

{
  "react-relay-schema": "http://localhost:3000/schema.json"
}

Schema

graphql-js schema definition is also supported.

{
  "react-relay-schema": "./schema-definition.js"
}

Options

Environment Variables

Sometimes you need the flexibility to dynamically configure your GraphQL schema source via environment variables. You can easily do that using the following syntax (works for all source types):

{
  "react-relay-schema": {
	"env": "SCHEMA_ENDPOINT"
  }
}

This example uses the $SCHEMA_ENDPOINT environment variable.

License

MIT License

Help & Community

Join our Slack community if you run into issues or have questions. We love talking to you!