feat!: add component guards onBeforeRouteLeave and onBeforeRouteUpdate
#13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…date` - update documentation - upgrade required `@vue/composition-api` for proper `.proxy` usage BREAKING CHANGE: `@vue/composition-api` minimal version required is `1.0.0`
|
Hi! thanks for this PR! |
davidmeirlevy
requested changes
Mar 20, 2022
| Adds a navigation guard that triggers whenever the component for the current location is about to be left. Similar to `beforeRouteUpdate` and `beforeRouteLeave` but can be used in any component. The guard is removed when the component is unmounted. | ||
|
|
||
| ```js | ||
| import { onBeforeRouteLeave, onBeforeRouteUpdate } from 'vue-router-compositions' |
There was a problem hiding this comment.
the naming convention for hooks should be "useX", so please just provide the hooks names using that convention. 🙏
There was a problem hiding this comment.
Not for hooks... the hooks coming from vue-router itself are called onBeforeRouteLeave and onBeforeRouteUpdate, as can be seen on their documentation.
I named them the same because they are, basically, drop ins for people who cannot migrate to vue 3 + vue-router 4 yet. That way, when they migrate, they just have to change from vue-router-compositions to vue-router, and nothing else.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE:
@vue/composition-apiminimal version required is1.0.0There is no other tests in the project, so I've created none. I can do it if required.
I did not test this yet, but it should work, judging by the code found here.
Will test it later, but you can pre-review it until I can get to testing.