Toolbar

Toolbar is a surface that houses commands that operate on the content of the window, panel, or parent region it resides above. Toolbars are one of the most visible and recognizable ways to surface commands, and can be an intuitive method for interacting with content on the page; however, if overloaded or poorly organized, they can be difficult to use and hide valuable commands from your user. Toolbars can also display a search box for finding content, hold simple commands as well as menus, or display the status of ongoing actions.

Commands should be sorted in order of importance, from left-to-right or right-to-left depending on the culture. Secondarily, organize commands in logical groupings for easier recall. Toolbars work best when they display no more than 5-7 commands. This helps users quickly find your most valuable features. If you need to show more commands, consider using the overflow menu. If you need to render status or viewing controls, these go on the right side of the Toolbar (or left side if in a left-to-right experience). Do not display more than 2-3 items on the right side as it will make the overall Toolbar difficult to parse.

All command items should have an icon and a label. Commands can render as labels only as well. In smaller widths, commands can just use icon only, but only for the most recognizable and frequently used commands. All other commands should go into an overflow where text labels can be shown.

Properties#

Toolbar control does not have any specific properties.

Events#

Toolbar control does not have any specific events.

Child controls#

Item control#

Represents a menu item within Toolbar control.

Properties#

NameTypeDefaultDescription
textstringText of the menu item. If a standard hyphen (-) is passed in, then the item will be rendered as a divider. If a dash must appear as text, use an emdash (โ€”), figuredash (โ€’), or minus symbol (โˆ’) instead.
secondaryTextstringSeconday description for the menu item to display.
urlstringURL to navigate to for this menu item.
newWindowboolfalseWhether to open link in a new browser window.
iconstringAn optional icon to display next to the item.
iconColorstringIcon color.
iconOnlyboolfalseShow only an icon for this item, not text. Does not apply if item is in the overflow.
splitboolfalseWhether or not this menu item is a SplitButton.
dividerboolfalseDisplay menu item as a divider.

Events#

NameDescription
clickFires when menu item is invoked.

Child controls#

Item control can contain other item controls to add nested menu items.

Overflow control#

Group items to display in the overflow menu.

Child controls#

Far control#

Group items to display on the right side of the toolbar.

Child controls#

Examples#

# TODO