-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #255 from nextcloud-libraries/fix/do-not-depend-on…
…-vue fix: Do not depend on vue or vue-router for the public interface of `OC.Files.Router`
- Loading branch information
Showing
3 changed files
with
55 additions
and
131 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,58 @@ | ||
import type { Route } from 'vue-router' | ||
|
||
declare global { | ||
namespace Nextcloud.v27 { | ||
interface FilesRouter { | ||
/** | ||
* Trigger a route change on the files app | ||
* | ||
* @param path the url path, eg: '/trashbin?dir=/Deleted' | ||
* @param replace replace the current history (default false) | ||
* @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location | ||
*/ | ||
goTo(path: string, replace?: boolean): Promise<Route>; | ||
|
||
/** | ||
* Trigger a route change on the files App | ||
* | ||
* @param name the route name | ||
* @param params the route parameters | ||
* @param query the url query parameters | ||
* @param replace replace the current history | ||
* @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location | ||
*/ | ||
goToRoute( | ||
name?: string, | ||
params?: Record<string, string>, | ||
query?: Record<string, string | (string | null)[] | null | undefined>, | ||
replace?: boolean, | ||
): Promise<Route>; | ||
} | ||
declare namespace Nextcloud.v27 { | ||
type Dictionary<T> = { [index: string]: T } | ||
|
||
interface OC extends Nextcloud.v26.OC { | ||
interface Vue2RouteMeta extends Record<string | number | symbol, any> {} | ||
|
||
} | ||
interface Vue2Route { | ||
path: string | ||
name?: string | null | ||
hash: string | ||
query: Dictionary<string | (string | null)[]> | ||
params: Dictionary<string> | ||
fullPath: string | ||
matched: any[] | ||
redirectedFrom?: string | ||
meta?: Vue2RouteMeta | ||
} | ||
|
||
interface OCP extends Omit<Nextcloud.v26.OCP, 'Files'> { | ||
Files: { | ||
Router: FilesRouter | ||
} | ||
} | ||
interface FilesRouter { | ||
/** | ||
* Trigger a route change on the files app | ||
* | ||
* @param path the url path, eg: '/trashbin?dir=/Deleted' | ||
* @param replace replace the current history (default false) | ||
* @see https://v3.router.vuejs.org/guide/essentials/navigation.html | ||
*/ | ||
goTo(path: string, replace?: boolean): Promise<Vue2Route>; | ||
|
||
/** | ||
* Trigger a route change on the files App | ||
* | ||
* @param name the route name | ||
* @param params the route parameters | ||
* @param query the url query parameters | ||
* @param replace replace the current history | ||
* @see https://v3.router.vuejs.org/guide/essentials/navigation.html | ||
*/ | ||
goToRoute( | ||
name?: string, | ||
params?: Record<string, string>, | ||
query?: Record<string, string | (string | null)[] | null | undefined>, | ||
replace?: boolean, | ||
): Promise<Vue2Route>; | ||
} | ||
|
||
interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window { | ||
interface OC extends Nextcloud.v26.OC { | ||
|
||
} | ||
|
||
interface OCP extends Omit<Nextcloud.v26.OCP, 'Files'> { | ||
Files: { | ||
Router: FilesRouter | ||
} | ||
} | ||
} | ||
|
||
interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window { | ||
|
||
} | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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