Nuxt GrowthBook

Nuxt GrowthBook integration module.

• ✨  Release Notes
• 🏀 Online playground

Quick Setup

1. Add nuxt-growthbook dependency to your project

# Using pnpm
pnpm add -D nuxt-growthbook

# Using yarn
yarn add --dev nuxt-growthbook

# Using npm
npm install --save-dev nuxt-growthbook

2. Add nuxt-growthbook to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ['nuxt-growthbook']
})

3. Set client key in nuxt.config.ts or .env file

export default defineNuxtConfig({
  modules: ['nuxt-growthbook'],
  growthbook: {
    clientKey: 'YOUR_CLIENT_KEY'
  }
})

GROWTHBOOK_CLIENT_KEY=YOUR_CLIENT_KEY

4. You can now use GrowthBook in your Nuxt app ✨

<script setup>
const gb = useGrowthbook();
const bannerEnabled = gb.isOn("banner_enabled");
</script>

5. Optional: Enable real-time streaming updates

export default defineNuxtConfig({
  modules: ['nuxt-growthbook'],
  growthbook: {
    clientKey: 'YOUR_CLIENT_KEY',
    streaming: true
  }
})

<script setup lang="ts">
import { ref } from 'vue'
const gb = useGrowthbook()
const bannerEnabled = ref(gb.isOn('banner_enabled'))

gb.setRenderer(() => {
  bannerEnabled.value = gb.isOn('banner_enabled')
})
</script>

<template>
  <div v-if="bannerEnabled">BANNER</div>
</template>

Server-side Integration

You can also use GrowthBook in your server-side routes or middleware. For example, in a Nitro API route:

// server/api/feature.ts
export default defineEventHandler(async (event) => {
  const growthbook = await useGrowthbook()
  const featureEnabled = growthbook.isOn('my_feature_flag')
  return { featureEnabled }
})

Streaming updates are only supported on the client; server-side calls fetch the latest flags on each request.

Configuration

The GrowthBook module accepts the following configuration options in your nuxt.config.ts or via environment variables:

| Option | Type | Description | Default | |----------------|---------|-------------------------------------------------------------------|---------------------------------------| | apiHost | string | The host URL of the GrowthBook API. | https://cdn.growthbook.io | | clientKey | string | Your GrowthBook Client Key (can also be set via GROWTHBOOK_CLIENT_KEY). | (required) | | enableDevMode| boolean | Enables integration with GrowthBook DevTools in development. | nuxt.options.dev | | streaming | boolean | Enables real-time streaming updates of feature definitions. | false |

You can also configure the module using environment variables:

• GROWTHBOOK_CLIENT_KEY: Sets the clientKey.
• GROWTHBOOK_API_HOST: Sets the apiHost.

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release