aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files/src/services/RouterService.ts
diff options
context:
space:
mode:
authorFerdinand Thiessen <opensource@fthiessen.de>2024-08-08 13:51:33 +0200
committerFerdinand Thiessen <opensource@fthiessen.de>2024-08-08 13:51:33 +0200
commitdab678f7c502acc126b9956529deb21223546a9c (patch)
tree0fb2be0d43432df71508b0002286fc7789045158 /apps/files/src/services/RouterService.ts
parent2777cf90e333bf57491784812148c6b3db437c85 (diff)
downloadnextcloud-server-fix/make-router-reactive.tar.gz
nextcloud-server-fix/make-router-reactive.zip
[WIP] Make router interface reactive while being framework agnosticfix/make-router-reactive
Currently it is only reactive when used within the files app, because the files app can access the vue router directly, problem is when other apps use it, then it is not reactive anymore as they have a different Vue. Also if you do not use Vue but vanilla JS or something else, the router params and query would not be reactive. Problem that this is solving: React to route changes only, watching current view and query will trigger on different time frames causing invalid states. e.g. changing the view from A to B and the query from `/foo` to `/` will cause: 1. View change 2. query change But after 1 the query is invalid and cause issues. So this changes will allow listening the route change which is combined 1 & 2 -> valid state. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
Diffstat (limited to 'apps/files/src/services/RouterService.ts')
-rw-r--r--apps/files/src/services/RouterService.ts37
1 files changed, 35 insertions, 2 deletions
diff --git a/apps/files/src/services/RouterService.ts b/apps/files/src/services/RouterService.ts
index 84516465495..65113eb32d7 100644
--- a/apps/files/src/services/RouterService.ts
+++ b/apps/files/src/services/RouterService.ts
@@ -4,14 +4,47 @@
*/
import type { Route } from 'vue-router'
import type VueRouter from 'vue-router'
-import type { Dictionary, Location } from 'vue-router/types/router'
+import type { Dictionary, Location } from 'vue-router/types/router.d.ts'
+import { TypedEventTarget } from 'typescript-event-target'
-export default class RouterService {
+interface NavigationEventData {
+ name: Route['name']
+ params: Route['params']
+ query: Route['query']
+}
+
+class NavigationEvent extends CustomEvent<NavigationEventData> {
+
+ constructor({ name, params, query }: Route) {
+ super('navigation', {
+ detail: {
+ name,
+ // Do not let API users mess with internal state of our VueRouter (e.g. if they use Vue it could conflict)
+ params: structuredClone(params),
+ query: structuredClone(query),
+ },
+ })
+ }
+
+}
+
+interface RouterEventMap {
+ navigation: NavigationEvent
+}
+
+export default class RouterService extends TypedEventTarget<RouterEventMap> {
private _router: VueRouter
constructor(router: VueRouter) {
+ super()
this._router = router
+ this._router.beforeEach((to, from, next) => {
+ // emit event
+ this.dispatchTypedEvent('navigation', new NavigationEvent(to))
+ // continue
+ next()
+ })
}
get name(): string | null | undefined {