From 51895c73d08707554d842bb8ba10567fd2ab611e Mon Sep 17 00:00:00 2001
From: Laura Weatherhead <laura@spun.dev>
Date: Wed, 21 Oct 2020 13:40:03 +0100
Subject: [PATCH] Update usage guidance

- Reflect optional nature of callback
- Show actual property name to reference
---
 .../components/editor/umbbreadcrumbs.directive.js         | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/Umbraco.Web.UI.Client/src/common/directives/components/editor/umbbreadcrumbs.directive.js b/src/Umbraco.Web.UI.Client/src/common/directives/components/editor/umbbreadcrumbs.directive.js
index f80b3ceb3e..1be2bb9739 100644
--- a/src/Umbraco.Web.UI.Client/src/common/directives/components/editor/umbbreadcrumbs.directive.js
+++ b/src/Umbraco.Web.UI.Client/src/common/directives/components/editor/umbbreadcrumbs.directive.js
@@ -13,7 +13,8 @@ Use this directive to generate a list of breadcrumbs.
         <umb-breadcrumbs
             ng-if="vm.ancestors && vm.ancestors.length > 0"
             ancestors="vm.ancestors"
-            entity-type="content">
+            entity-type="content"
+            on-open="clickBreadcrumb(ancestor)">
         </umb-breadcrumbs>
     </div>
 </pre>
@@ -32,6 +33,9 @@ Use this directive to generate a list of breadcrumbs.
                 vm.ancestors = ancestors;
             });
 
+            $scope.clickBreadcrumb = function(ancestor) {
+                // manipulate breadcrumb display
+            }
         }
 
         angular.module("umbraco").controller("My.Controller", Controller);
@@ -40,7 +44,7 @@ Use this directive to generate a list of breadcrumbs.
 
 @param {array} ancestors Array of ancestors
 @param {string} entityType The content entity type (member, media, content).
-@param {callback} Callback when an ancestor is clicked. It will override the default link behaviour.
+@param {callback=} onOpen Function callback when an ancestor is clicked. This will override the default link behaviour.
 **/
 
 (function () {