How to set up feature flags in Vue

Feature flags help you release features and conditionally show content. This tutorial shows you how integrate them in your Vue.js app using PostHog.

We'll create a basic Vue app, add PostHog, create a feature flag, and then implement the flag to control content in your app.

Create your Vue app

For this tutorial, we create a basic Vue 3 app. First, ensure Node.js is installed (version 18.0 or newer). Then install @vue/cli and create a new Vue app:

npm install -g @vue/cli
vue create vue-feature-flags

Make sure to select [Vue 3] babel, eslint as the Vue version.

Next, replace the code in src/App.vue with the following:

<template>
  <div id="app">
    <h1>This is our Vue.js feature flags tutorial</h1>
  </div>
</template>

<script>
export default {
  name: 'App'
}
</script>

Run npm run serve to start your app.

Adding PostHog

This tutorial shows how to integrate PostHog with Vue 3. If you're using Vue 2, see our Vue docs for how to integrate PostHog.

Since PostHog handles the management and evaluation of feature flags, we must set it up in our app. If you don't have a PostHog instance, you can sign up for free here.

Start by installing the posthog-js library to get access to the JavaScript Web SDK.

npm install posthog-js

Create a new plugin by creating a new folder in your base directory called plugins and then a new file posthog.js:

mkdir plugins
cd plugins 
touch posthog.js

Add the following code to your posthog.js file:

import posthog from "posthog-js";

export default {
  install(app) {
    app.config.globalProperties.$posthog = posthog.init(
      "<ph_project_api_key>",
      {
        api_host: "https://us.i.posthog.com",
      }
    );
  },
};

Replace <ph_project_api_key> and <ph_client_api_host> with your your PostHog API key and host. You can find these in your project settings.

Finally, activate your plugin in main.js:

import { createApp } from 'vue'
import App from './App.vue'
import posthogPlugin from '../plugins/posthog';

const app = createApp(App);
app.use(posthogPlugin);
app.mount('#app')

Once you’ve done this, reload your app. You should begin seeing events in the PostHog events explorer.

Creating a feature flag

With PostHog set up, your app is ready for feature flags. To create one, go to the feature flags tab in PostHog and click "New feature flag." Enter a flag key (like my-cool-flag), set the release condition to roll out to 100% of users, and press "Save."

You can customize your release conditions with rollout percentages, and user or group properties to fit your needs.

Implementing our flag code

Once created, we can add our feature flag to our app. We do this using the this.$posthog.onFeatureFlags callback.

In our example, we fetch our feature flag and update the text on the page based on its value:

<template>
  <div id="app">
    <h1>{{ titleText }}</h1>
  </div>
</template>

<script>
export default {
  name: 'App',
  data() {
    return {
      titleText: 'Waiting for feature flag'
    };
  },
  mounted() {
    const posthog = this.$posthog;
    posthog.onFeatureFlags(() => {
      if (posthog.isFeatureEnabled('my-cool-flag')) {
        this.titleText = 'Our flag is enabled!';
      } else {
        this.titleText = 'Our flag is disabled!';
      }
    });
  },
}
</script>

When you run your app now, you should see the updated text.

Bootstrapping feature flags

You may notice the text flickers when you load your app while PostHog makes a request to fetch the flag value. To prevent this and have your feature flags available immediately, you can initialize PostHog with precomputed flag values to use until it has a chance to fetch them. This is called bootstrapping.

To do this, use the bootstrap key in PostHog's initialization config and add feature flag values to it:

import posthog from "posthog-js";

export default {
  install(app) {
    app.config.globalProperties.$posthog = posthog.init(
      "<ph_project_api_key>",
      {
        api_host: "https://us.i.posthog.com",
        bootstrap: {
            featureFlags: {
                'my-cool-flag': true,
            },
        },
      }
    );
  },
};

Now when you reload your app, the flicker is gone.

To ensure you are bootstrapping PostHog with the correct flag values, we recommend fetching the flags values from your server alongside the page load request, and then passing them to your frontend. See our docs for more information on how to do this.

Further reading

• How to set up analytics in Vue
• How to set up A/B tests in Vue
• How to set up surveys in Vue