UIPackage

Navigation Menu

Vue navigation
Edit on GitHub

Top-of-page horizontal navigation with hover/click triggered megamenus. Use for marketing sites and product navs that need rich content — featured links, mini-cards, and submenu columns.

Also available for React ->

Installation

$ npx shadcn-vue@latest add https://uipkge.dev/r/vue/navigation-menu.json

Or with the named registry: npx shadcn-vue@latest add @uipkge/navigation-menu

Examples

Props

Name Type / Values Default Required
class HTMLAttributes['class'] optional
viewport boolean true optional

Dependencies

Files (10)

  • app/components/ui/navigation-menu/NavigationMenu.vue 1.1 kB
    <script setup lang="ts">
    import type { NavigationMenuRootEmits, NavigationMenuRootProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuRoot, useForwardPropsEmits } from 'reka-ui'
    import { cn } from '@/lib/utils'
    import NavigationMenuViewport from './NavigationMenuViewport.vue'
    
    const props = withDefaults(
      defineProps<
        NavigationMenuRootProps & {
          class?: HTMLAttributes['class']
          viewport?: boolean
        }
      >(),
      {
        viewport: true,
      },
    )
    const emits = defineEmits<NavigationMenuRootEmits>()
    
    const delegatedProps = reactiveOmit(props, 'class', 'viewport')
    const forwarded = useForwardPropsEmits(delegatedProps, emits)
    </script>
    
    <template>
      <NavigationMenuRoot
        v-slot="slotProps"
        data-uipkge
        data-slot="navigation-menu"
        :data-viewport="viewport"
        v-bind="forwarded"
        :class="cn('group/navigation-menu relative flex max-w-max flex-1 items-center justify-center', props.class)"
      >
        <slot v-bind="slotProps" />
        <NavigationMenuViewport v-if="viewport" />
      </NavigationMenuRoot>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuContent.vue 2.3 kB
    <script setup lang="ts">
    import type { NavigationMenuContentEmits, NavigationMenuContentProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuContent, useForwardPropsEmits } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuContentProps & { class?: HTMLAttributes['class'] }>()
    const emits = defineEmits<NavigationMenuContentEmits>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    
    const forwarded = useForwardPropsEmits(delegatedProps, emits)
    </script>
    
    <template>
      <NavigationMenuContent
        data-uipkge
        data-slot="navigation-menu-content"
        v-bind="forwarded"
        :class="
          cn(
            'data-[motion^=from-]:motion-safe:animate-in data-[motion^=to-]:motion-safe:animate-out data-[motion^=from-]:motion-safe:fade-in data-[motion^=to-]:motion-safe:fade-out data-[motion=from-end]:motion-safe:slide-in-from-right-52 data-[motion=from-start]:motion-safe:slide-in-from-left-52 data-[motion=to-end]:motion-safe:slide-out-to-right-52 data-[motion=to-start]:motion-safe: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]:motion-safe:animate-in group-data-[viewport=false]/navigation-menu:data-[state=closed]:motion-safe:animate-out group-data-[viewport=false]/navigation-menu:data-[state=closed]:motion-safe:zoom-out-95 group-data-[viewport=false]/navigation-menu:data-[state=open]:motion-safe:zoom-in-95 group-data-[viewport=false]/navigation-menu:data-[state=open]:motion-safe:fade-in-0 group-data-[viewport=false]/navigation-menu:data-[state=closed]:motion-safe: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',
            props.class,
          )
        "
      >
        <slot />
      </NavigationMenuContent>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuIndicator.vue 1 kB
    <script setup lang="ts">
    import type { NavigationMenuIndicatorProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuIndicator, useForwardProps } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuIndicatorProps & { class?: HTMLAttributes['class'] }>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    
    const forwardedProps = useForwardProps(delegatedProps)
    </script>
    
    <template>
      <NavigationMenuIndicator
        data-uipkge
        data-slot="navigation-menu-indicator"
        v-bind="forwardedProps"
        :class="
          cn(
            'data-[state=visible]:motion-safe:animate-in data-[state=hidden]:motion-safe:animate-out data-[state=hidden]:motion-safe:fade-out data-[state=visible]:motion-safe:fade-in top-full z-[1] flex h-1.5 items-end justify-center overflow-hidden',
            props.class,
          )
        "
      >
        <div class="bg-border relative top-[60%] h-2 w-2 rotate-45 rounded-tl-sm shadow-md" />
      </NavigationMenuIndicator>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuItem.vue 0.6 kB
    <script setup lang="ts">
    import type { NavigationMenuItemProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuItem } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuItemProps & { class?: HTMLAttributes['class'] }>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    </script>
    
    <template>
      <NavigationMenuItem
        data-uipkge
        data-slot="navigation-menu-item"
        v-bind="delegatedProps"
        :class="cn('relative', props.class)"
      >
        <slot />
      </NavigationMenuItem>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuLink.vue 1.2 kB
    <script setup lang="ts">
    import type { NavigationMenuLinkEmits, NavigationMenuLinkProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuLink, useForwardPropsEmits } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuLinkProps & { class?: HTMLAttributes['class'] }>()
    const emits = defineEmits<NavigationMenuLinkEmits>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    const forwarded = useForwardPropsEmits(delegatedProps, emits)
    </script>
    
    <template>
      <NavigationMenuLink
        data-uipkge
        data-slot="navigation-menu-link"
        v-bind="forwarded"
        :class="
          cn(
            'data-active:focus:bg-accent data-active:hover:bg-accent data-active:bg-accent/50 data-active:text-accent-foreground hover:bg-accent hover:text-accent-foreground focus:bg-accent focus:text-accent-foreground ring-ring/10 dark:ring-ring/20 dark:outline-ring/40 outline-ring/50 [&_svg:not([class*=\'text-\'])]:text-muted-foreground flex flex-col gap-1 rounded-sm p-2 text-sm transition-[color,box-shadow] focus-visible:ring-4 focus-visible:outline-1 [&_svg:not([class*=\'size-\'])]:size-4',
            props.class,
          )
        "
      >
        <slot />
      </NavigationMenuLink>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuList.vue 0.7 kB
    <script setup lang="ts">
    import type { NavigationMenuListProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuList, useForwardProps } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuListProps & { class?: HTMLAttributes['class'] }>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    
    const forwardedProps = useForwardProps(delegatedProps)
    </script>
    
    <template>
      <NavigationMenuList
        data-uipkge
        data-slot="navigation-menu-list"
        v-bind="forwardedProps"
        :class="cn('group flex flex-1 list-none items-center justify-center gap-1', props.class)"
      >
        <slot />
      </NavigationMenuList>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuTrigger.vue 1 kB
    <script setup lang="ts">
    import type { NavigationMenuTriggerProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { ChevronDown } from 'lucide-vue-next'
    import { NavigationMenuTrigger, useForwardProps } from 'reka-ui'
    import { cn } from '@/lib/utils'
    import { navigationMenuTriggerStyle } from './navigation-menu.variants'
    
    const props = defineProps<NavigationMenuTriggerProps & { class?: HTMLAttributes['class'] }>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    
    const forwardedProps = useForwardProps(delegatedProps)
    </script>
    
    <template>
      <NavigationMenuTrigger
        data-uipkge
        data-slot="navigation-menu-trigger"
        v-bind="forwardedProps"
        :class="cn(navigationMenuTriggerStyle(), 'group', props.class)"
      >
        <slot />
        <ChevronDown
          class="relative top-[1px] ml-1 size-3 transition duration-300 group-data-[state=open]:rotate-180"
          aria-hidden="true"
        />
      </NavigationMenuTrigger>
    </template>
  • app/components/ui/navigation-menu/NavigationMenuViewport.vue 1.2 kB
    <script setup lang="ts">
    import type { NavigationMenuViewportProps } from 'reka-ui'
    import type { HTMLAttributes } from 'vue'
    import { reactiveOmit } from '@vueuse/core'
    import { NavigationMenuViewport, useForwardProps } from 'reka-ui'
    import { cn } from '@/lib/utils'
    
    const props = defineProps<NavigationMenuViewportProps & { class?: HTMLAttributes['class'] }>()
    
    const delegatedProps = reactiveOmit(props, 'class')
    
    const forwardedProps = useForwardProps(delegatedProps)
    </script>
    
    <template>
      <div class="absolute top-full left-0 isolate z-50 flex justify-center">
        <NavigationMenuViewport
          data-uipkge
          data-slot="navigation-menu-viewport"
          v-bind="forwardedProps"
          :class="
            cn(
              'origin-top-center bg-popover text-popover-foreground data-[state=open]:motion-safe:animate-in data-[state=closed]:motion-safe:animate-out data-[state=closed]:motion-safe:zoom-out-95 data-[state=open]:motion-safe:zoom-in-90 relative left-[var(--reka-navigation-menu-viewport-left)] mt-1.5 h-[var(--reka-navigation-menu-viewport-height)] w-full overflow-hidden rounded-md border shadow md:w-[var(--reka-navigation-menu-viewport-width)]',
              props.class,
            )
          "
        />
      </div>
    </template>
  • app/components/ui/navigation-menu/navigation-menu.variants.ts 0.9 kB
    import type { VariantProps } from 'class-variance-authority'
    import { cva } from 'class-variance-authority'
    
    /**
     * Variant definitions live in their own file (rather than the package
     * `index.ts`) so consuming Vue SFCs can import without creating a circular
     * dependency through the index. See card.variants.ts for the canonical
     * example + the SSR symptom that motivated the split.
     */
    
    export 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',
    )
  • app/components/ui/navigation-menu/index.ts 0.8 kB
    export { default as NavigationMenu } from './NavigationMenu.vue'
    export { default as NavigationMenuContent } from './NavigationMenuContent.vue'
    export { default as NavigationMenuIndicator } from './NavigationMenuIndicator.vue'
    export { default as NavigationMenuItem } from './NavigationMenuItem.vue'
    export { default as NavigationMenuLink } from './NavigationMenuLink.vue'
    export { default as NavigationMenuList } from './NavigationMenuList.vue'
    export { default as NavigationMenuTrigger } from './NavigationMenuTrigger.vue'
    export { default as NavigationMenuViewport } from './NavigationMenuViewport.vue'
    
    // Re-export variant API from the sibling file (kept separate to avoid the
    // Component.vue <-> index.ts circular import that broke dev SSR for Card).
    export { navigationMenuTriggerStyle } from './navigation-menu.variants'

Raw manifest: https://uipkge.dev/r/vue/navigation-menu.json