react-relay-local-query
Local queries for react-relay.
For querying local data without sending a request to the server (local state management).
Provides functionality (likely) found in the next build of relay:
https://github.com/facebook/relay/blob/master/packages/react-relay/ReactRelayLocalQueryRenderer.js.
Note that the Relay compiler still requires you to include a server schema field in the query.
Ideally, you would use a schema agnostic field, like an introspection field.
Installation
Using npm:
$ npm install react-relay-local-query
Using yarn:
$ yarn add react-relay-local-query
Then with a module bundler like webpack, use as you would anything else:
// Using ES6 Modules;// using CommonJS modulesconst useLocalQuery = useLocalQuery;const LocalQueryRenderer = LocalQueryRenderer;
Usage
This package contains two modules.
LocalQueryRenderer
and useLocalQuery
.
LocalQueryRenderer
is used just like a regular QueryRenderer.
// App.jsimport React from 'react';import LocalQueryRenderer from 'react-relay-local-query'; { return <LocalQueryRenderer = = = = /> ;}
useLocalQuery
is the hook implementation of LocalQueryRenderer
.
// App.jsimport React from 'react';import useLocalQuery from 'react-relay-local-query'; { const data = ; return <div>datasettingstitle</div>;}
Unlike QueryRenderer
and fetchQuery
, LocalQueryRenderer
and useLocalQuery
return a data snapshot on the initial render.
Credits
react-relay-local-query is built and maintained by babangsund.