Back to Relay

useRelayEnvironment

website/versioned_docs/version-v14.0.0/api-reference/hooks/use-relay-environment.md

20.1.1639 B
Original Source

import DocsRating from '@site/src/core/DocsRating';

useRelayEnvironment

Hook used to access a Relay environment that was set by a RelayEnvironmentProvider:

js
const React = require('React');

const {useRelayEnvironment} = require('react-relay');

function MyComponent() {
  const environment = useRelayEnvironment();

  const handler = useCallback(() => {
    // For example, can be used to pass the environment to functions
    // that require a Relay environment.
    commitMutation(environment, ...);
  }, [environment])

  return (...);
}

module.exports = MyComponent;
<DocsRating />