Skip to content
Start for free

Lucky Orange

Load Lucky Orange recordings and heatmaps only after visitors allow measurement. c15t sends the consent status through the Lucky Orange privacy API.

Inth keeps the consent record of each choice, with the visitor’s country and the policy that applied.

Start for free
pnpm add @c15t/integrations
Lucky OrangeWaiting for consent
Before a choice

No loader, LOQ, LO, cookie or storage entry appears. Allow only a different category and check again.

Turn the switch on, then off, to see what loads.

Before you start

You need an Inth project that connects to your app, c15t in that app and your Lucky Orange site ID. Turn on Require Consent in the Lucky Orange dashboard.

New to c15t? Complete the quickstart for your framework first. Keep its Inth endpoint, policy, styles and consent UI.

Open the quickstart for your framework

How consent gets to Lucky Orange

Before measurement has permission, the c15t luckyOrange helper creates no LOQ queue and loads nothing from Lucky Orange.

After permission, the helper adds a ready callback to window.LOQ and loads the script. When the privacy module is ready, it calls LO.privacy.setConsentStatus(true).

If the visitor withdraws before the callback, the helper sets the status to false. A late callback cannot give consent.

On withdrawal, the helper calls setConsentStatus(false). It does not call optOut(), which writes a two year opt-out cookie. c15t reloads the page by default.

Read the Lucky Orange privacy tools

Installation

Lucky Orange has one load mode in c15t. The helper waits for measurement permission.

Wait for permission. No request goes to Lucky Orange until the visitor accepts measurement. On withdrawal, the helper sets the consent status to false.

luckyOrange({ siteId })

An opt-out policy or no policy gives optional categories permission before a choice. Then Lucky Orange loads on the first page. This guide uses an opt-in policy.

Setup steps

  1. Install the integration package

    Add the helpers next to c15t. An import alone does not start Lucky Orange.

    pnpm add @c15t/integrations

  2. Add your site ID

    The helper puts the site ID in the loader URL. A proxy scriptUrl must keep lo.js in its path, because Lucky Orange finds the site ID from that file name.

    src/consent-scripts.ts
    import { luckyOrange } from '@c15t/integrations/lucky-orange';

export const scripts = [luckyOrange({ siteId: 'YOUR_SITE_ID' })];

    An empty site ID logs an error, and Lucky Orange does not load. Use category to pick a different consent category.

  3. Register it with your existing setup

    Add scripts to the c15t configuration that you have now. Keep your Inth endpoint, mode, policy, styles and consent UI.

    Add scripts to c15t.config.ts, next to next.config.ts. Keep the rest of your config, such as mode, in the same call. App Router, Pages Router and static export read the same file.

    c15t.config.ts
    import { defineConsentConfig } from 'c15t/next';
import { scripts } from './src/consent-scripts';

export default defineConsentConfig({ scripts });

    Pass scripts to the ConsentRoot in your root route. Import helpers in the route module, not in a server function: script configurations carry callbacks.

    src/routes/__root.tsx
    import { scripts } from '../consent-scripts';

<ConsentRoot state={consent} scripts={scripts}>

    Add scripts to the options of your ConsentProvider, next to mode. Keep the banner, dialog and preferences link inside the provider.

    src/consent.tsx
    import { scripts } from './consent-scripts';

<ConsentProvider options={{ mode, scripts }}>

    Register scripts under the c15t key in app.config.ts. Keep them out of nuxt.config.ts, which reaches the browser as JSON and drops the helper callbacks.

    app/app.config.ts
    import { scripts } from '../src/consent-scripts';

export default defineAppConfig({
  c15t: { scripts },
});

    Pass scripts to the c15tVue plugin call you have now. The plugin starts one script loader when the app mounts.

    src/main.ts
    import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
import { scripts } from './consent-scripts';

app.use(c15tVue, {
  mode: manifest(),
  scripts,
});

    Add scripts to the client entrypoint, which the integration finds on its own. Keep helpers out of astro.config.mjs: its options are serialized into the page.

    src/c15t.client.ts
    import type { C15tClientOptionsExtension } from 'c15t/astro';
import { scripts } from './consent-scripts';

export default { scripts } satisfies C15tClientOptionsExtension;

    Pass scripts as a prop to the ConsentProvider you have now. The provider owns the loader and disposes it on unmount.

    src/App.svelte
    <script lang="ts">
  import { ConsentProvider, manifest } from 'c15t/svelte';
  import { scripts } from './consent-scripts';
</script>

<ConsentProvider mode={manifest()} {scripts}>
  <!-- Your app and consent UI -->
</ConsentProvider>

    Add scripts to the ConsentRoot in the root layout. Import helpers in the layout component, not in +layout.server.ts: a server load cannot send functions to the browser.

    src/routes/+layout.svelte
    <script lang="ts">
  import { ConsentRoot } from 'c15t/svelte';
  import { scripts } from '../consent-scripts';

  let { children, data } = $props();
</script>

<ConsentRoot state={data.consent} {scripts}>
  {@render children()}
</ConsentRoot>

    Paste the vendor’s snippet behind consent

    The helpers need a bundler. On a page with the c15t script tag, paste the vendor’s own snippet instead and keep it inert until visitors allow its category. Helper options, such as loadMode, do not apply.

    index.html
    <script type="text/plain" data-c15t-category="measurement">
  // The vendor's snippet, unchanged
</script>

    Pass scripts to init() from @c15t/browser, next to your mode. With createConsentRuntime, pass scripts to it instead.

    src/consent.ts
    import { init, manifest } from '@c15t/browser';
import { scripts } from './consent-scripts';

const consent = init({
  mode: manifest(),
  scripts,
});
All frameworks

Delete the original Lucky Orange snippet and each tag manager copy, so Lucky Orange loads only through c15t. Keep reloadOnConsentRevoked on, because a script removal cannot unload recording code.

Verify your setup

Use a private window with an opt-in policy. Open DevTools Network and Application, and filter by luckyorange.com. Then test the three states.

  • Before a choice

    No loader, LOQ, LO, cookie or storage entry appears. Allow only a different category and check again.

  • After you allow measurement

    The loader runs. After the privacy module is ready, LO.privacy.getConsentStatus() returns true.

  • After you withdraw measurement

    Save your choice. c15t reloads the page, and Lucky Orange stays blocked.

A privacy initialization error from luckyOrange in the Console means that Lucky Orange did not get a consent status. The helper has no c15t tests with Do Not Track or an earlier Lucky Orange opt-out. Check both with your account.

Open the full Lucky Orange guide