How to get current name of route in Vue?

Vue 3 + Vue Router 4

Update 5/03/2021

If you are using Vue 3 and Vue Router 4, here is two simplest ways to get current name of route in setup hook:

Solution 1: Use useRoute

import { useRoute } from 'vue-router';
export default {
  setup () {
    const route = useRoute()
    const currentRouteName = computed(() => route.name)
    return { currentRouteName }
  }
}

Solution 2: Use useRouter

import { useRouter } from 'vue-router';
export default {
  setup () {
    const router = useRouter()
    const currentRouteName = computed(() => router.currentRoute.value.name;)
    return { currentRouteName }
  }
}

I use this...

this.$router.history.current.path

In Composition API, this works

import { useRouter } from 'vue-router'

const router = useRouter()

let currentPathObject = router.currentRoute.value; 
 
console.log("Route Object", currentPathObject)

// Pick the values you need from the object

I used something like this:

import { useRoute } from 'vue-router';

then declared

const route = useRoute();

Finally if you log route object - you will get all properties I used path for my goal.

In Vue 3.2 using Composition API

<script lang="ts" setup>
  
  import { useRoute } from "vue-router";

  const route = useRoute();

  const currentRouteName = computed(() => {
    return route.name;
  });

</script>

<template>
  <div>
   Using computed:{{currentRouteName}} 
   or without using computed: {{route.name}}
  </div>
</template>

This is how you can access AND watch current route's name using @vue/composition-api package with Vue 2 in TypeScript.

<script lang="ts">
import { defineComponent, watch } from '@vue/composition-api';

export default defineComponent({
  name: 'MyCoolComponent',
  setup(_, { root }) {
    console.debug('current route name', root.$route.name);

    watch(() => root.$route.name, () => {
      console.debug(`MyCoolComponent- watch root.$route.name changed to ${root.$route.name}`);
    });
  },
});
</script>

I will update this answer once Vue 3.0 and Router 4.0 gets released!

I use this...

this.$route.name

Using Vue 3 and Vue Router 4 with Composition API and computed:

<script setup>
    import { computed } from 'vue'
    import { useRouter } from 'vue-router'

    const router = useRouter()

    // computed
    const currentRoute = computed(() => {
        return router.currentRoute.value.name
    })
</script>

<template>
    <div>{{ currentRoute }}</div>
</template>

⚠ If you don't set a name in your router like so, no name will be displayed:

const routes = [
    { path: '/step1', name: 'Step1', component: Step1 },
    { path: '/step2', name: 'Step2', component: Step2 },
];

In my Laravel app I created a router.js file and I can access the router object in any vue component like this.$route

I usually get the route like this.$route.path

Using composition API,

<template>
 <h1>{{Route.name}}</h1>
</template>

<script setup>
import {useRoute} from 'vue-router';

const Route = useRoute();
</script>

this.$router.currentRoute.value.name;

Works just like this.$route.name.

This is how you can get id (name) of current page in composition api (vue3):

import { useRoute } from 'vue-router';

export function useFetchPost() {
  const currentId = useRoute().params.id;
  const postTitle = ref('');

  const fetchPost = async () => {
        try {
        const response = await axios.get(
      `https://jsonplaceholder.typicode.com/posts/${currentId}`
    );
        postTitle.value = response.data.title;
      } catch (error) {
        console.log(error);
      } finally {
      }
  };

onMounted(fetchPost);

return {
  postTitle,
};

}

I'm using this method on vue 3 & vue-router 4
It works great!

<script>
import { useRoute } from 'vue-router'

export default {
    name: 'Home',
    setup() {
        const route = useRoute();
        const routeName = route.path.slice(1); //route.path will return /name

        return {
            routeName
        }
    }
};
</script>

<p>This is <span>{{ routeName }}</span></p>

I've Tried and it Worked:

Use Following in Your Elements;

{{ this.$route.path.slice(1) }}

Vue 3 + Vue Router 4 + Pinia store (or any other place outside of vue components)

@KitKit up there gave an example how to get route if you are using Vue 3 and Vue Router 4 in setup hook. However, what about state management in Pinia store ?

In vue@2 and [email protected]: We could have used router.currentRoute.query.returnUrl like so (example in vuex state management):

import router from "@/router";

const state = initialState;
const getters = {};
const actions = { // your actions };
const mutations = {
    loginSuccess(state, user) {
        let returnUrl = "";
        if(router.currentRoute.query.returnUrl != undefined)
            returnUrl = router.currentRoute.query.returnUrl;
    },
};

export default {
    state,
    getters,
    actions,
    mutations,
};

export const authentication = {
    actions: {},
    mutations: {},
};

In vue@3 and vue-router@4: We have to append value to currentRoute like so:

import router from '@/router';

export const authenticationStore = defineStore('authUser', {
    state: (): State => ({
        // your state
    }),
    getters: {
        // your getters
    },
    actions: {
        loginSuccess(user: object) {
            let returnUrl = '';
            if (router.currentRoute.value.query.returnUrl != undefined)
                returnUrl = router.currentRoute.value.query.returnUrl;
        },
    },
});

<script lang="ts" setup>
import { useRouter } from 'vue-router'
const router = useRouter()
const currentRouteName = router.currentRoute.value.fullPath