A string containing an HTML img tag which will display a larger BlueStep icon corresponding to the type of page.
A optional string value containing the URL of a larger BlueStep icon corresponding to the type of page.
A number indicating the number of child pages available from this SiteNavItem.
An array of SiteNavItems representing the children this SiteNavItem.
A string value containing the description of the page represented by this SiteNavItem.
A string containing the URL of the standard BlueStep icon corresponding to the type of page
A string containing an HTML img tag which will display the standard BlueStep icon corresponding to the type of page.
A string value containing the internal id of the page represented by this SiteNavItem.
A number containing the index of the current SiteNavItem in its parent's list of children.
A boolean value indicating whether this SiteNavItem represents the currently navigated page
A boolean value indicating whether this SiteNavItem is childless.
A boolean value indicating whether this is the root SiteNavItem. The root SiteNavItem represents the site itself, is at level 0, and has no parent.
A boolean value indicating whether this SiteNavItem represents the currently navigated page or one of its parent pages.
A string value containing the name/label of the page represented by this SiteNavItem
A number indicating the level of the page within the navigation tree. Primary navigation is level 1. Children of these navigation items are level 2, or secondary navigation. Children of level 2 are level 3 and so forth.
Some optional [[BaseObject]] that this SiteNavItem represents
Finds an optional child page using the isFound callback function.
Callback to indicated if child SiteNavItem was found
OptionalfullTree: booleanWhen false - the default, do not search through all the pages's descendants.When true search until all sub-pages of the current page have been searched. The fullTree search does this via a depth traversal, meaning that if two children have the label that is being searched for, it will choose a page with a smaller 'level' value over a page with a higher 'level' value. If the pages are at the same level, it will choose the one that comes first.
// Find the first child that is a leaf child
let optFoundChildNavItem = navItem.optFindBy(childNavItem => childNavItem.isLeaf(), true);
// Find the first child who's label is 'label'
let optFoundChildNavItem = navItem.optFindBy(childNavItem => 'label' === childNavItem.label(), true);
// or
let optFoundChildNavItem = navItem.optFindByEquals('label', childNavItem => childNavItem.label());
// or
let optFoundChildNavItem = navItem.optFindByLabel('label', true);
Finds an optional child page using name - value custom properties
The custom property name of the SiteNavItem to be searched. Since pages of different types can have the same property, and pages of the same type can have the same property if the name of the property begins with an under-bar, there is no guarentee that only one page will have the given property. In this case the first such page will be returned as determined by search.
Custom property value
OptionalfullTree: booleanSee [[optFindByLabel]]
Finds an optional child page. It will do an equals check on the callback function. Same as navItem.optFindBy(childNavItem => value === toT(childNavItem), fullTree);
Value to search and check against
Callback to check if it equals value.
OptionalfullTree: booleanSee description in [[optFindBy]] with the same name.
Finds an optional child page. Same as navItem.optFindByEquals(value, childNavItem => childNavItem.id(), fullTree);
The id of the SiteNavItem to be searched.
OptionalfullTree: booleanSee description in [[optFindBy]] with the same name.
Finds an optional child page. Same as navItem.optFindByEquals(value, childNavItem => childNavItem.label(), fullTree);
The id of the SiteNavItem to be searched.
OptionalfullTree: booleanSee description in [[optFindBy]] with the same name.
An optional SiteNavItem representing the parent SiteNavItem of this SiteNavItem. The root SiteNavItem will have no parent.
A string indicating the type of page represented by this SiteNavItem
A string value containing the URL of the page represented by this SiteNavItem.
Returned by [[B.siteNavigation]]
Example: ```javascript
let navItem = B.siteNavigation();