Navigation Menu
A simplified wrapper for Shadcn Navigation Menu with flexible option handling and automatic type conversion
Installation
npx shadcn@latest add @glrk-ui/navigation-menuIf you haven't set up the prerequisites yet, check out Prerequest section.
Create new file name ui/navigation-menu-wrapper.tsx.
"use client"
import Link, { type LinkProps } from "next/link"
import { cn } from "@/lib/utils"
import {
NavigationMenu,
NavigationMenuList,
NavigationMenuItem,
NavigationMenuTrigger,
NavigationMenuContent,
NavigationMenuLink,
navigationMenuTriggerStyle,
} from "@/components/ui/navigation-menu"
type navLinkItemT = LinkProps & {
children: React.ReactNode
className?: string
}
type navLinkItemsT = navLinkItemT[]
type navMenuItemT = {
key: string
itemProps?: React.ComponentProps<typeof NavigationMenuItem>
} & (
| {
trigger: React.ReactNode
content: React.ReactNode
triggerCls?: string
contentCls?: string
contentProps?: React.ComponentProps<typeof NavigationMenuContent>
}
| navLinkItemT
)
type navMenuItemsT = navMenuItemT[]
function NavLinkItem({ children, className, ...props }: navLinkItemT) {
return (
<NavigationMenuLink asChild>
<Link {...props} className={cn("flex flex-row items-center gap-2", className)}>
{children}
</Link>
</NavigationMenuLink>
)
}
type listWrapperProps = {
items: navLinkItemsT
wrapperCls?: string
}
function NavList({ items, wrapperCls }: listWrapperProps) {
return (
<ul className={wrapperCls}>
{items.map((item, i) => (
<li key={i}>
<NavLinkItem
{...item}
className={item.className}
/>
</li>
))}
</ul>
)
}
type wrapperProps = React.ComponentProps<typeof NavigationMenu> & {
items: navMenuItemsT
triggerCls?: string
contentCls?: string
}
function NavigationMenuWrapper({
items,
className,
triggerCls,
contentCls,
...props
}: wrapperProps) {
return (
<NavigationMenu className={className} {...props}>
<NavigationMenuList>
{items.map(itemWrap => {
const { key, ...item } = itemWrap
if ("trigger" in item) {
return (
<NavigationMenuItem key={key} {...item.itemProps}>
<NavigationMenuTrigger
asChild={typeof item.trigger !== "string"}
className={cn(triggerCls, item.triggerCls)}
>
{item.trigger}
</NavigationMenuTrigger>
<NavigationMenuContent
{...item.contentProps}
className={cn(contentCls, item.contentCls)}
>
{item.content}
</NavigationMenuContent>
</NavigationMenuItem>
)
}
return (
<NavigationMenuItem key={key} {...item.itemProps}>
<NavLinkItem
{...item}
className={cn(navigationMenuTriggerStyle(), item?.className)}
/>
</NavigationMenuItem>
)
})}
</NavigationMenuList>
</NavigationMenu>
)
}
export {
NavList,
NavLinkItem,
NavigationMenuWrapper,
type navMenuItemT,
type navMenuItemsT,
type navLinkItemT,
type navLinkItemsT,
}Installation
npm install @radix-ui/react-navigation-menuCopy and paste the following code into your project.
navigation-menu.tsx
import * as React from "react"
import * as NavigationMenuPrimitive from "@radix-ui/react-navigation-menu"
import { cva } from "class-variance-authority"
import { ChevronDownIcon } from "lucide-react"
import { cn } from "@/lib/utils"
function NavigationMenu({
className,
children,
viewport = true,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Root> & {
viewport?: boolean
}) {
return (
<NavigationMenuPrimitive.Root
data-slot="navigation-menu"
data-viewport={viewport}
className={cn(
"group/navigation-menu relative flex max-w-max flex-1 items-center justify-center",
className
)}
{...props}
>
{children}
{viewport && <NavigationMenuViewport />}
</NavigationMenuPrimitive.Root>
)
}
function NavigationMenuList({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.List>) {
return (
<NavigationMenuPrimitive.List
data-slot="navigation-menu-list"
className={cn(
"group flex flex-1 list-none items-center justify-center gap-1",
className
)}
{...props}
/>
)
}
function NavigationMenuItem({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Item>) {
return (
<NavigationMenuPrimitive.Item
data-slot="navigation-menu-item"
className={cn("relative", className)}
{...props}
/>
)
}
const navigationMenuTriggerStyle = cva(
"group inline-flex h-9 w-max items-center justify-center rounded-md bg-background px-4 py-2 text-sm font-medium hover:bg-accent hover:text-accent-foreground focus:bg-accent focus:text-accent-foreground disabled:pointer-events-none disabled:opacity-50 data-[state=open]:hover:bg-accent data-[state=open]:text-accent-foreground data-[state=open]:focus:bg-accent data-[state=open]:bg-accent/50 focus-visible:ring-ring/50 outline-none transition-[color,box-shadow] focus-visible:ring-[3px] focus-visible:outline-1"
)
function NavigationMenuTrigger({
className,
children,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Trigger>) {
return (
<NavigationMenuPrimitive.Trigger
data-slot="navigation-menu-trigger"
className={cn(navigationMenuTriggerStyle(), "group", className)}
{...props}
>
{children}{" "}
<ChevronDownIcon
className="relative top-[1px] ml-1 size-3 transition duration-300 group-data-[state=open]:rotate-180"
aria-hidden="true"
/>
</NavigationMenuPrimitive.Trigger>
)
}
function NavigationMenuContent({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Content>) {
return (
<NavigationMenuPrimitive.Content
data-slot="navigation-menu-content"
className={cn(
"data-[motion^=from-]:animate-in data-[motion^=to-]:animate-out data-[motion^=from-]:fade-in data-[motion^=to-]:fade-out data-[motion=from-end]:slide-in-from-right-52 data-[motion=from-start]:slide-in-from-left-52 data-[motion=to-end]:slide-out-to-right-52 data-[motion=to-start]:slide-out-to-left-52 top-0 left-0 w-full p-2 pr-2.5 md:absolute md:w-auto",
"group-data-[viewport=false]/navigation-menu:bg-popover group-data-[viewport=false]/navigation-menu:text-popover-foreground group-data-[viewport=false]/navigation-menu:data-[state=open]:animate-in group-data-[viewport=false]/navigation-menu:data-[state=closed]:animate-out group-data-[viewport=false]/navigation-menu:data-[state=closed]:zoom-out-95 group-data-[viewport=false]/navigation-menu:data-[state=open]:zoom-in-95 group-data-[viewport=false]/navigation-menu:data-[state=open]:fade-in-0 group-data-[viewport=false]/navigation-menu:data-[state=closed]:fade-out-0 group-data-[viewport=false]/navigation-menu:top-full group-data-[viewport=false]/navigation-menu:mt-1.5 group-data-[viewport=false]/navigation-menu:overflow-hidden group-data-[viewport=false]/navigation-menu:rounded-md group-data-[viewport=false]/navigation-menu:border group-data-[viewport=false]/navigation-menu:shadow group-data-[viewport=false]/navigation-menu:duration-200 **:data-[slot=navigation-menu-link]:focus:ring-0 **:data-[slot=navigation-menu-link]:focus:outline-none",
className
)}
{...props}
/>
)
}
function NavigationMenuViewport({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Viewport>) {
return (
<div
className={cn(
"absolute top-full left-0 isolate z-50 flex justify-center"
)}
>
<NavigationMenuPrimitive.Viewport
data-slot="navigation-menu-viewport"
className={cn(
"origin-top-center bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-90 relative mt-1.5 h-[var(--radix-navigation-menu-viewport-height)] w-full overflow-hidden rounded-md border shadow md:w-[var(--radix-navigation-menu-viewport-width)]",
className
)}
{...props}
/>
</div>
)
}
function NavigationMenuLink({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Link>) {
return (
<NavigationMenuPrimitive.Link
data-slot="navigation-menu-link"
className={cn(
"data-[active=true]:focus:bg-accent data-[active=true]:hover:bg-accent data-[active=true]:bg-accent/50 data-[active=true]:text-accent-foreground hover:bg-accent hover:text-accent-foreground focus:bg-accent focus:text-accent-foreground focus-visible:ring-ring/50 [&_svg:not([class*='text-'])]:text-muted-foreground flex flex-col gap-1 rounded-sm p-2 text-sm transition-all outline-none focus-visible:ring-[3px] focus-visible:outline-1 [&_svg:not([class*='size-'])]:size-4",
className
)}
{...props}
/>
)
}
function NavigationMenuIndicator({
className,
...props
}: React.ComponentProps<typeof NavigationMenuPrimitive.Indicator>) {
return (
<NavigationMenuPrimitive.Indicator
data-slot="navigation-menu-indicator"
className={cn(
"data-[state=visible]:animate-in data-[state=hidden]:animate-out data-[state=hidden]:fade-out data-[state=visible]:fade-in top-full z-[1] flex h-1.5 items-end justify-center overflow-hidden",
className
)}
{...props}
>
<div className="bg-border relative top-[60%] h-2 w-2 rotate-45 rounded-tl-sm shadow-md" />
</NavigationMenuPrimitive.Indicator>
)
}
export {
NavigationMenu,
NavigationMenuList,
NavigationMenuItem,
NavigationMenuContent,
NavigationMenuTrigger,
NavigationMenuLink,
NavigationMenuIndicator,
NavigationMenuViewport,
navigationMenuTriggerStyle,
}navigation-menu-wrapper.tsx
"use client"
import Link, { type LinkProps } from "next/link"
import { cn } from "@/lib/utils"
import {
NavigationMenu,
NavigationMenuList,
NavigationMenuItem,
NavigationMenuTrigger,
NavigationMenuContent,
NavigationMenuLink,
navigationMenuTriggerStyle,
} from "@/components/ui/navigation-menu"
type navLinkItemT = LinkProps & {
children: React.ReactNode
className?: string
}
type navLinkItemsT = navLinkItemT[]
type navMenuItemT = {
key: string
itemProps?: React.ComponentProps<typeof NavigationMenuItem>
} & (
| {
trigger: React.ReactNode
content: React.ReactNode
triggerCls?: string
contentCls?: string
contentProps?: React.ComponentProps<typeof NavigationMenuContent>
}
| navLinkItemT
)
type navMenuItemsT = navMenuItemT[]
function NavLinkItem({ children, className, ...props }: navLinkItemT) {
return (
<NavigationMenuLink asChild>
<Link {...props} className={cn("flex flex-row items-center gap-2", className)}>
{children}
</Link>
</NavigationMenuLink>
)
}
type listWrapperProps = {
items: navLinkItemsT
wrapperCls?: string
}
function NavList({ items, wrapperCls }: listWrapperProps) {
return (
<ul className={wrapperCls}>
{items.map((item, i) => (
<li key={i}>
<NavLinkItem
{...item}
className={item.className}
/>
</li>
))}
</ul>
)
}
type wrapperProps = React.ComponentProps<typeof NavigationMenu> & {
items: navMenuItemsT
triggerCls?: string
contentCls?: string
}
function NavigationMenuWrapper({
items,
className,
triggerCls,
contentCls,
...props
}: wrapperProps) {
return (
<NavigationMenu className={className} {...props}>
<NavigationMenuList>
{items.map(itemWrap => {
const { key, ...item } = itemWrap
if ("trigger" in item) {
return (
<NavigationMenuItem key={key} {...item.itemProps}>
<NavigationMenuTrigger
asChild={typeof item.trigger !== "string"}
className={cn(triggerCls, item.triggerCls)}
>
{item.trigger}
</NavigationMenuTrigger>
<NavigationMenuContent
{...item.contentProps}
className={cn(contentCls, item.contentCls)}
>
{item.content}
</NavigationMenuContent>
</NavigationMenuItem>
)
}
return (
<NavigationMenuItem key={key} {...item.itemProps}>
<NavLinkItem
{...item}
className={cn(navigationMenuTriggerStyle(), item?.className)}
/>
</NavigationMenuItem>
)
})}
</NavigationMenuList>
</NavigationMenu>
)
}
export {
NavList,
NavLinkItem,
NavigationMenuWrapper,
type navMenuItemT,
type navMenuItemsT,
type navLinkItemT,
type navLinkItemsT,
}Done
You can now use NavigationMenuWrapper, NavList, and NavLinkItem.
Usage
Complex
import { CircleHelpIcon } from "lucide-react"
import { NavigationMenuWrapper, NavLinkItem, NavList } from "@/components/ui/navigation-menu-wrapper"
export function Complex() {
const dropdownOptions = ["Option 1", "Option 2", "Option 3"]
return (
<NavigationMenuWrapper
items={[
{
key: "home",
trigger: "Home",
content: (
<div className="p-2 w-[250px]">
<NavList
items={[
{ href: "/", children: "Dashboard" },
{ href: "/about", children: "About Us" },
]}
/>
</div>
),
}, {
key: "pricing",
href: "/pricing",
children: "Pricing",
},
{
key: "features",
trigger: "Features",
content: (
<div className="p-2 w-[300px]">
<div className="text-lg font-semibold">Product Features</div>
<NavList
items={[
{ href: "/fast", children: "Fast Performance" },
{ href: "/secure", children: "Secure Infrastructure" },
{
href: "/todo",
children: <><CircleHelpIcon className="size-4" /> Backlog</>,
},
]}
/>
<NavLinkItem href="/dashbard" >
Dashboard
</NavLinkItem>
</div>
),
}
]}
/>
)
}Reference
Component Hierarchy
NavigationMenuWrapper (Main component)
└─ NavigationMenuList
└─ NavigationMenuItem (repeated for each item)
├─ NavLinkItem (for type="link")
│ └─ Next.js Link
│
└─ NavigationMenuTrigger + Content (for type="trigger")
├─ Trigger element
└─ NavigationMenuContent
└─ Custom content (can include NavList)
NavList (Standalone component)
└─ <ul>
└─ <li> (repeated for each item)
└─ NavLinkItem
└─ Next.js LinkNavLinkItem
Prop
Type
NavList
Prop
Type
NavigationMenuItem
Common
Prop
Type
Link type
Prop
Type
Trigger-Content
Prop
Type
NavigationMenuWrapper
Prop
Type