Skip to main content

OpenFeature Angular SDK

SpecificationRelease
codecovNPM Download

Overview​

The OpenFeature Angular SDK adds Angular-specific functionality to the OpenFeature Web SDK.

In addition to the features provided by the web sdk, capabilities include:

Quick start​

Requirements​

  • ES2015-compatible web browser (Chrome, Edge, Firefox, etc)
  • Angular version 16+

Install​

npm​

npm install --save @openfeature/angular-sdk

yarn​

# yarn requires manual installation of the peer dependencies (see below)
yarn add @openfeature/angular-sdk @openfeature/web-sdk @openfeature/core

Required peer dependencies​

The following list contains the peer dependencies of @openfeature/angular-sdk. See the package.json for the required versions.

  • @openfeature/web-sdk
  • @angular/common
  • @angular/core

Usage​

Module​

To include the OpenFeature Angular directives in your application, you need to import the OpenFeatureModule and configure it using the forRoot method.

import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
import { OpenFeatureModule } from '@openfeature/angular-sdk';

@NgModule({
  declarations: [
    // Other components
  ],
  imports: [
    CommonModule,
    OpenFeatureModule.forRoot({
      provider: yourFeatureProvider,
      // domainBoundProviders are optional, mostly needed if more than one provider is needed
      domainBoundProviders: {
        domain1: new YourOpenFeatureProvider(),
        domain2: new YourOtherOpenFeatureProvider(),
      },
    })
  ],
})
export class AppModule {
}
Minimal Example​

You don't need to provide all the templates. Here's a minimal example using a boolean feature flag:

If initializing and reconciling are not given, the feature flag value that is returned by the provider will determine what will be rendered.

<div *booleanFeatureFlag="'isFeatureEnabled'; default: true">
  This is shown when the feature flag is enabled.
</div>

This example shows content when the feature flag isFeatureEnabled is true with a default value of true. No else, initializing, or reconciling templates are required in this case.

How to use​

The library provides four primary directives for feature flags, booleanFeatureFlag, numberFeatureFlag, stringFeatureFlag and objectFeatureFlag.

The first value given to the directive is the flag key that should be evaluated.

For all directives, the default value passed to OpenFeature has to be provided by the default parameter.

For all non-boolean directives, the value to compare the evaluation result to can be provided by the value parameter. This parameter is optional, if omitted, the thenTemplate will always be rendered.

The domain parameter is optional and will be used as domain when getting the OpenFeature provider.

The updateOnConfigurationChanged and updateOnContextChanged parameter are optional and used to disable the automatic re-rendering on flag value or context change. They are set to true by default.

The template referenced in else will be rendered if the evaluated feature flag is false for the booleanFeatureFlag directive and if the value does not match evaluated flag value for all other directives. This parameter is optional.

The template referenced in initializing and reconciling will be rendered if OpenFeature provider is in the corresponding states. This parameter is optional, if omitted, the then and else templates will be rendered according to the flag value.

Boolean Feature Flag​
<div
  *booleanFeatureFlag="'isFeatureEnabled'; default: true; domain: 'userDomain'; else: booleanFeatureElse; initializing: booleanFeatureInitializing; reconciling: booleanFeatureReconciling">
  This is shown when the feature flag is enabled.
</div>
<ng-template #booleanFeatureElse>
  This is shown when the feature flag is disabled.
</ng-template>
<ng-template #booleanFeatureInitializing>
  This is shown when the feature flag is initializing.
</ng-template>
<ng-template #booleanFeatureReconciling>
  This is shown when the feature flag is reconciling.
</ng-template>
Number Feature Flag​
<div
  *numberFeatureFlag="'discountRate'; value: 10; default: 5; domain: 'userDomain'; else: numberFeatureElse; initializing: numberFeatureInitializing; reconciling: numberFeatureReconciling">
  This is shown when the feature flag matches the specified discount rate.
</div>
<ng-template #numberFeatureElse>
  This is shown when the feature flag does not match the specified discount rate.
</ng-template>
<ng-template #numberFeatureInitializing>
  This is shown when the feature flag is initializing.
</ng-template>
<ng-template #numberFeatureReconciling>
  This is shown when the feature flag is reconciling.
</ng-template>
String Feature Flag​
<div
  *stringFeatureFlag="'themeColor'; value: 'dark'; default: 'light'; domain: 'userDomain'; else: stringFeatureElse; initializing: stringFeatureInitializing; reconciling: stringFeatureReconciling">
  This is shown when the feature flag matches the specified theme color.
</div>
<ng-template #stringFeatureElse>
  This is shown when the feature flag does not match the specified theme color.
</ng-template>
<ng-template #stringFeatureInitializing>
  This is shown when the feature flag is initializing.
</ng-template>
<ng-template #stringFeatureReconciling>
  This is shown when the feature flag is reconciling.
</ng-template>
Object Feature Flag​
<div
  *objectFeatureFlag="'userConfig'; value: { theme: 'dark' }; default: { theme: 'light' }; domain: 'userDomain'; else: objectFeatureElse; initializing: objectFeatureInitializing; reconciling: objectFeatureReconciling">
  This is shown when the feature flag matches the specified user configuration.
</div>
<ng-template #objectFeatureElse>
  This is shown when the feature flag does not match the specified user configuration.
</ng-template>
<ng-template #objectFeatureInitializing>
  This is shown when the feature flag is initializing.
</ng-template>
<ng-template #objectFeatureReconciling>
  This is shown when the feature flag is reconciling.
</ng-template>
Opting-out of automatic re-rendering​

By default, the directive re-renders when the flag value changes or the context changes.

In cases, this is not desired, re-rendering can be disabled for both events:

<div *booleanFeatureFlag="'isFeatureEnabled'; default: true; updateOnContextChanged: false; updateOnConfigurationChanged: false;">
  This is shown when the feature flag is enabled.
</div>
Consuming the evaluation details​

The evaluation details can be used when rendering the templates. The directives $implicit value will be bound to the flag value and additionally the value evaluationDetails will be bound to the whole evaluation details. They can be referenced in all templates.

The following example shows value being implicitly bound and details being bound to the evaluation details.

<div
  *stringFeatureFlag="'themeColor'; value: 'dark'; default: 'light'; else: stringFeatureElse; let value; let details = evaluationDetails">
  It was a match!
  The theme color is {{ value }} because of {{ details.reason }}
</div>
<ng-template #stringFeatureElse let-value let-details='evaluationDetails'>
  It was no match!
  The theme color is {{ value }} because of {{ details.reason }}
</ng-template>

When the expected flag value is omitted, the template will always be rendered. This can be used to just render the flag value or details without conditional rendering.

<div *stringFeatureFlag="'themeColor'; default: 'light'; let value;">
  The theme color is {{ value }}.
</div>

FAQ and troubleshooting​

I can import things form the @openfeature/angular-sdk, @openfeature/web-sdk, and @openfeature/core; which should I use?

The @openfeature/angular-sdk re-exports everything from its peers (@openfeature/web-sdk and @openfeature/core), and adds the Angular-specific features. You can import everything from the @openfeature/angular-sdk directly. Avoid importing anything from @openfeature/web-sdk or @openfeature/core.

Resources​