Pass object through Link in react router

Question

Is it possible to pass an object via Link component in react-router?

Something like:
<Link to='home' params={{myObj: obj}}> Click </Link>

In the same way as I would pass props from the Parent to Child component.

If it's not possible what is the best way of achieving this:
I have a React + Flux app, and I render the table with some data. What I am trying to do is when I click on one of the rows it would take me to some details component for this row. The row has all of the data I need so I thought it would be great if I could just pass it through Link.

The other option would be to pass the id of the row in the url, read it in the details component and request the data from the store for by ID.

Not sure what is the best way of achieving the above...

Depending on how you fetch your data overall, I would say the latter option. — Henrik Andersson, Jul 01 '15 at 19:40

score 42 · Accepted Answer · edited May 23 '17 at 10:30

42

So my final conclusion on this question is that I didn't think it through properly. It seemed natural just to pass my data through the Link so I can access them in my Child component. As Colin Ramsay mentioned there is something called state in the Link but that's not the way to do it. It would work fine when the data is passed through Link only if the user clicks on something and is taken to the Child component.

The problem comes when the user accesses the url which is used in Link then there is no way to get the data.

So the solution in my case was to pass the ID in Link params and then check if my Store has the data (user accesses it via Link) and then getting this data from the Store.

Or if the data is not in the Store call the action to fetch the data from the API.

edited May 23 '17 at 10:30

Community

1
1

answered Jul 04 '15 at 09:59

knowbody

8,106
6
45
70

In react-router 3.0.0 the Link component doesn't have the "params" attribute. How is it done for the current version ? – Misi Dec 20 '16 at 15:31
What is a proper use case for the "state" property in Link if it won't work when the URL is accessed directly? – Hammerspace Feb 23 '20 at 22:35

Pixelomo · Answer 2 · 2019-12-03T18:01:34.673

15

It is possible to pass an object through a Link. (it's not best practice, but it's possible)

Add your data within a query rather than params and stringify the object:

<Link to={{ 
  pathname: `/blog/${post.id}`, 
  query: {
    title: post.title, 
    content: post.content,
    comments: JSON.stringify(post.comments)
  } 
}}>Read More...</Link>

Then in your child component parse the string back in to an object:

JSON.parse(this.props.comments)

edited Dec 03 '19 at 18:01

answered Jan 11 '18 at 01:43

Pixelomo

6,373
4
47
57

1

but you need to refer to the react router official documentation to see how to pass object ot `to` prop on link , it is the same for `NavLink` no difference here , yours are a little bit off of that but any way , upvoted... , but please update your answer for avoiding the future misguides .... – amdev Oct 24 '18 at 08:40
@a_m_dev thanks could expand on what you said? maybe posting your own answer based on what you saw on the docs would help future readers. looking at these docs https://reacttraining.com/react-router/web/api/NavLink – Pixelomo Oct 24 '18 at 23:10
@Pixelomo, How is the query object accessible in the component that the route renders? – Ren Oct 31 '18 at 06:53
@Ren see the end of my answer ```JSON.parse(this.props.comments)``` – Pixelomo Oct 31 '18 at 07:04
1

Try finding it under this.props.location.query.title . And you will be able to access the value. – Mukul Juneja Aug 09 '19 at 09:55

score 12 · Answer 3 · answered Jul 01 '15 at 23:38

12

No, you can't pass an object in params, so I would agree with you that your best plan is to pass the id to a store, have the store emit a CHANGE event, and have components query the store for info.

answered Jul 01 '15 at 23:38

Hal Helms

684
3
8

score 3 · Answer 4 · answered Jul 03 '15 at 16:12

3

This isn't possible, you need to pass something that can be stored in the URL such as a string ID. You would then use that ID to perform a lookup of the object.

answered Jul 03 '15 at 16:12

Colin Ramsay

16,086
9
52
57

The only alternative would be to pass the object as JSON but either way you would still be storing it in a form that gets stored in the URL. There's also a state prop for Link that you could look at but it's not the same thing. – Colin Ramsay Jul 03 '15 at 19:44

score 1 · Answer 5 · answered Dec 17 '15 at 22:01

1

You could try JSON serializing it and then de-serializing it on the receiving end.

answered Dec 17 '15 at 22:01

mzdv

817
9
17

score 0 · Answer 6 · answered Oct 28 '20 at 17:02

Using react-roter-dom ver 5.1.2 and es6

I solved the problem like this first I store it in the search part of Link to object meaning it is part of the url and supports a bookmark etc.

< Link to={{
          pathname: `${match.url}/${dogName}`,
          search: `choosenDog=${JSON.stringify({ ...dog })}` //dog is the object to pass along
        }
        } >

And then on the link we goto I get hold of it like this

const query = useQuery();
const dogString = query.get('choosenDog');
const dogObject  = JSON.parse(dogString);

Pass object through Link in react router

6 Answers6

Linked