Skip to content

docs($router): Note that router === this.$router #1687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 11, 2017
Merged

docs($router): Note that router === this.$router #1687

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
53593c7
docs($router): Note that router === this.$router
posva Aug 15, 2017
f151ded
docs($router): Chris review
posva Aug 15, 2017
1039ff5
docs($router): Phan review
posva Aug 15, 2017
bd3ad27
Merge branch 'dev' into docs/router
posva Aug 15, 2017
f758551
Merge branch 'dev' into docs/router
posva Oct 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/en/essentials/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,27 @@ const app = new Vue({
// Now the app has started!
```

By injecting the router, we get access to it as `this.$router` as well as the current route as `this.$route` inside of any component:

```js
// Home.vue
export default {
computed: {
params () {
// We will see what params are shortly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be

// We will see what `params` is shortly

since params here refers to the attribute's name.

return this.$route.params
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to update this to a more real-world example. For example:

username () {
  // We will see what params are shortly
  return this.$route.params.username
}

},
methods: {
someMethod () {
// Redirecting to another route
this.$router.push('/redirect')
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, a more real-world example could be helpful, so that readers can begin imagining when they might use this.$router. For example:

goBack () {
  window.history.length > 1
    ? this.$router.go(-1)
    : this.$router.push('/')
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another note: I'd probably avoid the word "redirect" here, as I think it implies an immediate transfer to another route in most cases - "navigate" or simple "go" are probably more appropriate.

}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we're missing a } here.

```

Thoroughly the docs, we will often use the `router` instance. Keep in mind that `this.$router` is exactly the same as using `router`. The reason we use `this.$router` is because we don't want to import the router in every single component that needs to manipulate routing.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoroughly -> Throughout

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I'm actually wondering now if this paragraph is even necessary. I feel like the idea that router === this.$router is made clear by:

By injecting the router, we get access to it as this.$router

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder as well, let's share with the team

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the kind of text I'd put inside of a warning p


You can also checkout this example [live](http://jsfiddle.net/yyx990803/xgrjzsup/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be check out (with a space), as "checkout" is a noun.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks, I'll fix other _checkout_s as well but in another commit


Notice that a `<router-link>` automatically gets the `.router-link-active` class when its target route is matched. You can learn more about it in its [API reference](../api/router-link.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it router-link.md or router-link.html?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gitbook transforms it automatically