Navigation Menu

A collection of links for navigating websites, with support for trigger-activated content panels.

Usage

julia
using Suite

NavigationMenu(
    NavigationMenuList(
        NavigationMenuItem(
            NavigationMenuTrigger("Getting Started"),
            NavigationMenuContent(
                NavigationMenuLink(href="/intro", title="Introduction",
                    "A brief overview of the project."
                ),
            ),
        ),
        NavigationMenuItem(
            NavigationMenuLink(href="/docs", "Documentation"),
        ),
    ),
)

Keyboard Interactions

KeyAction
Arrow RightMove focus to the next trigger
Arrow LeftMove focus to the previous trigger
Arrow DownOpen content panel / move into content
TabCycle through links within an open content panel
Enter / SpaceActivate the focused link or trigger
EscapeClose the open content panel

API Reference

NavigationMenu

PropTypeDefaultDescription
children...Any-NavigationMenuList and NavigationMenuViewport
orientationString"horizontal""horizontal" or "vertical"
classString""Additional CSS classes

NavigationMenuList

PropTypeDefaultDescription
children...Any-NavigationMenuItem children
classString""Additional CSS classes

NavigationMenuItem

PropTypeDefaultDescription
children...Any-Trigger + Content pair, or a direct Link
classString""Additional CSS classes

NavigationMenuTrigger

PropTypeDefaultDescription
children...Any-Trigger label text
classString""Additional CSS classes

NavigationMenuContent

PropTypeDefaultDescription
children...Any-NavigationMenuLink items
classString""Additional CSS classes

NavigationMenuLink

PropTypeDefaultDescription
hrefString""URL the link navigates to
titleString""Link heading text
children...Any-Description text displayed below the title
classString""Additional CSS classes

NavigationMenuViewport

PropTypeDefaultDescription
classString""Additional CSS classes

NavigationMenuIndicator

PropTypeDefaultDescription
classString""Additional CSS classes