Providers

CrossmintProvider — SDK initialization (required for all Crossmint features)
CrossmintAuthProvider — Authentication state, login/logout, and the auth flow

CrossmintProvider

Root provider for the Crossmint SDK. Must wrap your entire application. Initializes the SDK with your API key and sets up logging.

Props

string

required

Your Crossmint client-side API key.

string

Application identifier, sent as x-app-identifier header.

ConsoleLogLevel

Minimum log level for console output (or “silent” to suppress all output). Logs below this level will not be written to the console. Set to “silent” to completely suppress console output. Defaults to “debug” (all logs shown) for backward compatibility.

string

Override the base API URL.

Usage

import { CrossmintProvider } from "@crossmint/client-sdk-react-native-ui";

function App() {
    return (
        <CrossmintProvider apiKey="YOUR_CLIENT_API_KEY">
            {/* Your app content */}
        </CrossmintProvider>
    );
}

CrossmintAuthProvider

Provides Crossmint authentication to your React Native app: social login (OAuth) and session management. Exposes auth state via the useCrossmintAuth hook and stores auth material in secure device storage. Must be nested inside CrossmintProvider.

Props

string | string[]

Your app’s deep link scheme(s) (e.g. "myapp://"), used for OAuth redirects back into your app.

Custom title for the auth modal.

string

Custom route for logging out, for server-side session management.

Callback invoked when the user successfully logs in.

boolean

Whether to prefetch OAuth provider URLs when the provider mounts.

string

Custom route for refreshing the auth token, for server-side session management.

StorageProvider

Custom storage provider for auth material. Defaults to browser cookies on web and secure device storage on React Native.

Usage

import {
    CrossmintProvider,
    CrossmintAuthProvider,
} from "@crossmint/client-sdk-react-native-ui";

function App() {
    return (
        <CrossmintProvider apiKey="YOUR_CLIENT_API_KEY">
            <CrossmintAuthProvider appSchema="myapp://">
                {/* Your app content */}
            </CrossmintAuthProvider>
        </CrossmintProvider>
    );
}

Note: CrossmintAuthProvider must be nested inside CrossmintProvider. Set appSchema to your app’s deep link scheme so OAuth redirects return to your app.

Introduction

User Identity

User Authentication

API Reference

CrossmintProvider

Props

Usage

CrossmintAuthProvider

Props

Usage

​CrossmintProvider

​Props

​Usage

​CrossmintAuthProvider

​Props

​Usage

CrossmintProvider

Props

Usage

CrossmintAuthProvider

Props

Usage