Developer documentation
Coframe documentation.
Install Coframe, understand its runtime, validate performance, and interpret the data it produces.
Explore the documentation
67 articles · 28 video lessonsEvaluate Coframe, install the SDK, and verify your first integration.
Understand what Coframe experiments on, how visitors are identified, and how treatment groups are assigned.
Frames and TreatmentsThe core concepts behind how Coframe models and applies changesIdentity and SessionsHow Coframe identifies visitors and tracks sessions — first-party identity, custom tokens, and consentExperiment Assignment & IDsHow Coframe assigns visitors to experiments and variants, and what the treatmentsDataV2 callback returns
Follow the browser SDK from loading and initialization through targeting, rendering, tracking, and navigation.
Runtime OverviewWhat the Coframe SDK does at runtime — from install script to applied treatmentsRuntime WalkthroughAn eight-part narrated series explaining the browser SDK, with written guides organized by runtime stage.How Loading WorksThe sequence from page load to applied variants — install script, edge fetch, and anti-flickerBoot and ConfigEpisode 3: one config object on CFQ is the SDK's entire contract, and every option maps to one line of resolveConfig or resolveProject
View How Coframe WorksMeasure Core Web Vitals, understand anti-flicker, and validate impact.
LCP MonitoringMonitor Largest Contentful Paint and understand how Coframe's anti-flicker affects itCore Web VitalsHow Coframe interacts with LCP, CLS, and INP — and how to keep them healthyAnti-FlickerHow Coframe prevents a flash of original content while variants loadPerformance ValidationValidate Coframe's performance impact with a before/after comparison
Understand tracking events, experiment data, and reporting.
Data & Analytics OverviewHow Coframe collects experiment data and how it connects to your analytics stackEvents and TrackingThe events Coframe tracks — treatment impressions and conversions — and how they're deliveredExperiment AnalyticsHow to analyze Coframe experiment results using treatment data and holdout/baseline groups
Install Coframe in your framework, site builder, or storefront.
JavaScriptInstall the Coframe SDK on any website with a script tagReactInstall the Coframe SDK in a React app using a script tag and a lightweight componentNext.jsInstall the Coframe SDK in a Next.js app (App Router or Pages Router)ShopifyInstall Coframe in a Shopify theme, plus checkout tracking for Shopify Plus
View SDK IntegrationsSet up the app, verify your store, and understand tracking and consent.
Shopify AppThe Coframe app for Shopify: install from the App Store, connect the store, and Coframe serves the SDK, tracks checkouts and attributes orders without any theme codeSetupInstall the Coframe app from the Shopify App Store, connect the store, install the scripts and confirm it is live, with a migration step for stores that installed Coframe by handSettings and PermissionsThe anti-flicker setting on the app's Configuration tab, and what each permission the app asks for is used forVerify and TroubleshootProve the install on the storefront, run the integration check, and work through the five things that usually go wrong
View Shopify AppConnect treatment data to your analytics platform.
Google Tag ManagerSend Coframe treatments through Google Tag ManagerGoogle AnalyticsSend Coframe treatments to Google Analytics 4SegmentSend Coframe treatment events to Segment using a bulkCallbackV2 snippet.StatsigSend Coframe treatment events to Statsig using a bulkCallbackV2 snippet.
View Analytics IntegrationsConfigure SDK options, environments, identity, and tracking.
SDK OptionsThe complete Coframe configuration reference — antiflicker, analytics callback, feature flag control, cookie consent, cookieless, conversion events, tracking-only mode, and CSP nonceEnvironmentsHow to test Coframe changes safely without affecting live visitorsIdentity SettingsCookieless mode — provide your own visitor identity with setUserTokenTracking SettingsConversion events, tracking-only mode, and the analytics treatment callback
Create, evaluate, and roll out feature flags across browser and server.
Feature FlagsRelease toggles, multiple variants and remote config, decided at the Coframe Edge and read through the Coframe SDKCreating FlagsCreate and publish a release toggle, a multi-variant flag or a remote config in the dashboard, and issue server API keysBrowser and ReactRead public flags in the browser with @coframe/sdk/feature-flags and the React hooks in @coframe/sdk/reactServer and SSREvaluate public and private flags from your server with @coframe/sdk/server, or call the Edge endpoint from any language
View Feature FlagsLook up queue commands, configuration, runtime APIs, and delivery.
CFQ CommandsEvery window.CFQ command the Coframe SDK accepts — identity, consent, feature flags, conversions, and the treatment callbackConfig ReferenceThe complete CoframeConfig object — every field the install script can setThe Coframe Globalwindow.Coframe — runtime state, treatment data, and debug utilitiesPreview & DebuggingURL parameters and tools for previewing variants and debugging the SDK
View SDK ReferenceFind integration issues, verify data, and investigate performance.
Debug ChecklistA step-by-step checklist to diagnose a Coframe integration that isn't workingCommon Integration IssuesFrequent Coframe setup mistakes — and how to fix themMissing DataWhy Coframe events or conversions might not appear — and how to fix itData VerificationConfirm Coframe is assigning treatments and sending events correctly
View TroubleshootingReview changes and migration guidance.
How Coframe Works
11 articlesFollow the browser SDK from loading and initialization through targeting, rendering, tracking, and navigation.
Start here
See the complete runtime before exploring individual stages.
Load & initialize
Load the SDK, resolve configuration and identity, and understand caching.
03How Loading WorksThe sequence from page load to applied variants — install script, edge fetch, and anti-flicker04Boot and ConfigEpisode 3: one config object on CFQ is the SDK's entire contract, and every option maps to one line of resolveConfig or resolveProject05Identity and ConsentEpisode 2: the token is born in the browser, persisted for 400 days, and consent gates only what the SDK sends, never what it decides or renders06Caching and UpdatesHow Coframe SDK bundles are versioned and cached at the edge
Select & render
Match eligible experiments, assign a variant, and apply its changes.
07Frames, Audiences and LanesEpisode 4: before any coin flip, a filter stack decides which experiment a visitor can even enter: frames, conditions, audiences, lanes, and bots08Assignment and BucketingEpisode 1: who sees which variant is one hash of one token, computed in the browser and reproducible by anyone09Applying VariantsEpisode 7: a variant is a list of modifications applied to elements the SDK must first find, and every step has a named failure
Track & navigate
Record each pageview, deliver events, and handle client-side navigation.