Vue Unleash

A Vue plugin for Unleash.

Vue Unleash provides an integration for Vue and the Unleash open-source feature flag platform.

This plugin requires that your project use Vuex


yarn add -D vue-unleash
# or
npm i -D vue-unleash
import Vue from 'vue';
import VueUnleash from 'vue-unleash';
import Vuex from 'vuex';


const store = new Vuex.Store({});

 * The <unleash-feature /> component is registered
 * globally during installation.
Vue.use(VueUnleash, {
  // Optional, name of app
  appName: 'MyVueApp',

  // Optional, instance id of app
  instanceId: 'my-vue-app-1',

  // Required, Unleash instance host
  host: '',

  // Optional, prefix to filter features by via the Unleash API
  namePrefix: 'MyVueApp',

  // Required

  // Optional, providers to handle strategy logic
  strategyProviders: {
     * Example strategy provider
     * @param {object} parameters Strategy parameters object from Unleash API
     * @return {boolean} If enabled or not
    applicationHostname(parameters) {
      const { hostNames } = parameters;

      return hostNames.split(',').includes('');

Component Usage

  <unleash-feature name="MyVueApp.AddUser">
    <add-user-form />

Store Usage

export default {
  mounted() {
    // Get all features

    // Get enabled state of all features

    // Get weather initial loading is occurring

    // Re-fetch data


yarn lint
yarn test
yarn build

How to Contribute

Pull Requests

  1. Fork the repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the develop branch