Secondary Navigation

Selector
bp-nav-secondary

Inputs

Secondary navigation inputs
InputTypeDescriptionNotes
titlestringThe title text at the top of the secondary navigation.
itemsNavItem[]The object structure that creates the navigation items.The nesting of the NavItem objects will reflect as collapsibles with nested navigation items.
shouldRouteMatchExactboolean Determines if the routes should match exactly to be active. Equates to the routerLinkActiveOptions “exact” option.

Default is "false".

When "true" the routes should match exactly.

areItemsExpandedbooleanDetermines if the nested navigation items should be expanded or collapsed.

Default is "false".

When "true" the nested navigation items are all expanded.

isNavigationalbooleanDetermines if the secondary nav is navigational.

Default is "true".

When "true" the nav is navigational and nav items are links.

When "false" the nav is not navigational and nav items are buttons.

bpIDstringThe value for the secondary navigation's id attribute.

Ids must only be used once per page.

Ids should be camelCase, e.g.: #myId.

See identifiers.

There are two kinds of NavItems that are determiend by what properties are defined.

Standard Node

The standard node represents a link to another page in the application, or an action. This node is defined by providing the following properties to a NavItem object.

NavItem standard node properties
PropertyTypeDescription
routestringThe route used for the NavItem. This is not required when isNavigational = "false"
textstringThe text used for the NavItem.

Parent Node

The parent node has children that are standard nodes, and represents a grouping of NavItems. This node is defined by providing the following properties to a NavItem object.

NavItem parent node properties
PropertyTypeDescription
childrenNavItem[]An array of NavItems nested in a collapsible.
textstringThe text used for the collapsible NavItem.

Outputs

Secondary navigation outputs
PropertyDescription
actionWhen isNavigational = "false", action is emitted on click of a nav item. The emitted object is the corresponding object from the items Input.

Identifiers

Identifiers
IDDescription
bpIDThe unique identifier for the secondary navigation component.
bpID + 'Action' + i + 'ListIndex' + parentIndex

The unique identifier for each action.

The parent index increments from inside out starting at 1 where the root/outer list parent index is 0.

uuid + 'NestedList' + index + 'Parent' + parentIndexThe unique identifier for each nested list.