Edit on Github

Breadcrumb

in namespace DotVVM.Bootstrap5.Controls

Represents the Bootstrap breadcrumb navigation control with data-binding support.

Usage & Scenarios

Renders a Bootstrap breadcrumb navigation control with data-binding support.

https://getbootstrap.com/docs/5.2/components/breadcrumb/

Sample 1: Static Breadcrumbs

You can place <bs:BreadcrumbItem> elements inside the Breadcrumbs control.

The Text property or the contents inside the BreadcrumbItem element specifies the text of the menu item.
You may set NavigateUrl to make the badge to link to a specific URL.
The Click event can be used to invoke a command in the viewmodel.
You may also use RouteName, Param-*, Query-* and UrlSuffix properties to build a link from a route table. See RouteLink for details.

page.dothtml
ViewModel.cs

<bs:Breadcrumb>
  <bs:BreadcrumbItem NavigateUrl="https://www.google.com/"
                     Text="Google"/>

  <bs:BreadcrumbItem NavigateUrl="http://www.w3schools.com/"
                     Text="Wc3Schools"
                     Enabled="false"/>

  <bs:BreadcrumbItem RouteName="Breadcrumb_sample1"
                     Param-Id="{value: Test}"
                     Text="Route link" />

  <bs:BreadcrumbItem Click="{command: ItemClicked()}"
                     Text="Clickable item" />
</bs:Breadcrumb>

public class ViewModel : DotvvmViewModelBase
{
    public string Test { get; set; } = "Test";

    public void ItemClicked() 
    {
        
    }

}

Sample 2: Selected Items

The IsSelected property defines whether the list item is selected or not.

Selected items are not clickable by default - the links are not rendered. You can set RenderLinkForSelectedItem to true if you want to render links even for selected items.

page.dothtml
ViewModel.cs

<bs:Breadcrumb RenderLinkForSelectedItem="true">

  <bs:BreadcrumbItem NavigateUrl="https://www.google.com/"
                     Text="Google"/>

  <bs:BreadcrumbItem RouteName="Breadcrumb_sample2"
                     Param-Id="{value: Test}"
                     Text="Route link"
                     Selected="true" />

</bs:Breadcrumb>

public class ViewModel : DotvvmViewModelBase
{
    public string Test { get; set; } = "abc";

}

Sample 3: Data-bound Breadcrumbs

If you want to data-bind the items inside the Breadcrumbs control, use the DataSource property. This property expects IEnumerable.

Using the ItemText, ItemNavigateUrl, ItemIsSelected, ItemIsEnabled and ItemClick, you can declare how the generated items will look. Bindings in these properties are evaluated for every collection item and set to the corresponding properties of the generated list items. You can use ItemTemplate to specify template of generated list items.

page.dothtml
ViewModel.cs

<bs:Breadcrumb DataSource="{value: Links}"
                           ItemEnabled="{value: IsEnabled}"
                           ItemSelected="{value: IsSelected}"
                           ItemText="{value: Text}"
                           ItemNavigateUrl="{value: NavigateUrl}" />

                           
<bs:Breadcrumb DataSource="{value: Links}">
        <ItemTemplate>
            {{value: Text}}
        </ItemTemplate>
</bs:Breadcrumb>

public class ViewModel : DotvvmViewModelBase
{
    public List<LinkItem> Links { get; set; }

    public ViewModel()
    {
        Links = new List<LinkItem>()
        {
            new LinkItem()
            {
                IsEnabled = true,
                IsSelected = false,
                NavigateUrl = "https://www.google.com/",
                Text = "Google"
            },
            new LinkItem()
            {
                IsEnabled = false,
                IsSelected = false,
                NavigateUrl = "http://www.w3schools.com/html/",
                Text = "W3Schools"
            },
            new LinkItem()
            {
                IsEnabled = false,
                IsSelected = true,
                NavigateUrl = "https://www.microsoft.com/en-us/",
                Text = "Microsoft"
            },
            new LinkItem()
            {
                IsEnabled = false,
                IsSelected = false,
                NavigateUrl = "https://github.com/riganti/dotvvm",
                Text = "DotVVM Github"
            }
        };
    }

}

public class LinkItem
{
    public string Text { get; set; }
    public string NavigateUrl { get; set; }
    public bool IsSelected { get; set; }
    public bool IsEnabled { get; set; }

}

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
ClientIDMode	ClientIDMode	Gets or sets the client ID generation algorithm.	attribute inner element static value bindable default	Static
DataContext	Object	Gets or sets a data context for the control and its children. All value and command bindings are evaluated in context of this value. The DataContext is null in client-side templates.	attribute inner element static value bindable default	null
DataSource	IValueBinding<IEnumerable<Object>>	Gets or sets a data-source object from which the child controls will be generated.	attribute inner element static value bindable default	null
Divider	String	Gets or sets a string divider between the breadcrumb items.	attribute inner element static value bindable default	null
ID	String	Gets or sets the control client ID within its naming container.	attribute inner element static value bindable default	null
IncludeInPage	Boolean	Gets or sets whether the control is included in the DOM of the page.	attribute inner element static value bindable default	True
ItemEnabled	Boolean	Gets or sets whether the breadcrumb item is enabled when DataSource is set.	attribute inner element static value bindable default	True
ItemNavigateUrl	String	Gets or sets a URL for breadcrumb item when DataSource is set.	attribute inner element static value bindable default	null
ItemRouteName	String	Gets or sets a route name for breadcrumb item when DataSource is set.	attribute inner element static value bindable default	null
Items	List<IBreadcrumbItem>	Gets or sets the items inside the control.	attribute inner element static value bindable default	null
ItemSelected	Boolean	Gets or sets whether the breadcrumb item is selected when DataSource is set.	attribute inner element static value bindable default	null
ItemTemplate	ITemplate	Gets or sets a custom template for breadcrumb item when DataSource is set.	attribute inner element static value bindable default	null
ItemText	String	Gets or sets a plain text for breadcrumb item when DataSource is set.	attribute inner element static value bindable default	null
ItemUrlSuffix	String	Gets or sets a URL suffix for breadcrumb item when DataSource is set.	attribute inner element static value bindable default	null
Visible	Boolean	Gets or sets whether the control is visible. When set to false, `style="display: none"` will be added to this control.	attribute inner element static value bindable default	True

Events

	Name	Type	Description
	ItemClick	ICommandBinding	Gets or sets a click action for breadcrumb item when DataSource is set.