Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/relay-tools/relay-hooks
Use Relay as React hooks
https://github.com/relay-tools/relay-hooks
graphql hooks react react-hooks refetch relay-hooks relay-modern ssr suspense usefragment usemutation usequery
Last synced: 2 days ago
JSON representation
Use Relay as React hooks
- Host: GitHub
- URL: https://github.com/relay-tools/relay-hooks
- Owner: relay-tools
- License: mit
- Created: 2019-05-18T14:51:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T08:57:56.000Z (5 months ago)
- Last Synced: 2024-11-04T15:05:42.102Z (6 days ago)
- Topics: graphql, hooks, react, react-hooks, refetch, relay-hooks, relay-modern, ssr, suspense, usefragment, usemutation, usequery
- Language: TypeScript
- Homepage: https://relay-tools.github.io/relay-hooks/docs/relay-hooks.html
- Size: 3.35 MB
- Stars: 542
- Watchers: 8
- Forks: 56
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - relay-hooks - tools | 458 | (TypeScript)
README
# relay-hooks
[](https://www.npmjs.com/package/relay-hooks)
[](https://www.npmjs.com/package/relay-hooks)
Use Relay as React hooks
## Installation
Install react-relay and relay-hooks using yarn or npm:
```
yarn add react-relay relay-hooks
```
## Contributing
* **Give a star** to the repository and **share it**, you will **help** the **project** and the **people** who will find it useful
* **Create issues**, your **questions** are a **valuable help**
* **PRs are welcome**, but it is always **better to open the issue first** so as to **help** me and other people **evaluating it**
* **Please sponsor me**
### relay-hooks
The initial purpose of the library was to provide the ability to use all react-relay HOCs as react hooks and to implement the store-or-network and store-only policies used by the [react-relay-offline](https://github.com/morrys/react-relay-offline) library to manage offline relay applications
After Relay's core team shared information about the the initial differences in the issue https://github.com/relay-tools/relay-hooks/issues/5, all the necessary changes were made in order to make relay-hooks as close as possible to their specifications.
* current differences with upcoming Relay Hooks in react-relay
* **useLazyLoadQuery**: returns a *single* data object with the query's data, and nothing else.
* **useFragment**: in relay-hooks it is called useSuspenseFragment
* what's more in relay-hooks
* **useQuery**: it is the same as `useLazyLoadQuery` but does not use suspense, it allows you to use hooks without having to migrate the application in concurrent mode and its return is the same as the QueryRenderer HOC
* **conditional useQuery & useLazyLoadQuery**: added `skip`: [Optional] If skip is true, the query will be skipped entirely
* **observe the execution of the query in the network in useQuery & useLazyLoadQuery**: added `onComplete`: [Optional] Function that will be called whenever the fetch request has completed
* why use relay-hooks?
It is a stable library and none of its dependencies are experimental and it allows you to immediately use react hooks with relay-runtime and it is designed for easy migration to react-relay hooks.
It is a light library and compatible with react-relay
## RelayEnvironmentProvider
Since queries with `useQuery` no longer set context, we will expose a new `RelayEnvironmentProvider` component that takes an `environment` and sets it in context;
variables will no longer be part of context.
A `RelayEnvironmentProvider` should be rendered once at the root of the app, and multiple useQuery's can be rendered under this environment provider.
```ts
import { RelayEnvironmentProvider } from 'relay-hooks';
ReactDOM.render(
,
rootElement,
);
```
## useQuery
`useQuery` does not take an environment as an argument. Instead, it reads the environment set in the context; this also implies that it does not set any React context.
In addition to `query` (first argument) and `variables` (second argument), `useQuery` accepts a third argument `options`.
**options**
`fetchPolicy`: determine whether it should use data cached in the Relay store and whether to send a network request. The options are:
* `store-or-network` (default): Reuse data cached in the store; if the whole query is cached, skip the network request
* `store-and-network`: Reuse data cached in the store; always send a network request.
* `network-only`: Don't reuse data cached in the store; always send a network request. (This is the default behavior of Relay's existing `QueryRenderer`.)
* `store-only`: Reuse data cached in the store; never send a network request.
`fetchKey`: [Optional] A fetchKey can be passed to force a refetch of the current query and variables when the component re-renders, even if the variables didn't change, or even if the component isn't remounted (similarly to how passing a different key to a React component will cause it to remount). If the fetchKey is different from the one used in the previous render, the current query and variables will be refetched.
`networkCacheConfig`: [Optional] Object containing cache config options for the network layer. Note the the network layer may contain an additional query response cache which will reuse network responses for identical queries. If you want to bypass this cache completely, pass {force: true} as the value for this option.
`skip`: [Optional] If skip is true, the query will be skipped entirely.
`onComplete`: [Optional] Function that will be called whenever the fetch request has completed
```ts
import { useQuery, graphql } from 'relay-hooks';
const query = graphql`
query appQuery($userId: String) {
user(id: $userId) {
...TodoApp_user
}
}
`;
const variables = {
userId: 'me',
};
const options = {
fetchPolicy: 'store-or-network', //default
networkCacheConfig: undefined,
}
const AppTodo = function (appProps) {
const {data, error, retry, isLoading} = useQuery(query, variables, options);
if (data && data.user) {
return ;
} else if (error) {
return
{error.message};
}
return loading;
}
```
## useLazyLoadQuery
same to useQuery
```ts
import * as React from 'react';
import { useQuery, graphql, RelayEnvironmentProvider } from 'relay-hooks';
const query = graphql`
query appQuery($userId: String) {
user(id: $userId) {
...TodoApp_user
}
}
`;
class ErrorBoundary extends React.Component {
state = { error: null };
componentDidCatch(error) {
this.setState({ error });
}
render() {
const { children, fallback } = this.props;
const { error } = this.state;
if (error) {
return React.createElement(fallback, { error });
}
return children;
}
}
const variables = {
userId: 'me',
};
const options = {
fetchPolicy: 'store-or-network', //default
networkCacheConfig: undefined,
}
const AppTodo = function (appProps) {
const {data} = useLazyLoadQuery(query, variables, options);
return ;
}
const App = (
`Error: ${error.message + ': ' + error.stack}`}>
loading suspense}>
);
```
## useFragment
[See useFragment.md](./docs/useFragment.md)
## useRefetchable
[See useRefetchable.md](./docs/useRefetchable.md)
## usePagination
[See usePagination.md](./docs/usePagination.md)
## useMutation
[See useMutation.md](./docs/useMutation.md)
## useSubscription
[See useSubscription.md](./docs/useSubscription.md)
## usePreloadedQuery
[See usePreloadedQuery.md](./docs/usePreloadedQuery.md)