BreadcrumbMenu

Overview

Since 4.0

The ace:breadcrumbMenu component displays a horizontal bar of menu items. The crumbs are encoded by child menuItem tags and can be marked up inline or dynamically using a menu model.

BreadcrumbMenu is a horizontal bar of breadcrumb menu items. The crumbs are encoded by child menuItem tags. The menu items can be encoded inline or dynamically using a menu model (org.icefaces.ace.model.MenuModel). The icon attribute is not used. The icon will be forced to a home page icon for the first item and a right arrow icon for the rest. The last (or only) item will also be forced to be disabled.

See the ICEfaces Showcase Live Demo of this component, complete with source code.

Getting Started

To use the breadcrumbMenu component, first the ace component name-space has to be added in your page.

<html ... xmlns:ace="http://www.icefaces.org/icefaces/components">

Now you ready to use breadcrumbMenu component, here is the basic example:

Attributes

TagLib Documentation
This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available here.

Define the model of this component:
The model attribute of breadcrumbMenu allows the user to create and maintain a dynamic list of links representing an action or URL.

Event Listeners

Although not containing any of its own action Listeners, each menuItem child will have it's own ability to have an acitonListener.

Client Behavior Events

No direct client behavior is currently associated with this component. Please see those for

<ace:menuItem}

JavaScript API

ICEfaces 3.x

The client side component object is exposed through the global variable name specified in the widgetVar attribute.

ICEfaces 4+

The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.

var widget = ice.ace.instance('frm:componentId);

The ice.ace.instance function requires the full client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use prependId="false" in the enclosing form (e.g. <h:form prependId="false">).

This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.

Keyboard and ARIA Support

The following ARIA roles are supported: menubar, menuitem.

CSS Classes

The following markup represents the basic HTML structure of the component and the CSS classes it uses.

<!-- Root container -->
<div class="ui-breadcrumb-menu [user defined classes]" style="[user defined styles]">
	<div class="ui-widget ui-widget-content wijmo-wijmenu ui-corner-all ui-helper-clearfix wijmo-wijmenu-horizontal">
		<div class="scrollcontainer checkablesupport">
			<ul class="wijmo-wijmenu-list ui-helper-reset">
				<!-- Breadcrumb menu item -->
				<li class="ui-widget wijmo-wijmenu-item ui-state-default ui-corner-all">
					<a class="wijmo-wijmenu-link ui-corner-all">
						<span class="wijmo-wijmenu-text">
							<span class="ui-icon ui-icon-home wijmo-wijmenu-icon-left"></span>
							<span class="wijmo-wijmenu-text">Item label</span>
						</span>
					</a>
				</li>
			</ul>
		</div>
	</div>
</div>

Known Issues

None.

Additional Resources

Tutorials

This component appears in the following ICEfaces tutorials:

None