Page Nav

Sub-navigation row for page chrome, placed below breadcrumbs and outside PageHeader.

Loading...
'use client'
 
import { useState } from 'react'
import { NavMenu, NavMenuItem } from 'ui'
import { PageNav } from 'ui-patterns/PageNav'
 
const pages = [
  { id: 'overview', label: 'Overview' },
  { id: 'logs', label: 'Logs' },
  { id: 'settings', label: 'Settings' },
] as const
 
export function PageNavDemo() {
  const [activePage, setActivePage] = useState<(typeof pages)[number]['id']>('overview')
 
  return (
    <div className="w-full">
      <PageNav>
        <NavMenu>
          {pages.map((page) => (
            <NavMenuItem key={page.id} active={activePage === page.id}>
              <button
                tabIndex={0}
                type="button"
                aria-pressed={activePage === page.id}
                className="h-full cursor-pointer appearance-none bg-transparent text-inherit"
                onClick={() => setActivePage(page.id)}
              >
                {page.label}
              </button>
            </NavMenuItem>
          ))}
        </NavMenu>
      </PageNav>
    </div>
  )
}

Usage

import { NavMenu, NavMenuItem } from 'ui'
import { PageNav } from 'ui-patterns/PageNav'
<PageNav>
  <NavMenu>
    <NavMenuItem active>Overview</NavMenuItem>
    <NavMenuItem>Logs</NavMenuItem>
  </NavMenu>
</PageNav>

Sub-components

  • PageNav — container for NavMenu tab navigation. The bottom border always spans the full width.

Props

PropTypeDefaultDescription
size'small' | 'default' | 'large' | 'full''full'Width and padding of the nav content, same values as PageContainer

PageNav uses PageContainer for width and padding. It does not depend on PageHeader.

Set size to match the sibling PageHeader and page content so the tabs line up with the title and body. With full (the default), the tabs span edge to edge with the page chrome's px-4 padding. Any other size uses PageContainer's max-width and padding, so on wide viewports the tabs stay centered with the rest of the page.

<PageHeader size="large">…</PageHeader>
<PageNav size="large">
  <NavMenu>…</NavMenu>
</PageNav>
<PageContainer size="large">…</PageContainer>

Place it directly below PageBreadcrumbs and outside PageHeader. For legacy pages, PageHeaderNavigationTabs remains available on PageHeader.