- Selector
- bp-nav-secondary
Inputs
Input | Type | Description | Notes |
---|---|---|---|
title | string | The title text at the top of the secondary navigation. | |
items | NavItem[] | The object structure that creates the navigation items. | The nesting of the NavItem objects will reflect as collapsibles with nested navigation items. |
shouldRouteMatchExact | boolean | 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. |
areItemsExpanded | boolean | Determines if the nested navigation items should be expanded or collapsed. | Default is "false". When "true" the nested navigation items are all expanded. |
isNavigational | boolean | Determines 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. |
bpID | string | The 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. |
NavItem
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.
Property | Type | Description |
---|---|---|
route | string | The route used for the NavItem. This is not required when isNavigational = "false" |
text | string | The 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.
Property | Type | Description |
---|---|---|
children | NavItem[] | An array of NavItems nested in a collapsible. |
text | string | The text used for the collapsible NavItem. |
Outputs
Property | Description |
---|---|
action | When isNavigational = "false", action is emitted on click of a nav item. The emitted object is the corresponding object from the items Input. |
Identifiers
ID | Description |
---|---|
bpID | The 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' + parentIndex | The unique identifier for each nested list. |