rescript-relay

Use Relay with ReScript.

Join our Discord

Getting started

> Are you using version >= 0.13.0 and ReScript syntax with VSCode? Make sure you install our dedicated VSCode extension. Note: It only works with ReScript syntax.

Check out the documentation.

Also, check out the changelog - things will continue to change between versions (including breaking changes, although we'll try and keep them to a minimum) as we iterate and reach a stable version.

What it looks like

Your components define what data they need through %relay().

``rescript
/ Avatar.res /
module UserFragment = %relay(
fragment Avatar_user on User {
firstName
lastName
avatarUrl
}
)

@react.component
let make = (~user) => {
let userData = UserFragment.use(user)

className="avatar"
src=userData.avatarUrl
alt={
userData.firstName ++ " "
userData.lastName
}
/>
}

`

Fragments can include other fragments. This allows you to break your UI into encapsulated components defining their own data demands.

Hooks to use your fragments are autogenerated for you. The hook needs a _fragment reference_ from the GraphQL object where it was spread. Any object with one or more fragments spread on it will have a fragmentRefs prop on it, someObj.fragmentRefs. Pass that to the fragment hook.

Avatar_user is spread right on the fragment, so we pass userData.fragmentRefs to the component since we know it'll contain the fragment ref for Avatar_user that needs. The component then uses that to get its data.

`rescript
/ UserProfile.res /
module UserFragment = %relay(
fragment UserProfile_user on User {
firstName
lastName
friendCount
...Avatar_user
}
)

@react.component
let make = (~user) => {
let userData = UserFragment.use(user)

Finally, you make a query using %relay() and include the fragments needed to render the entire tree of components.

`rescript
/ Dashboard.res /
module Query = %relay(
query DashboardQuery {
me {
...UserProfile_user
}
}
)

@react.component
let make = () => {
let queryData = Query.use(~variables=(), ())

``

Note about versioning

RescriptRelay has moved through a few major lines with different ReScript baselines. Use the compatibility guide below to pick the right versions:

$3

| RescriptRelay | Required ReScript |
| ------------- | ----------------- |
| 4.x and newer | v12.x (or newer) |
| 3.x and below | v11.x (or older) |

Additional context on historical focus areas:

- 1.x will receive critical bug fixes etc, but new features won't be added
- 2.x focuses on compatibility with ReScript v11, and uncurried mode (uncurried mode can be optional). This is intended to make the transition to v11+ smooth
- 3.x fully embraces uncurried mode (no curried mode available), and adds a bunch of new stuff + changes existing APIs to make them better and more ergonomic
- 4.x focuses exclusively on ReScript v12+.

Examples

- A general example showcasing most available features: https://github.com/zth/rescript-relay/tree/master/example