# angular-feature-flag

> This is an Angular service that provides simple configurable "feature flags" to disable or enable certain application features. This allows areas of code to be in code base on production, but hidden until the flag is activated globally. Until then flags c

Latest version **1.0.0** (published 2016-11-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install angular-feature-flag
pnpm add angular-feature-flag
yarn add angular-feature-flag
bun add angular-feature-flag
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-11-04 |
| First published | 2016-11-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Luke Grannis |
| Maintainers | mryarbles |
| Keywords | angular, feature-flag, ab-testing |

## Links

- npm: https://www.npmjs.com/package/angular-feature-flag
- Repository: https://github.com/mryarbles/angular-feature-flag
- Homepage: https://github.com/mryarbles/angular-feature-flag#readme
- Issues: https://github.com/mryarbles/angular-feature-flag/issues
- npm.io page: https://npm.io/package/angular-feature-flag

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.16.6
- [angular](https://npm.io/package/angular.md) ^1.5.8

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-11-04

## README

# angular-feature-flag

## import module and include it in your app

```
var app = angular.module("app", [
  require('angular-feature-flag')
]);
```

## configuring the provider

```
// configure flags
app.config(/*@ngInject*/function(FlagProvider){
  FlagProvider.updateConfig({
    prefix: "FLAG_", // You can alter the flag prefix that is used.
    flags: ["address", "broker", "rental", "turbo_terms"] // these are flags that are enabled globally.  So once a feature is complete you can add it flag here and it will be enabled.
  });
});
```

For each of use in templates,  you can add the service to the $rootScope
```
app.run( /*@ngInject*/ function(
  $rootScope,
  Flag
) {
  
  // add FlagService instance to rootscope for easy access in templates.
  $rootScope.flag = Flag;

});
```

Then in a template: 
```
<div ng-if="flag.isActive('feature')">Your feature will appear here if the flag is active</div>
```


## Enabling flags

While a feature is in development you can enable a feature by setting a local storage key to (Using the default configuration):
FLAG_[FEATURE_NAME_IN_CAPS]: true;
 
So if you set: FLAG_VALIDATION: true in local storage, you would test in your application with:
 ```
 Flag.isActive("validation");
 ```
 
 As stated above, you can also set a flag in your config block. Eventually, you'll want to clean up your conditional code, but to make a feature live, you just sent its flag in the flag array.
 
 ```
 app.config(/*@ngInject*/function(FlagProvider){
   FlagProvider.updateConfig({
     prefix: "FLAG_", // You can alter the flag prefix that is used.
     flags: ["address", "broker", "terms"] // these are flags that are enabled globally.  So once a feature is complete you can add it flag here and it will be enabled.
   });
 });
 ```
 
 ## Accessing the provider before bootstrap
 
 If you want to access the provider before the applications bootstrap, for instance to import ui-router configuration depending on a flag, your can access the provider like this:
 
 ```
 var Config = /*@ngInject*/ function (
     $stateProvider,
     FlagProvider
 ) {
 
   var Flag = FlagProvider.$get();
   var flagActive = Flag.isActive("comm");
   if(!flagActive) return false;
   
   $stateProvider
   .state(
   ...
   
module.exports = Config;
   
 ```

---
_Source: https://npm.io/package/angular-feature-flag · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._