Skip to content

useFlag returns a plain reactive value; it isn’t tied to markup. You’ll often use it to decide what to render (see Show or hide UI for that, using the <FeatureFlag> component), but it’s just as much for deciding what to do: which function handles something, what limit to enforce, which calculation to run. This page covers the useFlag API itself, starting with the render case and then a pure-logic one.

<script lang="ts">
  import { useFlag } from '@nebulr-group/bridge-svelte/flags';

  const banner = useFlag('show_banner', false);
</script>

{#if banner.value}
  <div class="banner">New stuff!</div>
{/if}

useFlag(key, defaultValue, context?) returns { value, passed } backed by Svelte 5 runes:

| Field | Description | |-------|-------------| | value | The evaluated flag value, typed from your default (boolean | string | number | JSON object) | | passed | Whether a rule branch matched |

The result is reactive: when an admin changes the flag (or a live rule update arrives), value updates in place. The default is mandatory: it’s what your app gets when the flag isn’t configured or Bridge is unreachable. A flag call can never break your app.

All three arguments accept getter functions for reactive inputs:

<script lang="ts">
  const greeting = useFlag(
    () => `greeting_${locale}`,        // reactive key
    'Hello',
    () => ({ attributes: { locale } }) // reactive per-call context
  );
</script>

The same useFlag value works in a function body just as well as in a template. Nothing renders; it just changes which code path runs:

// pricing.svelte.ts
import { useFlag } from '@nebulr-group/bridge-svelte/flags';

const useV2Pricing = useFlag('pricing_engine_v2', false);
const maxUploads = useFlag('max_uploads', 10);

function calculateTotal(cart: CartItem[]): number {
  // Route to one implementation or the other, no UI involved.
  return useV2Pricing.value ? calculateTotalV2(cart) : calculateTotalV1(cart);
}

function canUploadMore(currentCount: number): boolean {
  // Gate an action with a value an admin can tune without a deploy.
  return currentCount < maxUploads.value;
}

Note the .svelte.ts extension: useFlag is built on Svelte 5 runes, so it’s only safe inside components or .svelte.ts / .svelte.js modules. In a plain .ts file, use flagStore (below) instead.

Both read the same live, reactive value as the rendering examples above. An admin ramping pricing_engine_v2 from 10% to 100%, or raising max_uploads from 10 to 25, takes effect immediately, with no code change on your side.

For code that prefers the Svelte store contract (e.g. usage outside .svelte files):

import { flagStore } from '@nebulr-group/bridge-svelte/flags';

const banner = flagStore('show_banner', false);
const unsubscribe = banner.subscribe(({ value, passed }) => {
  // re-runs on every live flag change
});

One API for boolean, string, number, and JSON flags; the type is inferred from the default:

const isDark = useFlag('dark_mode', false);
const cta    = useFlag('checkout_text', 'Submit');
const limit  = useFlag('max_uploads', 10);
const cfg    = useFlag('rate_limit', { window: 60, max: 100 });

A type mismatch (the flag’s value in Control Center, your admin dashboard at app.thebridge.dev, has a different type than your default suggests) returns the default and logs a warning.