Skip to main content

Recoil and GraphQL with Relay

The recoil-relay NPM library helps Recoil perform type safe and efficient queries using GraphQL with the Relay library. It provides selectors which can easily query with GraphQL. The queries are synced with the Recoil data-flow graph so downstream selectors can derive state from them, they can depend on upstream Recoil state, and they are automatically subscribed to any changes in the graph from Relay. Everything stays in sync automatically.

Example

After setting up your Relay environment adding a GraphQL query is as simple as defining a GraphQL selector.

const userNameQuery = graphQLSelector({
key: 'UserName',
environment: myEnvironment,
query: graphql`
query UserQuery($id: ID!) {
user(id: $id) {
name
}
}
`,
variables: ({get}) => ({id: get(currentIDAtom)}),
mapResponse: data => data.user?.name,
});

Then use it like any other Recoil selector:

function MyComponent() {
const userName = useRecoilValue(userNameQuery);
return <span>{userName}</span>;
}

Installation

Please see the Recoil installation guide for installing Recoil and the Relay documentation and step-by-step guide for installing and setting up the Relay library, GraphQL compiler, Babel plugin, and ESLint plugin. Then add recoil-relay as a dependency.