@vivareal/ng-optimizely

Angular Optimizely Module

A simple wrapper to pull in the Optimizely snippet with an AngularJS-based application. This module provides only a simple API to download the Optimizely snippet onto the page. All of your tests should be coded and targeted within the Optimizely interface. The loadProject method(usage described below) returns a promise so you can delay execution until after the snippet has loaded.

Install

$ bower install --save ng-optimizely

Add ng-optimizely.js to your index.html file:

<!-- Angular optimizely -->
<script src="bower_components/ng-optimizely/ng-optimizely.js"></script>

Then require ng-optimizely in your application:

var app = angular.module('app', ['ng-optimizely']);

Config

In your app's run block execute the setKey method:

angular.module('app')
.config(['optimizelyProvider', function(optimizelyProvider) {
  optimizelyProvider.setKey('880950754');
}]);

Run

In your app's run block execute the loadProject method:

angular.module('app')
.run(['optimizely', function(optimizely) {
  optimizely.loadProject();
}]);

The ng-optimizely module will automatically run all relevant optimizely tests every time a new view comes up in the browser.

A better way to load the library and avoid a FOUC is to use a router like ui-router that allows you to defer pageload until after all of a given route's dependencies have been loaded. The loadProject method returns a promise so you can use it with any give plugin or framework but ui-router is a really good choice for most projects.

app.config(function($stateProvider) {
  $stateProvider.state('app.dashboard', {
    // ... other stuff ...
    resolve: {
      optimizely: function(optimizely) {
        return optimizely.loadProject();
      }
    }
  });
});

You can also customize on which event the optimizely code should trigger. The default is '$viewContentLoaded'.

angular.module('app')
.config(['optimizelyProvider', function(optimizelyProvider) {
  optimizelyProvider.setKey('880950754');
  optimizelyProvider.setActivationEventName('$stateChangeSuccess');
}]);

To trigger the code as soon as possible instead of upon a certain event, set the activation event name to false:

angular.module('app')
.config(['optimizelyProvider', function(optimizelyProvider) {
  optimizelyProvider.setKey('880950754');
  optimizelyProvider.setActivationEventName(false);
}]);

Breaking changes in Version 2

• ng-optimizely is now a provider, not a factory. This means you'll need to configure it in a .config() block instead of within another module.
• optimizelyProvider#setKey - new method for setting your project key.
• optimizelyProvider#setActivationEventName - new method for setting the activation event name if you want to override the default.
• (not actually breaking) - started publishing to npm.

Test

TODO...

License

The MIT License (MIT)

Copyright (c) 2014 Jacopo Tarantino

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.