What can $[route] do?

[Former Member]

Hi. I was just curious what the PB Variable $[route] can do. Can someone please explain it to me?

[Brian]

$[route] contains information about the type of page you're on. The $[route] variable itself doesn't do anything, but its subvariables have use.

$[route.name] can be used to distinguish between different types of pages. Its value will change depending on whether you're looking at the index page, a board, a thread, the posting page, etc.

$[route.params.page_id] does the same thing but for custom pages. The value it outputs will reflect the ID of the custom page you're currently viewing, assuming you're viewing one.

There's at least one more param that can show up, but again, it depends entirely on the page you're looking at. If you open your browser's console (usually by pressing F12) you can type in pb.data('route') to see what the $[route] variable will contain on that page.

[Former Member]

Jun 19, 2019 11:16:14 GMT -8 Brian said:

$[route] contains information about the type of page you're on. The $[route] variable itself doesn't do anything, but its subvariables have use.

$[route.name] can be used to distinguish between different types of pages. Its value will change depending on whether you're looking at the index page, a board, a thread, the posting page, etc.

$[route.params.page_id] does the same thing but for custom pages. The value it outputs will reflect the ID of the custom page you're currently viewing, assuming you're viewing one.

There's at least one more param that can show up, but again, it depends entirely on the page you're looking at. If you open your browser's console (usually by pressing F12) you can type in pb.data('route') to see what the $[route] variable will contain on that page.

So you could do:
{if $[route.name] == "Home"} This is home {/if}?

[Brian]

Yes, but it's case-sensitive, so "Home" wouldn't work because the route name is "home" (all lowercase).

[Former Member]

Okay thanks!

[Sam]

Jun 19, 2019 12:00:12 GMT -8 Brian said:

Yes, but it's case-sensitive, so "Home" wouldn't work because the route name is "home" (all lowercase).

How would this work with board names?

[Kitty Katt]

Jun 21, 2019 3:51:08 GMT -8 Sam said:

Jun 19, 2019 12:00:12 GMT -8 Brian said:

Yes, but it's case-sensitive, so "Home" wouldn't work because the route name is "home" (all lowercase).

How would this work with board names?

I read this post and it would seem like it is possible to use board ID's, such as:


{if $[route.params.board_id] == 44}I'm viewing the ProBoards Support Board!{/if}


with the board ID of 44 being the ID of the Support Board here on ProBoards. Naturally, you would use your own board ID for the board in question.

[Former Member]

So, what would $[route.params.board_id] 's equivalent be in JS?

[Lynx]

Jun 30, 2019 9:48:49 GMT -8 @smithj said:

So, what would $[route.params.board_id] 's equivalent be in JS?


pb.data('route').board_id


[Former Member]

Jun 30, 2019 14:30:45 GMT -8 Lynx said:

Jun 30, 2019 9:48:49 GMT -8 @smithj said:

So, what would $[route.params.board_id] 's equivalent be in JS?


pb.data('route').board_id


pb.data('route').board_nameCould that work?

[Sam]

Jun 30, 2019 17:59:47 GMT -8 @smithj said:

Jun 30, 2019 14:30:45 GMT -8 Lynx said:


pb.data('route').board_id


pb.data('route').board_nameCould that work?

You may need to try both, because I'm not sure if it will output the name or id.