feat($compileProvider): allow component() helper to copy over custo…

…m annotations Closes #13741
angular · Jan 12, 2016 · 90975db · 90975db
1 parent 25bc531
commit 90975db
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 11 deletions.
diff --git a/src/ng/compile.js b/src/ng/compile.js
@@ -968,8 +968,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
    *      See {@link ng.$compile#-bindtocontroller- `bindToController`}.
    *    - `transclude` – `{boolean=}` – whether {@link $compile#transclusion content transclusion} is enabled.
    *      Disabled by default.
-   *    - `$canActivate` – `{function()=}` – TBD.
-   *    - `$routeConfig` – `{object=}` – TBD.
+   *    - `$...` – `{function()=}` – additional annotations to provide to the directive factory function.
    *
    * @returns {ng.$compileProvider} the compile provider itself, for chaining of function calls.
    * @description
@@ -1080,12 +1079,14 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
       };
     }
 
-    if (options.$canActivate) {
-      factory.$canActivate = options.$canActivate;
-    }
-    if (options.$routeConfig) {
-      factory.$routeConfig = options.$routeConfig;
-    }
+    // Copy any annotation properties (starting with $) over to the factory function
+    // These could be used by libraries such as the new component router
+    forEach(options, function(val, key) {
+      if (key.charAt(0) === '$') {
+        factory[key] = val;
+      }
+    });
+
     factory.$inject = ['$injector'];
 
     return this.directive(name, factory);

diff --git a/test/ng/compileSpec.js b/test/ng/compileSpec.js
@@ -9321,14 +9321,16 @@ describe('$compile', function() {
       });
     });
 
-    it('should add router annotations to directive factory', function() {
+    it('should add additional annotations to directive factory', function() {
       var myModule = angular.module('my', []).component('myComponent', {
         $canActivate: 'canActivate',
-        $routeConfig: 'routeConfig'
+        $routeConfig: 'routeConfig',
+        $customAnnotation: 'XXX'
       });
       expect(myModule._invokeQueue.pop().pop()[1]).toEqual(jasmine.objectContaining({
         $canActivate: 'canActivate',
-        $routeConfig: 'routeConfig'
+        $routeConfig: 'routeConfig',
+        $customAnnotation: 'XXX'
       }));
     });