Skip to main content

Documentation Index

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

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

This guide covers how to install Userplane in a Remix application.

​
Adding the script

The fastest way to add Userplane is the CDN embed. Remix controls the full HTML document through the root route, so add these two tags to the <head> in app/root.tsx: 
// app/root.tsx
import { Links, Meta, Outlet, Scripts, ScrollRestoration } from '@remix-run/react';

export default function App() {
  return (
    <html lang="en">
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <Meta />
        <meta name="userplane:workspace" content="YOUR_WORKSPACE_ID" />
        <script type="module" src="https://cdn.userplane.io/embed/script.js" />
        <Links />
      </head>
      <body>
        <Outlet />
        <ScrollRestoration />
        <Scripts />
      </body>
    </html>
  );
}
Replace YOUR_WORKSPACE_ID with your workspace ID. You can copy the snippet with your ID pre-filled from Workspace Settings > Domains in the Userplane dashboard.

​
npm SDK

Use the npm SDK when you need programmatic control — triggering recordings from a button, attaching user metadata, or reading recording state.

​
Installation

npm install @userplane/sdk

​
Initialization

Create a provider component that initializes the SDK and mount it in your root route. 
// app/components/UserplaneProvider.tsx
import { useEffect } from 'react';

export function UserplaneProvider({ children }: { children: React.ReactNode }) {
  useEffect(() => {
    import('@userplane/sdk').then(({ initialize }) => {
      initialize({
        workspaceId: window.ENV.USERPLANE_WORKSPACE_ID,
      });
    });
  }, []);

  return <>{children}</>;
}

// app/root.tsx
import { Links, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { json, type LoaderFunctionArgs } from '@remix-run/node';
import { UserplaneProvider } from './components/UserplaneProvider';

export async function loader({ request }: LoaderFunctionArgs) {
  return json({
    ENV: {
      USERPLANE_WORKSPACE_ID: process.env.USERPLANE_WORKSPACE_ID,
    },
  });
}

export default function App() {
  const data = useLoaderData<typeof loader>();

  return (
    <html lang="en">
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <Meta />
        <Links />
      </head>
      <body>
        <UserplaneProvider>
          <Outlet />
        </UserplaneProvider>
        <ScrollRestoration />
        <Scripts />
        <script
          dangerouslySetInnerHTML={{
            __html: `window.ENV = ${JSON.stringify(data.ENV)}`,
          }}
        />
      </body>
    </html>
  );
}
Remix does not use NEXT_PUBLIC_ or VITE_ prefixes for client-side environment variables. Instead, server-side env vars are passed to the client through a root loader that serializes them to window.ENV. The dangerouslySetInnerHTML script block above is the standard Remix pattern for this.

​
URL parameters

Remix loaders may redirect users before the SDK reads the userplane-token and userplane-action query parameters. If your app redirects unauthenticated users to a login page, preserve userplane- prefixed parameters through the redirect: 
// app/routes/dashboard.tsx
import { redirect, type LoaderFunctionArgs } from '@remix-run/node';

export async function loader({ request }: LoaderFunctionArgs) {
  const user = await getUser(request);

  if (!user) {
    const url = new URL(request.url);
    const loginUrl = new URL('/login', url.origin);

    for (const [key, value] of url.searchParams) {
      if (key.startsWith('userplane-')) {
        loginUrl.searchParams.set(key, value);
      }
    }

    return redirect(loginUrl.toString());
  }

  // ...
}
See Installation for the full list of parameters to preserve.

​
Sensitive data

Add data-userplane-blur to any element you want blurred in recordings. See Sensitive Data Redaction for the full reference.

​
Metadata

Call set() after initialize() to attach user context to recordings: 
// app/components/UserplaneProvider.tsx
import { useEffect } from 'react';

export function UserplaneProvider({ children }: { children: React.ReactNode }) {
  useEffect(() => {
    import('@userplane/sdk').then(({ initialize, set }) => {
      initialize({ workspaceId: window.ENV.USERPLANE_WORKSPACE_ID });
      set('environment', 'production');
    });
  }, []);

  return <>{children}</>;
}
See Metadata SDK for the full API.

​
SSR

@userplane/sdk is SSR-safe to import — it does not reference window or document at module evaluation time. The initialize() call must run client-side. Calling it inside useEffect guarantees it runs only in the browser.
ConcernSafe?Notes
Static import at top of a component fileYesModule is SSR-safe
Calling initialize() in useEffectYesRuns browser-only
Dynamic import('@userplane/sdk') in useEffectYesBundle-size optimization only
Calling initialize() in a loaderNoLoaders run on the server

​
Example app

A complete Remix example is available at github.com/userplanehq/userplane-sdk-examples/tree/main/examples/remix.
VariableDescription
USERPLANE_WORKSPACE_IDYour Userplane workspace ID
cd examples/remix && npm install && npm run dev