Vue, is there a way to pass data between routes without URL params?

38.7k views Asked by At

I am looking how to pass data secretly between two separate components (not parent and child) without using URL params in my Vue2 app. This doesn't mean I am passing secrets but rather I just dont want the user to see it (only for UI considerations).

I know Vue has Props but they are meant for passing data between parent and child component. In my case, my URL will change but I don't want to pass data via visible params.

Someone claimed to use props without URL params here but I haven't been able to reproduce a working solution (getting undefined each time).

I also checked out these options but they are all using either URL or query params which as we know are visible.

An ugly solution would be to write the data to local storage and then read it there but this creates a lot of overhead and complexity (like what if I only want this data to be read once, etc).

Is there a more elegant solution to this problem?

Thanks!

3

There are 3 answers

8
Mayank Kumar Chaudhari On
  1. make props: true for the destination route -- in the index.js file of router

    {
      path: '/home',
      name: 'home',
      component: taskChooser,
      props: true,
      }

  1. define prop in the component e.g props: ['myprop'], - note the quotes

  2. copy the variable you want to pass from the source route into the same name as your prop - in this case myprop

myprop = theVariableThatYouWantToPass

this.$router.replace({name:'home', params:{myprop}});

Make sure that the name of prop and variable are same - the prop is in quotes.

It's working for me.

5
KasparTr On

Thanks @Mayank for pointing me in the correct direction.

Here is the correct syntax that worked for me.

  1. Notice the props in In router index

    {
      path: '/componentPath',
      name: 'componentName',
      props: {
         header: true,
         content: true
      },
    }
    
  2. In the component you are redirecting to, define the props as following:

    props: {
      myProperty: {
        type: <DATATYPE>
      },
    }
    
  3. Perform redirect as following:

    this.$router.push({
      name: 'componentName',
      params: {
        myProperty: <VARIABLE>
      }
    })
    
  4. Access props with the this. convention from created or in later lifecycle event.

In this case, the variable name and property name do not have to be the same as it is a simple map. That naming convention would be a curious design choice anyway.

1
agm1984 On

I haven't tested this in Vue 2, but in Vue 3, you can pass a stringified object through the props when you click on a link:

  1. Add props: true to your routes file, for the route.

         {
             path: 'receipt',
             name: 'receipt',
             component: () => import('../pages/Receipt.vue'),
             props: true,
             beforeEnter(to, from, next) {
                 if (!to.params.receiptData) {
                     return next({
                         name: 'dashboard',
                         params: {
                             locale: from.params.locale ? from.params.locale : 'en',
                         },
                     });
                 }
    
                 return next();
             },
         },
    
  2. Include your stringified object as a param for router.push().

        const receiptData = {
             transferType: 'default',
             recipient: receiver.value.name,
             referenceNumber: '#B3423424234',
             amountSent: formAmount,
             transferFee: 0,
         };
    
         router.push({
             name: 'receipt',
             params: {
                 receiptData: JSON.stringify(receiptData),
             },
         });
    
  3. Declare the props as instance data in the component.

     <script setup>
     import { computed } from 'vue';
    
     const props = defineProps({
       receiptData: {
           type: String,
           required: true,
       },
     })
     console.log('receiptData', props.receiptData);
    
     const parsedReceiptData = computed(() => JSON.parse(props.receiptData));
    
     </script>
    

I haven't tested an upper limit for size, so be careful about passing a huge object through, and you'll notice I showed a beforeEnter middleware on the route too because, if the user presses F5 to refresh the page, the props will be lost, so in my case, I redirect the user away from the page because the receipt is for one time use only.