Navigation Menu

• Home
• Docs󰯑
• RefineUI

Import

import {
  NavigationMenu,
  NavigationMenuList,
  NavigationMenuItem,
  NavigationMenuTrigger,
  NavigationMenuContent,
  NavigationMenuLink,
} from "@pelagornis/page/components";

Example

The preview above renders this file. Copy it into src/components/ to start from it.

src/components/NavigationMenuExample.tsx

import {
  NavigationMenu,
  NavigationMenuContent,
  NavigationMenuItem,
  NavigationMenuLink,
  NavigationMenuList,
  NavigationMenuTrigger,
} from "@pelagornis/page/components";

export default function NavigationMenuDemo() {
  return (
    <NavigationMenu aria-label="Main">
      <NavigationMenuList>
        <NavigationMenuItem>
          <NavigationMenuLink href="/" active>
            Home
          </NavigationMenuLink>
        </NavigationMenuItem>
        <NavigationMenuItem value="docs">
          <NavigationMenuTrigger>Docs</NavigationMenuTrigger>
          <NavigationMenuContent>
            <NavigationMenuLink href="/guides/getting-started/">Getting started</NavigationMenuLink>
            <NavigationMenuLink href="/components/">Components</NavigationMenuLink>
          </NavigationMenuContent>
        </NavigationMenuItem>
        <NavigationMenuItem>
          <NavigationMenuLink href="https://ui.pelagornis.com/">RefineUI</NavigationMenuLink>
        </NavigationMenuItem>
      </NavigationMenuList>
    </NavigationMenu>
  );
}

Use in MDX

Navigation Menu is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

src/content/docs/example.mdx

---
title: Example
---

import NavigationMenuExample from "../../components/NavigationMenuExample";

<NavigationMenuExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

src/components/markdoc/NavigationMenuExample.astro

---
import NavigationMenuExample from "../NavigationMenuExample";
---

<NavigationMenuExample client:load />

markdoc.config.mjs

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "navigation-menu-example": {
      render: component("./src/components/markdoc/NavigationMenuExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% navigation-menu-example /%}

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
root	navigation-menu
content	navigation-menu-content
content_panel	navigation-menu-content-panel
indicator	navigation-menu-indicator
item	navigation-menu-item
link	navigation-menu-link
list	navigation-menu-list
trigger	navigation-menu-trigger

States

States the component styles. Component states are exposed as data attributes.

Kind	States
Pseudo	focus-visible
data-state	open closed

Keyboard

Keys the component handles when it has focus.

Key	Action
Escape	close
Enter	activate
Space	activate

Reference

• RefineUI · Navigation Menu for design guidance and token detail.
• Use in MDX and Use in Markdoc for the general rules.