Providers

CrossmintProvider — SDK initialization (required for all Crossmint features)
CrossmintCheckoutProvider — Checkout order state management

CrossmintProvider

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

Extension identifier, sent as x-extension-id header.

string

JWT token for authentication.

string

Override the base API URL.

Usage

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

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

CrossmintCheckoutProvider

Usage

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

function App() {
    return (
        <CrossmintProvider apiKey="YOUR_CLIENT_API_KEY">
            <CrossmintCheckoutProvider>
                {/* Your checkout components */}
            </CrossmintCheckoutProvider>
        </CrossmintProvider>
    );
}

Note: CrossmintCheckoutProvider must be nested inside CrossmintProvider.

Introduction

Hosted (pop-up)

Embedded

Headless (API)

Advanced Guides

API Reference

CrossmintProvider

Props

Usage

CrossmintCheckoutProvider

Usage

​CrossmintProvider

​Props

​Usage

​CrossmintCheckoutProvider

​Usage

CrossmintProvider

Props

Usage

CrossmintCheckoutProvider

Usage