React

​

Installation

npm install @runonatlas/react

npm install @runonatlas/react

pnpm add @runonatlas/react

yarn add @runonatlas/react

​

Initialization

To initialize your frontend application, you need to create a client provider component and wrap your application with it. Since Atlas needs to authenticate with your backend and verify that users are only accessing what they can, you will need to place it under your authentication provider.

It’s very important that you provide all the required props:

• getAuth: A function that returns the authentication token. This is only necessary if the authentication with the backend is done with tokens and headers (for example, Clerk).
• loginCallback: A function that is called whenever the user tries to do an action that requires authentication.
• userId: The ID of the user.
• userEmail: The email of the user. Optional.
• userName: The name of the user. Optional.
• isUserLoading: A boolean that indicates whether the user is still loading. Optional. Helps Atlas to avoid flickering when the user status changes.

You then need to wrap your application with the AtlasProvider, wherever you have the rest of your providers and under your authentication provider.

For example, with Clerk:

import { useAuth, useClerk, useUser } from "@clerk/clerk-react";
import { AtlasProvider } from "@runonatlas/react";
import { useCallback } from "react";

export function AtlasClientProvider({
  children,
}: {
  children: React.ReactNode;
}) {
  const { getToken, userId, isLoaded } = useAuth();
  const { user } = useUser();
  const { openSignIn } = useClerk();

  const loginCallback = useCallback(() => {
    openSignIn();
  }, [openSignIn]);

  return (
    <AtlasProvider
      getAuth={getToken}
      loginCallback={loginCallback}
      userEmail={user?.primaryEmailAddress?.emailAddress}
      userId={userId}
      userName={user?.fullName}
      isUserLoading={!isLoaded}
    >
      {children}
    </AtlasProvider>
  );
}

​

Use our Atlas widgets

You can use any of our Atlas widgets in your React application by importing them from @runonatlas/react.

​

PricingComponent Widget

The PricingComponent widget shows the plans in your Atlas pricing model and allows users to purhcase a subscription to a plan via Atlas’ in-line checkout.

IMPORTANT: The successUrl must be absolute. For example, /success is not valid, but https://your-app.com/success is valid.

import { PricingComponent } from "@runonatlas/react";

/**
 * IMPORTANT:
 * Replace the `successUrl` prop with values specific to your application.
 */
export default function PricingPage() {
  return (
    <PricingComponent
      // Where to redirect after successful checkout.
      successUrl={"https://your-app.com/customer-portal"}
    />
  );
}

​

CustomerPortalComponent Widget

The CustomerPortalComponent widget shows the current user what plan they are subscribed to, a history of their payments, and allows them to cancel or change their plan at any time.

IMPORTANT: The successUrl must be absolute. For example, /success is not valid, but https://your-app.com/success is valid.

import { CustomerPortalComponent } from "@runonatlas/react";

/**
 * IMPORTANT:
 * Replace the `successUrl` prop with values specific to your application.
 */
export default function CustomerPortalPage() {
  return (
    <CustomerPortalComponent
      // Where to redirect after successful checkout.
      successUrl={"https://your-app.com/customer-portal"}
    />
  );
}

​

Limit user access based on their subscriptions

You can prevent users from accessing restricted parts of your application based on their subscription. To do so, you can use our UI protection features.

​

UI Protection

​

Using hooks

You can use the useFeaturesAllowed hook to check if a user has access to a feature.

import { useFeaturesAllowed } from "@runonatlas/react";

export default function Home() {
  const { isAllowed } = useFeaturesAllowed(["feature-1", "feature-2"]);

  return (
    <div>
      Our system has determined that...
      {isAllowed ? "You have access to this feature!" : "You don't have access to this feature. Please upgrade your subscription!"}
    </div>
  );
}

​

Using components

You can use the FeatureProtect component to check if a user has access to a feature.

import { FeatureProtect } from "@runonatlas/react";

export default function Home() {
  return (
    <FeatureProtect
      disallowedFallback={<div>Oh, you don't have access to this cool feature. Upgrade now!</div>}
      features={["feature-1", "feature-2"]}
    >
      <div>Cool feature</div>
    </FeatureProtect>
  );
}

​

Limit-based features

Sometimes, just having a feature as enabled or disabled is not enough, and our pricing models require limits to be set. For example, 5 users per account, or 20GB of storage. Setting this up with Atlas is very easy. And, if at some point the limits change, you won’t need to change the code again!

​

Explanation in the UI

When using both the <FeatureProtect> component and the useFeaturesAllowed() hook, it will automatically check if the user has access to the features you are protecting AND if the limit has not been reached.

However, it is possible that you want to show your user why the access was denied! To to do this, we give you the reasons why the access was denied. For example, with the hook useFeaturesAllowed:

import { useFeaturesAllowed } from "@runonatlas/react";

export default function Home() {
  const { isAllowed, reasons } = useFeaturesAllowed(["feature-1", "feature-2"]);

  if (!isAllowed) {
    return (
      <div>
        Our system has determined that...
        {reasons.map((reason) => {
          if (reason.reason === "notIncluded") {
            return (
              <div key={reason.slug}>
                You need to upgrade your plan to access {reason.slug}
              </div>
            );
          }

          if (reason.reason === "limitReached") {
            return (
              <div key={reason.slug}>
                You have reached the limit for {reason.slug}. You currently have {reason.currentUsage}/{reason.limit}.
              </div>
            );
          }
        })}
      </div>
    );
  }

  return <div>Cool feature</div>;
}

In the <FeatureProtect> component, instead of directly providing the FallbackComponent, you can actually provide a function that returns the component to be rendered when the access is denied. For example:

import { FeatureProtect } from "@runonatlas/react";

export default function Home() {
  return (
    <FeatureProtect
      disallowedFallback={(reasons) => {
        return (
          <div>
            Our system has determined that...
            {reasons.map((reason) => {
              if (reason.reason === "notIncluded") {
                return (
                  <div key={reason.slug}>
                    You need to upgrade your plan to access {reason.slug}
                  </div>
                );
              }

              if (reason.reason === "limitReached") {
                return (
                  <div key={reason.slug}>
                    You have reached the limit for {reason.slug}. You currently have {reason.currentUsage}/{reason.limit}.
                  </div>
                );
              }
            })}
          </div>
        );
      }}
      features={["feature-1", "feature-2"]}
    >
      <div>Cool feature</div>
    </FeatureProtect>
  );
}