react-nhost v2.0.4

WARNING: Depricated

This package is depricated for @nhost/react-auth and @nhost/react-apollo.

React Nhost

Make it easy to use Nhost with React.

• NhostAuthProvider - AuthProvider to check logged-in state.
• NhostApolloProvider - ApolloProvider preconfigured with authentication for GraphQL mutations, queries and subscriptions.

If a user is logged in, the Authorization header will be set with your JWT token for all GraphQL requests.

Install

npm install react-nhost @apollo/client graphql graphql-tag

@apollo/client is required for react-nhost to work. You will use @apollo/client for useQuery, useMutation, useSubscription.

Initiate

Create React App

Add NhostAuthProvider and NhostApolloProvider.

src/index.js

import React from "react";
import ReactDOM from "react-dom";
import { NhostAuthProvider, NhostApolloProvider } from "react-nhost";
import { auth } from "utils/nhost.js";
import App from "./App";

ReactDOM.render(
  <React.StrictMode>
    <NhostAuthProvider auth={auth}>
      <NhostApolloProvider
        auth={auth}
        gqlEndpoint={`https://hasura-xxx.nhost.app/v1/graphql`}
      >
        <App />
      </NhostApolloProvider>
    </NhostAuthProvider>
  </React.StrictMode>,
  document.getElementById("root")
);

src/utils/nhost.js

Learn more about auth and storage in the nhost-js-sdk repository.

import nhost from "nhost-js-sdk";

const config = {
  base_url: "https://backend-xxx.nhost.app",
};

nhost.initializeApp(config);

const auth = nhost.auth();
const storage = nhost.storage();

export { auth, storage };

Usage

GrahQL

import React from "react";
import { useQuery } from "@apollo/client";
import gql from "graphql-tag";

const GET_TODOS = gql`
  query {
    todos {
      id
      created_at
      name
      completed
    }
  }
`;

export function function App() {
  const { loading, data } = useQuery(GET_TODOS);

  if (loading) {
    return <div>Loading..</div>;
  }

  return (
    <div>
      <h1>in app</h1>
      {!data ? (
        "no data"
      ) : (
        <ul>
          {data.todos.map((todo) => {
            return <li key={todo.id}>{todo.name}</li>;
          })}
        </ul>
      )}
    </div>
  );
}

Auth

import React from "react";
import { useAuth } from "react-nhost";

export MyComponent() {
  const { signedIn } = useAuth();

  if (!signedIn) {
    return (
      <div>You are not signed in.</div>;
    );
  }

  return (
    <div>You are signed in 🎉!</div>
  );
}

NextJS

(coming soon)

Protected Route

React Router

src/components/privateroute.jsx

export function AuthGate({ children, ...rest }) {
  const { signedIn } = useAuth();

  if (signedIn === null) {
    return <div>Loading...</div>;
  }

  if (!signedIn) {
    return <Redirect to="/login" />;
  }

  // user is logged in
  return children;
}

Usage

import React from "react";
import { Switch, Route } from "react-router-dom";
import { AuthGate } from "components/auth-gate";

<Router>
  <Switch>
    /* Unprotected routes */
    <Route exact path="/register">
      <Register />
    </Route>
    <Route exact path="/login">
      <Login />
    </Route>
  </Switch>
  /* Protected routes */
  <AuthGate>
    <Switch>
      <Route exact path="/">
        <Dashboard />
      </Route>
      <Route exact path="/settings">
        <Settings />
      </Route>
    </Switch>
  </AuthGate>
</Router>;

NextJS

components/privateroute.jsx

import { useAuth } from "react-nhost";

export function privateRoute(Component) {
  return () => {
    const { signedIn } = useAuth();

    // wait to see if the user is logged in or not.
    if (signedIn === null) {
      return <div>Checking auth...</div>;
    }

    if (!signedIn) {
      return <div>Login form or redirect to `/login`.</div>;
    }

    return <Component {...arguments} />;
  };
}

Usage

pages/dashboard.jsx

import React from "react";
import { protectRoute } from "components/privateroute.jsx";

function Dashboard(props) {
  return <div>My dashboard</div>;
}

export default privateRoute(Dashboard);

FAQ

Is nhost-js-sdk required?

No. You can use react-nhost without nhost-js-sdk.

How do I add headers to my GraphQL requests?

Use the headers prop.

Here is an example on how to add role = public to each request. This means you can only interact with data that is allowed using the role set as HASURA_GRAPHQL_UNAUTHORIZED_ROLE. (default to public at Nhost) Learn more about public access.

import React from "react";
import ReactDOM from "react-dom";
import { NhostApolloProvider } from "react-nhost";
import App from "./App";

ReactDOM.render(
  <React.StrictMode>
    <NhostApolloProvider
      gqlEndpoint={`https://hasura-xxx.nhost.app/v1/graphql`}
      headers={{
        role: "public",
      }}
    >
      <App />
    </NhostApolloProvider>
  </React.StrictMode>,
  document.getElementById("root")
);