added ability to ignore breadcrumbs by setting false

Author: michaelbromley

src/directives/uiBreadcrumbs/uiBreadcrumbs.js

@@ -11,7 +11,7 @@ angular.module('angularUtils.directives.uiBreadcrumbs', ['ui.router', 'templates
             scope: {
                 displaynameProperty: '@'
             },
-            link: function(scope, element) {
+            link: function(scope) {
                 scope.breadcrumbs = [];
                 if ($state.$current.name !== '') {
                     updateBreadcrumbsArray();
@@ -29,10 +29,13 @@ angular.module('angularUtils.directives.uiBreadcrumbs', ['ui.router', 'templates
                     var currentState = $state.$current;
 
                     while(currentState && currentState.name !== '') {
-                        breadcrumbs.push({
-                            displayName: getDisplayName(currentState),
-                            route: currentState.name
-                        });
+                        var displayName = getDisplayName(currentState);
+                        if (displayName !== false) {
+                            breadcrumbs.push({
+                                displayName: displayName,
+                                route: currentState.name
+                            });
+                        }
                         currentState = currentState.parent;
                     }
 
@@ -48,25 +51,34 @@ angular.module('angularUtils.directives.uiBreadcrumbs', ['ui.router', 'templates
                  * @returns {*}
                  */
                 function getDisplayName(currentState) {
+                    var resolveProperty;
+                    var i;
+                    var propertyReference;
+                    var propertyArray;
+                    var displayName;
+
                     if (!scope.displaynameProperty) {
                         // if the displayname-property attribute was not specified, default to the state's name
                         return currentState.name;
                     }
-                    var displayName;
-                    var propertyArray = scope.displaynameProperty.split('.');
-                    var propertyReference = currentState;
+                    propertyArray = scope.displaynameProperty.split('.');
+                    propertyReference = currentState;
 
-                    for (var i = 0; i < propertyArray.length; i ++) {
-                        if (propertyReference[propertyArray[i]]) {
-                            propertyReference = propertyReference[propertyArray[i]];
+                    for (i = 0; i < propertyArray.length; i ++) {
+                        if (angular.isDefined(propertyReference[propertyArray[i]])) {
+                            if (propertyReference[propertyArray[i]] === false) {
+                                return false;
+                            } else {
+                                propertyReference = propertyReference[propertyArray[i]];
+                            }
                         } else {
                             // if the specified property was not foundm default to the state's name
                             return currentState.name;
                         }
                     }
                     if (propertyReference.indexOf(':') === 0) {
                         // the : syntax indicates a reference to a resolved property, so use that instead
-                        var resolveProperty = propertyReference.substr(1);
+                        resolveProperty = propertyReference.substr(1);
                         displayName = currentState.locals.globals[resolveProperty];
                     } else {
                         displayName = propertyReference;

src/directives/uiBreadcrumbs/uiBreadcrumbs.spec.js

@@ -38,6 +38,12 @@ describe('uiBreadcrumbs directive', function() {
                                 displayName: 'Subsection'
                             }
                         })
+                        .state('root.section.subsection.nobreadcrumb', {
+                            url: 'subsection/bit',
+                            data: {
+                                displayName: false
+                            }
+                        })
                         .state('async1', {
                             url: 'aync1/',
                             data: {
@@ -111,14 +117,21 @@ describe('uiBreadcrumbs directive', function() {
             expect(element[0].querySelectorAll('li').length).toBe(1);
         });
 
+        it('should not make a breadcrumb if displayName is set to false', function() {
+            $state.go('root.section.subsection.nobreadcrumb');
+            $scope.$apply();
+
+            expect(element[0].querySelectorAll('li').length).toBe(3);
+            expect(angular.element(element[0].querySelectorAll('li')[2]).hasClass("active")).toBe(true);
+        });
+
         it('should show correct displayName for alternative directive attribute', function() {
             var element2 = $compile('<ui-breadcrumbs displayname-property="custom.alternateDisplayName"></ui-breadcrumbs>')($scope);
             $scope.$apply();
 
             $state.go('root');
             $scope.$apply();
 
-
             expect(element2[0].querySelectorAll('li')[0].innerHTML).toContain('Other Home');
         });