@tryabby/angular

AbbyModule

The AbbyModule is an Angular module that provides a service and some directives to work with Abby. You can then use the AbbyService in your components or services to interact with the Abby platform. The AbbyFlag, AbbyTest and DevtoolsComponent directives can be used in your templates to show/hide content based on feature flags or AB tests.

Parameters

The AbbyModule.forRoot() method takes an object as a parameter. The object can contain the following properties:

| Name | Type | Required | Description | details | | ------------------ | -------- | :------: | ------------------------------------------------------- | --------------------- | | projectId | string | ✅ | The ID of your project in Abby | - | | apiUrl | string | | The URL of the Abby API. Defaults to the hosted version | - | | currentEnvironment | string | ✅ | The current environment of your application | link | | tests | object | | An object containing your defined A/B Tests | - | | flags | object | | An array containing your defined Feature Flags | - | | settings | object | | An object with additional settings for Abby | - |

properties

tests

The tests property is an object containing your defined A/B Tests. You probably want to use the Copy Button in your dashboard to copy the tests object. They keys of the object represent the names of your predefined A/B tests. The values are objects containing the following properties:

| Name | Type | Required | Description | | -------- | --------------- | :------: | ------------------------------------------------------- | | variants | Array<string> | ✅ | An array of strings containing the variants of the test |

flags

The flags property is an array containing your defined Feature Flags. You probably want to use the Copy Button in your dashboard to copy the flags array.

Example

abby.ts

export const abby = {
  // ..your config
  tests: {
    test: {
      variants: ["control", "variant-a", "variant-b"],
    },
    flags: { "test-flag": "Boolean" },
  },
};

@Injectable({
  providedIn: "root",
  useExisting: AbbyService,
})
export class Abby extends AbbyService<
  (typeof abby)["flags"][number],
  keyof (typeof abby)["tests"]
> {}

app.module.ts

import { AbbyModule } from "abby";
import { Abby, abby } from "./abby";

@NgModule({
  // your config
  imports: [
    // your imports
    AbbyModule.forRoot(abby),
  ],
  providers: [
    {
      provide: APP_INITIALIZER,
      useFactory: (abby: Abby) => () => abby.init(),
      deps: [Abby],
      multi: true,
    },
  ],
})
export class AppModule {}

settings

The settings property is an object containing additional settings for Abby. The following properties are available:

• flags.defaultValues: Allows you to set a general default value for each flag type. The keys of the object represent the types of the flags. The default value is the following:

  {
    "Boolean": false,
    "String": "",
    "Number": 0,
    "JSON": {}
  }

• flags.devOverrides: An object containing the values of feature flags in development mode. The keys of the object represent the names of the flags. The values need to be of the type of the flag. This means if your flag is a String flag, this needs to be a string.

AbbyService

• AbbyService is a angular service, which provides methods for getting

getVariant(testName: string)

Resolves the selected variant for a given test name.

Parameters

The name of the test, needs to be one of the defined tests.

Return Value

The variant of the test Type: string

getFeatureFlagValue(flagName: string)

Resolves the value of a feature flag by the flagname.

Parameters

The name of the test or flag, needs to be one of the defined flags.

Return Value

The value of the flag Type: boolean

onAct

A function to call when the user performs an action associated with the test Type: function

Directives

Test Directive

The AbbyTest is an Angular directive provided by @tryabby/angular package that enables conditional rendering of components based on the selected variant of an A/B test. It works in conjunction with the AbbyService and is used to wrap the HTML code to be conditionally rendered.

Parameters

• testName: The name of the test, needs to be one of the defined tests.
• variant: The name of the variant to compare with the selected variant of the test.

Example

<ng-container *abbyTest="{ testName: 'test-abtest', variant: 'variant-a' }">AAAAAA</ng-container>
<ng-container *abbyTest="{ testName: 'test-abtest', variant: 'variant-b' }">BBBBBB</ng-container>

Flag Directive

The AbbyFlag is an Angular directive provided by @tryabby/core package that enables conditional rendering of components based on the value of a feature flag. It works in conjunction with the AbbyService and is used to wrap the HTML code to be conditionally rendered.

Parameters

The name of the feature flag. The name can be prefixed with ! to invert the flag value.

Example

<div *featureFlag="'test-flag'"></div>

Devtool Component

The DevtoolsComponent is an Angular component provided by @tryabby/angular package that renders the Abby Devtools in your application. The component is used to wrap the HTML code that renders the Abby Devtools.

The DevtoolsComponent won't work with Server Side Rendering using Angular Universal.

Example

<abby-devtools></abby-devtools>