Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fanfare.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Configuration

This guide covers all configuration options for the Fanfare SDK, including the provider setup, environment configuration, and advanced options.

​
Provider Configuration

​
React

Wrap your application with FanfareProvider at the root level: 
import { FanfareProvider } from "@fanfare/react";

function App() {
  return (
    <FanfareProvider organizationId="org_abc123" publishableKey="pk_live_xyz789">
      <YourApp />
    </FanfareProvider>
  );
}

​
SolidJS

For SolidJS, initialize the SDK first, then pass it to the provider: 
import { init } from "@fanfare/sdk";
import { FanfareProvider } from "@fanfare/solid";
import { createResource } from "solid-js";

function App() {
  const [sdk] = createResource(async () => {
    return await init({
      organizationId: "org_abc123",
      publishableKey: "pk_live_xyz789",
    });
  });

  return (
    <Show when={sdk()}>
      <FanfareProvider sdk={sdk()!}>
        <YourApp />
      </FanfareProvider>
    </Show>
  );
}

​
Vanilla JavaScript

For the core SDK without a framework, call init directly: 
import { init } from "@fanfare/sdk";

const fanfare = await init({
  organizationId: "org_abc123",
  publishableKey: "pk_live_xyz789",
});

​
Required Configuration

​
organizationId

Your Fanfare organization identifier. Find this in your Fanfare dashboard under Settings > API Keys. 
<FanfareProvider
  organizationId="org_abc123"
  // ...
>
Organization IDs always start with org_.

​
publishableKey

Your publishable API key for client-side use. This key is safe to include in your frontend code. 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
>
Publishable keys start with:
  • pk_live_ for production
  • pk_test_ for test/sandbox environments

​
Provider Options (React)

The React FanfareProvider accepts additional configuration options: 
interface FanfareProviderProps {
  // Required
  organizationId: string;
  publishableKey: string;

  // Session behavior
  autoRestore?: boolean; // Default: true
  autoResume?: boolean; // Default: true

  // UI
  loadingComponent?: React.ReactNode;

  // Localization
  locale?: Locale;
  translations?: PartialTranslationMessages;

  // Advanced (passed to core SDK)
  environment?: "production" | "staging" | "development";
  apiUrl?: string;
  debug?: boolean;
  auth?: AuthConfig;
  logging?: LoggingConfig;
  sync?: SyncConfig;
  features?: FeaturesConfig;
  beacon?: BeaconConfig;
}

​
autoRestore

When true (default), the provider automatically restores any existing session from local storage when the component mounts. 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  autoRestore={true}
>
Disable this if you want manual control over session restoration: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  autoRestore={false}
>

​
autoResume

When true (default), the provider automatically resumes active operations (queue polling, auction watching) after restoring a session. 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  autoResume={true}
>

​
loadingComponent

A React node to display while the SDK initializes: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  loadingComponent={<LoadingSpinner />}
>
If not provided, the provider renders nothing during initialization.

​
locale

Set the locale for built-in widget text: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  locale="es"
>
Supported locales include: en, es, fr, de, it, pt, ja, ko, zh.

​
translations

Override or extend the default translations: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  translations={{
    "queue.enter": "Join the Line",
    "admitted.cta": "Go to Checkout",
    "queue.position": "Your spot: {{position}}",
  }}
>
This merges with the default translations for the current locale.

​
Core SDK Configuration

These options can be passed to FanfareProvider (React) or directly to init():

​
environment

Set the API environment: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_test_xyz789"
  environment="staging"
>
EnvironmentAPI URLUse Case
productionhttps://api.fanfare.ioLive traffic (default)
staginghttps://api-staging.fanfare.ioPre-release testing
developmenthttp://localhost:4802Local development

​
apiUrl

Override the API URL directly (takes precedence over environment): 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_test_xyz789"
  apiUrl="https://api-custom.example.com"
>

​
debug

Enable debug logging to the console: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_test_xyz789"
  debug={true}
>
When enabled, the SDK logs:
  • Initialization steps
  • API requests and responses
  • State changes
  • Event emissions

​
auth

Configure authentication behavior: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  auth={{
    persistSession: true,     // Store session in localStorage (default: true)
    sessionDuration: 3600,    // Session duration in seconds (default: 3600)
  }}
>

​
logging

Configure logging behavior: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  logging={{
    level: "info",  // "error" | "warn" | "info" | "debug" | "metrics"
  }}
>
Default log level is error.

​
sync

Configure multi-tab synchronization: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  sync={{
    enabled: true,
    syncKeys: ["session", "activeQueues", "activeDraws"],
    channelName: "fanfare-sdk-sync",
  }}
>
Or disable sync entirely: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  sync={false}
>
Multi-tab sync ensures that:
  • Session state is shared across tabs
  • Queue positions update in all tabs
  • Admission in one tab notifies other tabs

​
features

Enable or disable optional features: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  features={{
    fingerprinting: true,  // Browser fingerprinting (default: true)
  }}
>
Browser fingerprinting helps identify returning visitors and prevent abuse. Disable it if you have privacy concerns or regulatory requirements.

​
beacon

Configure analytics event tracking: 
<FanfareProvider
  organizationId="org_abc123"
  publishableKey="pk_live_xyz789"
  beacon={{
    enabled: true,
    batchSize: 10,
    flushInterval: 5000,
  }}
>

​
Environment Variables

Store your credentials in environment variables for security: 
# .env.local
NEXT_PUBLIC_FANFARE_ORG_ID=org_abc123
NEXT_PUBLIC_FANFARE_PUBLISHABLE_KEY=pk_live_xyz789
Then reference them in your code: 
<FanfareProvider
  organizationId={process.env.NEXT_PUBLIC_FANFARE_ORG_ID!}
  publishableKey={process.env.NEXT_PUBLIC_FANFARE_PUBLISHABLE_KEY!}
>

​
Framework-specific Environment Variables

FrameworkPrefixExample
Next.jsNEXT_PUBLIC_NEXT_PUBLIC_FANFARE_ORG_ID
ViteVITE_VITE_FANFARE_ORG_ID
Create React AppREACT_APP_REACT_APP_FANFARE_ORG_ID
AstroPUBLIC_PUBLIC_FANFARE_ORG_ID

​
Development vs Production

Use different credentials for development and production: 
const isDev = process.env.NODE_ENV === "development";

<FanfareProvider
  organizationId={process.env.NEXT_PUBLIC_FANFARE_ORG_ID!}
  publishableKey={
    isDev
      ? process.env.NEXT_PUBLIC_FANFARE_TEST_KEY!
      : process.env.NEXT_PUBLIC_FANFARE_LIVE_KEY!
  }
  environment={isDev ? "staging" : "production"}
  debug={isDev}
>

​
Complete Configuration Example

Here is a fully configured provider with all options: 
import { FanfareProvider } from "@fanfare/react";
import { LoadingSpinner } from "./components/loading-spinner";

function App() {
  return (
    <FanfareProvider
      // Required
      organizationId={process.env.NEXT_PUBLIC_FANFARE_ORG_ID!}
      publishableKey={process.env.NEXT_PUBLIC_FANFARE_PUBLISHABLE_KEY!}
      // Session behavior
      autoRestore={true}
      autoResume={true}
      // Loading state
      loadingComponent={<LoadingSpinner />}
      // Localization
      locale="en"
      translations={{
        "queue.enter": "Join the Waitlist",
      }}
      // Environment
      environment="production"
      debug={process.env.NODE_ENV === "development"}
      // Authentication
      auth={{
        persistSession: true,
        sessionDuration: 7200, // 2 hours
      }}
      // Logging
      logging={{
        level: process.env.NODE_ENV === "development" ? "debug" : "error",
      }}
      // Multi-tab sync
      sync={{
        enabled: true,
      }}
      // Features
      features={{
        fingerprinting: true,
      }}
      // Analytics
      beacon={{
        enabled: true,
        batchSize: 10,
        flushInterval: 5000,
      }}
    >
      <YourApp />
    </FanfareProvider>
  );
}

​
Accessing the SDK Directly

Sometimes you need direct access to the SDK instance. Use the useFanfare hook: 
import { useFanfare } from "@fanfare/react";

function MyComponent() {
  const fanfare = useFanfare();

  const handleCustomAction = async () => {
    // Access SDK methods directly
    const session = fanfare.auth.getSession();
    const active = await fanfare.getActiveExperiences();
    console.log("Session:", session);
    console.log("Active experiences:", active);
  };

  return <button onClick={handleCustomAction}>Check Status</button>;
}
The useFanfare hook returns the initialized FanfareSDK instance.

​
Next Steps