MCPcopy
hub / github.com/vuejs/router

github.com/vuejs/router @v5.1.0 sqlite

repository ↗ · DeepWiki ↗ · release v5.1.0 ↗
991 symbols 3,111 edges 278 files 163 documented · 16%
README

vue-router nmp version test codecov

To see what versions are currently supported, please refer to the Security Policy.

Supporting Vue Router

Vue Router is part of the Vue Ecosystem and is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:

Gold Sponsors

<a href="https://www.coderabbit.ai/?utm_source=vuerouter&utm_medium=sponsor" target="_blank" rel="noopener noreferrer">






  <img src="https://posva-sponsors.pages.dev/logos/coderabbitai-light.svg" height="72px" alt="CodeRabbit" />

Silver Sponsors

<a href="https://www.vuemastery.com/" target="_blank" rel="noopener noreferrer">






  <img src="https://posva-sponsors.pages.dev/logos/vuemastery-light.svg" height="42px" alt="VueMastery" />

  <img src="https://posva-sponsors.pages.dev/logos/controla-light.png" height="42px" alt="Controla" />

  <img src="https://posva-sponsors.pages.dev/logos/sendcloud-light.svg" height="42px" alt="SendCloud" />

Bronze Sponsors

<a href="https://www.rtvision.com/" target="_blank" rel="noopener noreferrer">






  <img src="https://avatars.githubusercontent.com/u/8292810" height="26px" alt="RTVision" />

  <img src="https://posva-sponsors.pages.dev/logos/storyblok.png" height="26px" alt="Storyblok" />


Get started with the documentation.

Quickstart

  • In-browser playground
  • Add it to an existing Vue Project:

bash npm install vue-router@5

Contributing

See Contributing Guide.

Special Thanks

BrowserStack Logo

Special thanks to BrowserStack for letting the maintainers use their service to debug browser specific issues.

Extension points exported contracts — how you extend this code

MatcherPattern (Interface)
(no doc) [4 implementers]
packages/router/src/experimental/route-resolver/matchers/matcher-pattern.ts
TypesConfig (Interface)
(no doc)
packages/playground-file-based/src/routes.d.ts
Window (Interface)
(no doc)
packages/playground/src/main.ts
RunOptions (Interface)
(no doc)
scripts/release.ts
LocationPartial (Interface)
* Location object accepted by `stringifyURL`. * * @internal
packages/router/src/location.ts
RouteNamedMap (Interface)
(no doc)
packages/playground-file-based/src/routes.d.ts
RouteNamedMap (Interface)
(no doc)
packages/playground/src/main.ts
RunResult (Interface)
(no doc)
scripts/release.ts

Core symbols most depended-on inside this repo

insert
called by 495
packages/router/src/unplugin/core/tree.ts
push
called by 488
packages/router/src/history/common.ts
resolve
called by 216
packages/router/src/experimental/router.ts
match
called by 179
packages/router/src/experimental/route-resolver/matchers/matcher-pattern.ts
push
called by 120
packages/router/src/experimental/router.ts
toHaveBeenWarned
called by 106
packages/router/__tests__/vitest-mock-warn.ts
build
called by 101
packages/router/src/experimental/route-resolver/matchers/matcher-pattern.ts
createMemoryHistory
called by 98
packages/router/src/history/memory.ts

Shape

Function 603
Interface 191
Method 149
Class 38
Enum 10

Languages

TypeScript100%

Modules by API surface

packages/router/src/experimental/router.ts49 symbols
packages/router/src/unplugin/core/treeNodeValue.ts48 symbols
packages/router/src/unplugin/core/tree.ts46 symbols
packages/router/src/router.ts30 symbols
packages/router/src/unplugin/core/utils.ts24 symbols
packages/router/src/matcher/index.ts23 symbols
packages/router/src/unplugin/core/extendRoutes.ts21 symbols
packages/router/src/experimental/data-loaders/defineColadaLoader.ts20 symbols
packages/router/src/types/index.ts18 symbols
packages/router/src/history/html5.ts17 symbols
packages/router/src/unplugin/core/context.ts16 symbols
packages/router/src/unplugin/codegen/generateParamParsers.ts15 symbols

Dependencies from manifests, versioned

@babel/generator8.0.0-rc.4 · 1×
@babel/types8.0.0-rc.4 · 1×
@clack/prompts
@pinia/colada1.3.1 · 1×
@playwright/test1.59.1 · 1×
@rollup/plugin-commonjs28.0.9 · 1×
@rollup/plugin-node-resolve16.0.3 · 1×
@rollup/plugin-replace6.0.3 · 1×
@rollup/plugin-terser0.4.4 · 1×
@shikijs/vitepress-twoslash3.23.0 · 1×
@tsconfig/node2222.0.5 · 1×

For agents

$ claude mcp add router \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact