Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zth/rescript-relay
Use Relay with ReScript.
https://github.com/zth/rescript-relay
graphql react reason-react reasonml relay relay-modern rescript rescript-react
Last synced: 13 days ago
JSON representation
Use Relay with ReScript.
- Host: GitHub
- URL: https://github.com/zth/rescript-relay
- Owner: zth
- Created: 2019-07-24T07:12:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T18:35:32.000Z (30 days ago)
- Last Synced: 2024-10-23T04:27:50.465Z (18 days ago)
- Topics: graphql, react, reason-react, reasonml, relay, relay-modern, rescript, rescript-react
- Language: ReScript
- Homepage: https://rescript-relay-documentation.vercel.app/docs/getting-started
- Size: 53.2 MB
- Stars: 339
- Watchers: 8
- Forks: 53
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-list - rescript-relay
README
# rescript-relay
Use Relay with ReScript.
[**Join our Discord**](https://discord.gg/wzj4EN8XDc)
## Getting started
> Are you using version `>= 0.13.0` and ReScript syntax with VSCode? Make sure you install our [dedicated VSCode extension](https://marketplace.visualstudio.com/items?itemName=GabrielNordeborn.vscode-rescript-relay). Note: It only works with ReScript syntax.
Check out the [documentation](https://rescript-relay-documentation.vercel.app).
Also, check out the [changelog](CHANGELOG.md) - 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)
}
```
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)
{React.string(userData.firstName ++ (" " ++ userData.lastName))}
{React.string(
userData.firstName ++ (" has " ++ (userData.friendCount->string_of_int ++ " friends.")),
)}
}
```
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
There's plenty of work ongoing to bring RescriptRelay to full ReScript v11 support, including uncurried mode. Here's the versioning scheme that'll be followed going forward:
- 1.x will receive critical bug fixes etc, but new features won't be added
- 2.x will focus on compatibility with ReScript v11, and uncurried mode (uncurried mode will be optional). This is intended to make the transition to v11+ smooth
- 3.x is fully embracing uncurried mode (no curried mode available), and adds a bunch of new stuff + change existing APIs to make them better and more ergonomic
## Examples
- A general example showcasing most available features: https://github.com/zth/rescript-relay/tree/master/example