Skip to content

Top Nav Heading

@astryxdesign/core v0.7.1 · TopNavHeading

Props ​

PropTypeDefaultDescription
headingstring—Product/app name displayed as the primary heading text.
hrefstring—Alias of headingHref, so the top bar and the side nav heading take the same prop. headingHref wins when both are set.
headingHrefstring—Link for the heading text (e.g. product home). When no menu is present and this is the only href, the whole heading becomes one clickable link.
superheadingstring—Text above the heading (e.g. suite name). Rendered in a smaller secondary style.
superheadingHrefstring—Link for the superheading text (e.g. suite home). When provided alongside a menu, renders as an independent inline link.
subheadingstring—Text below the heading (e.g. account context). Rendered in a smaller secondary style.
subheadingHrefstring—Link for the subheading text. When provided alongside a menu, renders as an independent inline link.
logoLabelstringheadingAccessible name for the logo when it is a link of its own and there is no readable text beside it. Ignored when the logo is not a link.
asNavLinkComponent'a'Custom link root component, such as RouterLink. Used only when there is an address. It receives the href and slot content.

Slots ​

  • logo: logo rendered before the heading text. An image, a NavIcon, or any element.
  • icon: same place as logo. logo wins when both are passed.
  • end: content at the trailing edge of the heading row, such as a badge.
  • menu: menu content shown in a popover. A chevron indicator appears automatically. With no href the whole header opens the menu; with hrefs the links are independent and the chevron area opens it. Receives close and focusRequest.