titleLink*object | Options for the primary logo/title link on the left side of the navigation Object contains nested props, see below: |
titleLink.textstring | Passing a product slug to triggers a special case, where the product's logo and brand colors are used. Note that in other cases, it should be a string with proper casing. Options: "hashicorp", "boundary", "consul", "nomad", "packer", "terraform", "vault", "vagrant", "waypoint", "hcp", "tfc" |
titleLink.urlstring | A link applied to the product name or logo |
ctaLinksarray | An array of items to be displayed as buttons to the far right. There are special values for "Download" and "Github" if these are passed as the text. Array members must be of the type below: |
ctaLinks[x]object | Object contains nested props, see below: |
ctaLinks[x].textstring | |
ctaLinks[x].urlstring | |
hideGithubStarsboolean | If true, will ensure GitHub stars are not shown in any ctaLinks, even if the special value GitHub is passed |
menuItems*array | An array of links to be displayed as navigation menu items. Array can contain any of the 3 types below: |
menuItems[x]string | Using the string "divider" will render a vertical divider between items Options: "divider" |
menuItems[x]object | This type will render a single link in the menu Object contains nested props, see below: |
menuItems[x].textstring | |
menuItems[x].urlstring | |
menuItems[x].typestring | Options: "inbound", "outbound", "anchor" |
menuItems[x]object | This type will render a dropdown menu with multiple links in the menu Object contains nested props, see below: |
menuItems[x].textstring | |
menuItems[x].submenuobject | Object contains nested props, see below: |
menuItems[x].submenu.textstring | |
menuItems[x].submenu.urlstring | |
menuItems[x].submenu.typestring | Options: "inbound", "outbound", "anchor" |
menuItemsAlignstring | Controls alignment of menu bar items on Desktop Options: "center", "right" |
constrainWidthboolean | If true, will match the width of g-grid-container |
currentPathstring | The current active path relative to the root of the site. Will be matched to the url property of menuItems to determine the active page. |
LinkReact.Element | The NextJS Link component to make client-side routing possible. Note that this is passed directly to @hashicorp/react-link-wrap, so we'll fall back to a normal tag if this prop is not provided. |
matchOnBasePathboolean | Whether or not to highlight items if the base path matches the current URL. Defaults to false, requiring a full URL match. |
classNamestring | Optional className to add to the root element |