Side Nav Heading
@astryxdesign/core v0.7.1 · SideNavHeading
Props
| Prop | Type | Default | Description |
|---|---|---|---|
heading | string | — | Product or app name. Also the accessible name of the icon-only heading shown while the rail is collapsed. Required. |
headingHref | string | — | Link for the heading text, such as the product home. With no menu, the whole heading becomes one link. |
superheading | string | — | Small line above the heading, such as the suite name. |
superheadingHref | string | — | Link for the line above the heading. With a menu it stays an independent link. |
subheading | string | — | Small line below the heading, such as the current account. |
subheadingHref | string | — | Link for the line below the heading. With a menu it stays an independent link. |
logoLabel | string | heading | Accessible name for the icon when it is a link of its own and no readable text sits beside it. |
as | NavLinkComponent | 'a' | Custom link root component, such as RouterLink. It receives the address as to as well. Used only when there is an address. |
Slots
icon: mark before the text. ANavIcon, an image, or any element. Collapsed, it becomes the whole heading.menu: popover content for the heading. A chevron appears automatically. Without an address the whole heading opens the menu; with one the links stay independent. ReceivescloseandfocusRequest.end: content at the trailing edge of the heading row, such as a badge.