vue-router-navigation

vue-router helper for generating navigation links when using deeply nested paths.

Install

npm install vue-router-navigation

Use

Given a set of nested vue-router pages, such as:

• /orders/123 — main order page
• /orders/123/details/address — order address details
• /orders/123/details/billing — order billing details
• /orders/123/tracking — order tracking

Generate navigation links for Order, Details and Tracking in pages/orders/[order_id].vue:

<script setup lang="ts">
import { useRouteNavigation } from "vue-router-navigation"

const { prefix } = useRouteNavigation()
</script>

<template>
  <div>
    <nuxt-link :href="prefix">
      Order
    </nuxt-link>
    <nuxt-link :href="`${prefix}/details`">
      Details
    </nuxt-link>
    <nuxt-link :href="`${prefix}/tracking`">
      Tracking
    </nuxt-link>
  </div>
  <router-view />
</template>

Generate navigation links for Address and Billing in pages/orders/[order_id]/details.vue:

<script setup lang="ts">
import { useRouteNavigation } from "vue-router-navigation"

const { prefix } = useRouteNavigation()
</script>

<template>
  <div>
    <nuxt-link :href="`${prefix}/address`">
      Address
    </nuxt-link>
    <nuxt-link :href="`${prefix}/billing`">
      Billing
    </nuxt-link>
  </div>
  <router-view />
</template>

Active page

Sometimes vue-router auto-injected CSS classes are not enough. You can explicitly check the active page with:

<script setup lang="ts">
import { useRouteNavigation } from "vue-router-navigation"

const { prefix, page } = useRouteNavigation()
</script>

<template>
  <ul>
    <li :class="{ active: !page }">
      <nuxt-link :href="prefix">
        Order
      </nuxt-link>
    </li>
    <li :class="{ active: page === 'details' }">
      <nuxt-link :href="`${prefix}/details`">
        Details
      </nuxt-link>
    </li>
    <li :class="{ active: page === 'tracking' }">
      <nuxt-link :href="`${prefix}/tracking`">
        Tracking
      </nuxt-link>
    </li>
  </ul>
  <router-view />
</template>

Nuxt

For Nuxt, create composables/router-navigation.ts:

import { useRoute } from "nuxt/app"
import { useRouteNavigation as useRouteNavigationBase } from "vue-router-navigation"

export const useRouteNavigation = () => useRouteNavigationBase(useRoute())

TODO: implement this as a Nuxt module.