Package org.craftercms.engine.navigation
Interface NavBreadcrumbBuilder
- All Known Implementing Classes:
NavBreadcrumbBuilderImpl
public interface NavBreadcrumbBuilder
Facilitates the creation of navigation breadcrumbs (e.g. Home > About Us > Leadership Team).
- Author:
- avasquez
-
Method Summary
Modifier and TypeMethodDescriptiongetBreadcrumb
(String url, String root) Returns the navigation items that form the breadcrumb for the specified store URL.getBreadcrumb
(String url, String root, org.craftercms.commons.converters.Converter<SiteItem, NavItem> itemConverter) Returns the navigation items that form the breadcrumb for the specified store URL.
-
Method Details
-
getBreadcrumb
Returns the navigation items that form the breadcrumb for the specified store URL.- Parameters:
url
- the current URL used to build the breadcrumbroot
- the root URL, basically the starting point of the breadcrumb- Returns:
- the list of
NavItem
s that represent the breadcrumb
-
getBreadcrumb
List<NavItem> getBreadcrumb(String url, String root, org.craftercms.commons.converters.Converter<SiteItem, NavItem> itemConverter) Returns the navigation items that form the breadcrumb for the specified store URL.
-