<script id='coframe-installation-script'>
  (function () {
    // Early exit for performance testing
    if (/cf_disable/.test(location.search)) return console.warn('[Coframe] Disabled via URL parameter');
  
    // Coframe config
    const config = {
      projectId: 'YOUR_PROJECT_ID',
      startTime: Date.now(),
      timeoutMs: 1000,
      currentUrl: window.location.href,
    };
  
    // Prevent duplicate installation
    const script_id = 'coframe-sdk-js';
    if (document.getElementById(script_id)) return console.warn('[Coframe] SDK already installed');
  
    // Coframe queue setup
    (window.CFQ = window.CFQ || []).push({ config });
  
    // Coframe antiflicker CSS
    const style = document.createElement('style');
    style.id = 'coframe-antiflicker';
    style.textContent =
      ':root { --cf-show: 0;}' +
      'body { opacity: var(--cf-show) !important; transition: opacity 0.2s ease; }'
    function hide() { document.head.appendChild(style); }
    function show() {
      document.documentElement.style.setProperty('--cf-show', '1');
      style.parentNode && style.parentNode.removeChild(style);
    }
    hide(); setTimeout(show, config.timeoutMs);
  
    // Coframe SDK JS
    var edgeUrl = new URL('https://edge.cofra.me/cf.js');
    edgeUrl.searchParams.set('config', encodeURIComponent(JSON.stringify(config)));
  
    const script = document.createElement('script');
    script.id = script_id;
    script.async = true;
    script.src = edgeUrl.toString();
    script.onerror = () => { show(); console.error('[Coframe] SDK failed to load'); };
    document.head.appendChild(script);
  })();
</script>

<script id='coframe-installation-script'>
  (function () {
    // Early exit for performance testing
    if (/cf_disable/.test(location.search)) return console.warn('[Coframe] Disabled via URL parameter');
  
    // Coframe config
    const config = {
      projectId: 'YOUR_PROJECT_ID',
      startTime: Date.now(),
      timeoutMs: 1000,
      currentUrl: window.location.href,
    };
  
    // Prevent duplicate installation
    const script_id = 'coframe-sdk-js';
    if (document.getElementById(script_id)) return console.warn('[Coframe] SDK already installed');
  
    // Coframe queue setup
    (window.CFQ = window.CFQ || []).push({ config });
  
    // Coframe antiflicker CSS
    const style = document.createElement('style');
    style.id = 'coframe-antiflicker';
    style.textContent =
      ':root { --cf-show: 0;}' +
      'body { opacity: var(--cf-show) !important; transition: opacity 0.2s ease; }'
    function hide() { document.head.appendChild(style); }
    function show() {
      document.documentElement.style.setProperty('--cf-show', '1');
      style.parentNode && style.parentNode.removeChild(style);
    }
    hide(); setTimeout(show, config.timeoutMs);
  
    // Coframe SDK JS
    var edgeUrl = new URL('https://edge.cofra.me/cf.js');
    edgeUrl.searchParams.set('config', encodeURIComponent(JSON.stringify(config)));
  
    const script = document.createElement('script');
    script.id = script_id;
    script.async = true;
    script.src = edgeUrl.toString();
    script.onerror = () => { show(); console.error('[Coframe] SDK failed to load'); };
    document.head.appendChild(script);
  })();
</script>

# JavaScript

Install the Coframe SDK on any website with a script tag

This guide is for any site where you can directly edit the HTML — a static site,
a CMS with a custom code block, a hand-rolled landing page, or any other
environment where you control the markup. If you are using a framework such as
Next.js or React, see the framework-specific guide for your environment. If you
are using Webflow, see the [Webflow guide](../docs/webflow.html).



[Video: Video: installing the script tag in the <head>, setting your project ID, and verifying in DevTools (65s, narrated)](assets/videos/fig08-install-javascript.mp4)
Watch: 65s — installing the script tag in the <head>, setting your project ID, and verifying in DevTools

## Where to install

Place the installation script in the `<head>` of every page you want Coframe to
optimize or track. The script must be added directly to the HTML — do not load
it through an async tag manager (such as Google Tag Manager). Because
anti-flicker is enabled, the script needs to run synchronously before the browser
renders the page body. Loading it asynchronously through a tag manager defeats
this and will cause a visible flash of unstyled content.


If your site has a shared layout or template that renders the `<head>`, that is
the right place to add the script so it appears on every relevant page
automatically.

## Installation script

Copy the script below and paste it into the `<head>` of your page. Replace
`YOUR_PROJECT_ID` with the project ID from your Coframe dashboard.


HTML



```html
<script id='coframe-installation-script'>
  (function () {
    // Early exit for performance testing
    if (/cf_disable/.test(location.search)) return console.warn('[Coframe] Disabled via URL parameter');
  
    // Coframe config
    const config = {
      projectId: 'YOUR_PROJECT_ID',
      startTime: Date.now(),
      timeoutMs: 1000,
      currentUrl: window.location.href,
    };
  
    // Prevent duplicate installation
    const script_id = 'coframe-sdk-js';
    if (document.getElementById(script_id)) return console.warn('[Coframe] SDK already installed');
  
    // Coframe queue setup
    (window.CFQ = window.CFQ || []).push({ config });
  
    // Coframe antiflicker CSS
    const style = document.createElement('style');
    style.id = 'coframe-antiflicker';
    style.textContent =
      ':root { --cf-show: 0;}' +
      'body { opacity: var(--cf-show) !important; transition: opacity 0.2s ease; }'
    function hide() { document.head.appendChild(style); }
    function show() {
      document.documentElement.style.setProperty('--cf-show', '1');
      style.parentNode && style.parentNode.removeChild(style);
    }
    hide(); setTimeout(show, config.timeoutMs);
  
    // Coframe SDK JS
    var edgeUrl = new URL('https://edge.cofra.me/cf.js');
    edgeUrl.searchParams.set('config', encodeURIComponent(JSON.stringify(config)));
  
    const script = document.createElement('script');
    script.id = script_id;
    script.async = true;
    script.src = edgeUrl.toString();
    script.onerror = () => { show(); console.error('[Coframe] SDK failed to load'); };
    document.head.appendChild(script);
  })();
</script>
```

## Verify it is working

After adding the script and loading the page in a browser:



- Open the browser console and confirm there are no `[Coframe]` error messages.


- In the Network tab, look for a request to `edge.cofra.me/cf.js`. A successful
`200` response means the SDK loaded correctly.


- Check that a `coframe-sdk-js` script element appears in the DOM (you can
inspect the `<head>` in the Elements panel).





For a full walkthrough of how to validate the integration and confirm that
Coframe is operating as expected, see
[Testing and Validation](../docs/testing-and-validation.html).

## Optional configuration

The default script is designed to work without additional configuration. Once the
SDK is installed, you can tune behavior using the following guides:



- [SDK options](../docs/sdk-options.html) — timeout, disable conditions,
and other core settings


- [Identity settings](../docs/identity-settings.html) — associate SDK
activity with a known user identity


- [Tracking settings](../docs/tracking-settings.html) — control which
events and page interactions Coframe records


- [Anti-flicker](../docs/anti-flicker.html) — understand how the anti-flicker
mechanism works and how to adjust it for your performance requirements