​
Prerequisites

You must be using React Native v0.64 or higher.

​
Installation

First, install the Rownd SDK for React Native.

npm install @rownd/react-native

​
Expo

You can find specific Expo installation instructions here.

​
Android

  1. Ensure the Sdk versions match or are above provided versions. File: android/build.gradle
ext {
  ...
  minSdkVersion = 26
  compileSdkVersion = 32
  targetSdkVersion = 31
  ...
}
  1. Install the Rownd library and dependencies.
cd android && ./gradlew build

  1. Check and update your ProGuard config using the rules from our Android SDK.

  2. Only required for Google Sign-in: Add a Rownd plugin initializer to your MainActivity file. File: *android/app/src/main/java/…/MainActivity.java

import android.os.Bundle;
import com.reactnativerowndplugin.RowndPluginPackage;

public class MainActivity extends ReactActivity {
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    RowndPluginPackage.preInit(this);
  }
}

​
iOS

  1. Ensure iOS version is at least 14. File: ios/Podfile
platform: ios, "14.0";
  1. Install the Rownd pod and it’s dependencies
cd ios && pod install

​
Enable deep linking

Rownd supports automatically signing-in users when they initially install your app or when they click a sign-in link when the app is already installed.

Instructions for: iOS and Android

​
Usage

The Rownd SDK includes a context provider that will enable any component of your app to access authentication state and user data.

Before you can use the SDK, you'll need to obtain an App Key from the Rownd Dashboard.

import { RowndProvider } from "@rownd/react-native";

// ...

export default function Root() {
  return (
    <RowndProvider config={{
      appKey="<your app key>"
    }}>
      <App />
    </RowndProvider>
  );
}

Later on within your app's components, you can use the Rownd hook to access the Rownd browser API:

import { View, Text } from "react-native";
import { useRownd } from "@rownd/react";

export default function MyProtectedComponent(props) {
  const { is_authenticated, user, requestSignIn, getAccessToken } = useRownd();

  // You can also request a sign in without a user pressing a button
  // by calling requestSignIn() from a useEffect callback.
  // useEffect(() => {
  //   if (!is_authenticated) {
  //     requestSignIn();
  //   }
  // }, [is_authenticated]);

  return (
    <View>
      {is_authenticated ? (
        <>
          <h1>Welcome {user.data.first_name}</h1>
          <button onClick={() => getAccessToken()}>Get access token</button>
        </>
      ) : (
        <>
          <Text>Please sign in to continue</Text>
          <Pressable onPress={() => requestSignIn()}>
            <Text>Sign in</Text>
          </Pressable>
        </>
      )}
    </View>
  );
}

​
API reference

Most API methods are made available via the Rownd Provider and its associated useRownd React hook. Unless otherwise noted, we're assuming that you're using hooks.

requestSignIn()

Trigger the Rownd sign in dialog

PropertyTypeDescription
methodemail phone apple google passkeyRequests a sign-in, but with a specific authentication provider (e.g., Sign in with Apple). Rownd treats this information as a method. If the specified authentication provider is enabled within your Rownd app configuration, it will be honored. If not, Rownd will fall back to the default flow.
intentsign_in sign_upThis option applies only when you have opted to split the sign-up/sign-in flow via the Rownd dashboard. Valid values are sign_in or Sign_up. If you don’t set this value, the user will be presented with the unified sign-in/sign-up flow. Please reach out to support@rownd.io to enable.
postSignInRedirect (Not recommended)StringIf a subdomain is provided in the Rownd dashboard, this behavior will work by default. The URL to redirect to after the user has signed in. This can be used for deep-linking within the app or to ensure that the user is redirected back into the app after completing a sign-in from email or text message.
const { requestSignIn } = useRownd();

requestSignIn({
  method: 'apple'
});

signOut()

Sign out the user and clear their profile, returning them to a completely unauthenticated state.

const { signOut } = useRownd();
signOut();

getAccessToken()

Retrieves the active, valid access token for the current user.

const { getAccessToken } = useRownd();

let accessToken = await getAccessToken();

is_authenticated

Indicates whether the current user is signed in or not.

const { is_authenticated } = useRownd();

return (
  <>
    {is_authenticated && <ProtectedRoute />}
    {!is_authenticated && <PublicRoute />}
  </>
);

access_token

Represents the current access token for the user.

const { access_token } = useRownd();

useEffect(() => {
    axios({
        method: 'post',
        url: '/api/sessions'
        headers: {
            authorization: `Bearer ${access_token}`
        }
    }).then(console.log);
}, [access_token]);

user

Represents information about the current user, specifically their profile information. In the example below, we use the existing data to display the current value of first_name in a form field, update a local copy of that data as the user changes it, and then save the changes to Rownd once the user submits the form.

const { user } = useRownd();

return (
    <form onSubmit={() => user.set(profile)}>
        <Text>First name</Text>
            <TextInput
                value={user?.data?.first_name}
                onChangeText={}
            />
        <Pressable onPress={}>Save</button>
    </form>
);

Merge data into the user profile

const { user } = useRownd();
user.set({
  first_name: "Alice",
  last_name: "Ranier",
});

Set a specific field in the user profile

const { user } = useRownd();
user.setValue("first_name", "Alice");