Skip to content

Commit 8aa16fd

Browse files
committed
feat: Better TS support
1 parent 127a5c4 commit 8aa16fd

File tree

4 files changed

+117
-169
lines changed

4 files changed

+117
-169
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Please file an issue or make a PR if you spot any problems or you have any furth
1818
- [Installation](#installation)
1919
- [Usage & Examples](#usage-examples)
2020
- [New hooks for pages](#new-hooks-for-pages)
21+
- [TypeScript](#typescript)
2122
- [API & Limitations](#api-limitations)
2223
- [Troubleshooting](#troubleshooting)
2324

@@ -175,6 +176,9 @@ export default {
175176
| navigatedTo | `beforeRouteEnter` | To trigger it properly you need to access component instance. You can use `next(vm => ...)` callback within `beforeRouteEnter()`. Please check Vue-Router docs for more details. |
176177
| navigatedFrom | - | This event is tricky to control for developers. There is no exact mapping of it in the router. For store state cleanup use build-in meta dispatcher instead. For component state you could opt for using `beforeRouteLeave()`. |
177178

179+
## TypeScript Support
180+
If you need a TS support and it's not detected in your project for some reason, you can copy paste content of [typings/shims.vue.d.ts](https://github.com/MattCCC/nativescript-vue-router-extended/blob/master/src/typings/shims-vue.d.ts) file into your typings/ directory so to bring proper support in .vue files.
181+
178182
## API & Limitations
179183

180184
This plugin aims for compatibility with Vue Router 3+ and Vue Router 4+. Both should be easily supported. Please refer to [Vue Router Docs](https://next.router.vuejs.org/guide/) for more information. There are some obvious limitations like lack of DOM accessibility and related events, or lack of <router-link /> component.

0 commit comments

Comments
 (0)