0%

BreadcrumbNavigator

Attributes

Name
BreadCrumbs
Frame
UseBuiltInEventForFrame

Event

Name
ItemClicked

Method

Name
OnItemClicked
FixIndex
AddNewItem
ChangeBreadcrumbVisibility

Attached Property

Name Remark
IsHeaderVisible
PageTitle
ClearNavigation Does not work in JsonNavigationViewService Mode

if you are using JsonNavigationViewService, we can find Page Title from json file, however if you find some issue with this you can use our PageTitle AttachedProperty.

Using with JsonNavigationViewService

The easiest way to use, put BreadcrumbNavigator in your main page for example in NavigationView Header:

1
<wuc:BreadcrumbNavigator x:Name="JsonBreadCrumbNavigator"/>

then use ConfigBreadcrumbBar in JsonNavigationViewService

1
jsonNavigationViewService.ConfigBreadcrumbBar(breadCrumb, NavigationPageMappings.PageDictionary);

everything will done automatically.

for more info see here

Normal/Easy Usage

In this method, you have to add the items yourself

1
<wuc:BreadcrumbNavigator x:Name="BasicBreadCrumbNavigator"/>

now you should pass your frame to BasicBreadcrumbNavigator:

1
2
BasicBreadCrumbNavigator.UseBuiltInEventForFrame = true;
BasicBreadCrumbNavigator.Frame = yourFrame;

if you want to use AOT feature, you should pass your PageDictionary to BasicBreadCrumbNavigator otherwise you can skip this option.

1
BasicBreadCrumbNavigator.PageDictionary = NavigationPageMappings.PageDictionary;

for more info and finding a T4 template for generating PageDictionary see here

then in your pages you should use attached property for Item Title and visibility

1
2
3
4
5
<Page
wuc:BreadcrumbNavigator.PageTitle="Test"
wuc:BreadcrumbNavigator.IsHeaderVisible="True"

>

if you want to exclude a page to be shown in BreadcrumbNavigator, you can use our IsHeaderVisibile AttachedProperty.

if you set BasicBreadCrumbNavigator.UseBuiltInEventForFrame = true; you can bypass this section.
when you are navigating to another pages, you should add a new item to BreadcrumbNavigator: (only do this if UseBuiltInEventForFrame = false)

1
BasicBreadcrumbNavigator.AddNewItem(targetPage, actionAfterItemAdded);

We have already prepared some codes, so clicking on the items and fixing the index of the items will be done automatically.
If you need to do more, you can create the ItemClicked event, but you should know that you have to do the rest yourself.

1
BasicBreadcrumbNavigator.ItemClicked += OnItemClicked;

you can use our prepared codes or you can write your own codes here:

1
2
3
4
private void OnItemClicked(BreadcrumbBar sender, BreadcrumbBarItemClickedEventArgs args)
{
BasicBreadcrumbNavigator.OnItemClicked(args);
}

Normal/Hard way

in this way you need to handle everything, so please look for source code and see how things happened.

Demo

you can run demo and see this feature.

WinUICommunity