Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crishellco/vue-unleash
A Vue plugin for the Unleash open-source feature flag platform
https://github.com/crishellco/vue-unleash
Last synced: about 1 month ago
JSON representation
A Vue plugin for the Unleash open-source feature flag platform
- Host: GitHub
- URL: https://github.com/crishellco/vue-unleash
- Owner: crishellco
- Archived: true
- Created: 2019-12-13T11:13:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T18:48:13.000Z (almost 2 years ago)
- Last Synced: 2024-01-08T08:50:52.714Z (5 months ago)
- Language: JavaScript
- Homepage: https://crishellco.github.io/vue-unleash/
- Size: 2.28 MB
- Stars: 15
- Watchers: 0
- Forks: 7
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Lists
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
- awesome-vue - vue-unleash - A Vue plugin for the [Unleash](https://unleash.github.io/) open-source feature flag platform (Components & Libraries / Integrations)
README
# Vue Unleash
[](https://codecov.io/gh/crishellco/vue-unleash)
[](https://codeclimate.com/github/crishellco/vue-unleash/maintainability)
A Vue plugin for [Unleash](https://unleash.github.io/).
Vue Unleash provides an integration for Vue and the Unleash open-source feature flag platform.
_This plugin requires that your project use Vuex_
## Install
```bash
yarn add -D vue-unleash
# or
npm i -D vue-unleash
```
```javascript
import Vue from 'vue';
import VueUnleash from 'vue-unleash';
import Vuex from 'vuex';
Vue.use(Vuex);
const store = new Vuex.Store({});
/**
* The 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: 'https://my-hosted-unleash.io',
// Optional, prefix to filter features by via the Unleash API
// https://unleash.github.io/docs/api/client/features
namePrefix: 'MyVueApp',
// Required
store,
// 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('vue-unleash.io');
}
}
});
```
## Component Usage
```javascript
```
## Store Usage
```javascript
export default {
mounted() {
// Get all features
console.log(this.$store.state.unleash.features);
// Get enabled state of all features
console.log(this.$store.state.unleash.enabledFeatures);
// Get weather initial loading is occurring
console.log(this.$store.state.unleash.loading);
// Re-fetch data
this.$store.dispatch('unleash/fetch');
}
};
```
## Scripts
```bash
yarn lint
```
```bash
yarn test
```
```bash
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
## License
[MIT](http://opensource.org/licenses/MIT)