4.0.2 (2020-12-27)

Bug Fixes

matcher: clear customRe after consuming buffer (#680) (4c0b825), closes #679
router: allow replace to have query and hash (6a8ccb6), closes #668
router: do not restore history when ... (db267be), closes #662
router-view: disable inheritAttrs (1e58574), closes #674
types: add missing exported types (034c71c)
spread operator compatible (a2f3e91)

4.0.1 (2020-12-07)

Bug Fixes

build: rollback rollup plugin commonjs (9486950)

4.0.0 (2020-12-07)

Bug Fixes

router-view: properly use route prop when nested (b74051a)
router-view: return one node when possible (d18e500), closes #537

Features

expose routerViewLocationKey as internal (f498646)

4.0.0-rc.6 (2020-11-30)

Bug Fixes

guards: correctly reuse guards (#616) (95d44c8), closes #614

Features

devtools: improve active + match in routes inspector (9f59489)
types: expose LocationQueryValueRaw as internal (dc02850)

4.0.0-rc.5 (2020-11-21)

Features

scroll: allow modifying scrollBehavior in options (#602) (d6651f5)

4.0.0-rc.4 (2020-11-20)

Features

expose symbols as internals (ef62d96)

4.0.0-rc.3 (2020-11-14)

Bug Fixes

trigger redirect on popstate (#592) (18dbdc2)
query: encode space as + (4d3dd5f), closes #561

4.0.0-rc.2 (2020-11-05)

Features

expose injection symbols as internals (0056aca)
devtools: add devtools plugin (894d50d)
devtools: add more (ee07302)
devtools: better search (5d68a29)
devtools: support multiple router instances (2e5d0d4)

4.0.0-rc.1 (2020-10-23)

Features

warn: improve warning for invalid components (5985b65), closes #517

4.0.0-beta.13 (2020-10-02)

Bug Fixes

encoding: decode hash in string location (11acb3d)
encoding: differentiate keys and values in query (a967e42)
encoding: keep decoded hash when resolving (1a8ffc1)
hash: only pushState the hash part (2a14c19), closes #495

Features

warn: help migrating catch all routes (14e1eb9)
print errors from lazy loading (f6db91a), closes #497

4.0.0-beta.12 (2020-09-25)

Bug Fixes

types: extend @vue/runtime-core module (#473) (556cd4b)

4.0.0-beta.11 (2020-09-20)

Bug Fixes

use post flush in modal example (2024281)
guards: use post watcher for instances (3234c59)

4.0.0-beta.10 (2020-09-18)

Bug Fixes

history: gracefully handle empty state (cbcf2a9), closes #366
types: better type for navigate (0384cb0)
types: explicit types on navigate (36d218c)
types: fix types for redirect records (a77f148)
warn: correctly warn against unused next (47cd7b9)

Code Refactoring

types: Rename ScrollBehavior to RouterScrollBehavior (9fc0996)

Features

router: remove partial Promise from router.go (6ed6eee)
types: allow extending meta fields (#407) (706e84f)
warn: point to scrollBehavior in message (70ce7fe)

BREAKING CHANGES

router: The router.go() methods doesn't return anything (like in Vue Router 3) anymore. The existing implementation was wrong as it would resolve the promise for the following navigation if router.go() was called with something that wasn't possible e.g. router.go(-20) right after entering the application would not do anything. Even worse, the promise returned by that call would resolve after the next navigation. There is no proper native API to implement this promise-based api properly, but one can write a version that should work in most scenarios by setting up multiple hooks right before calling router.go():

export function go(delta) {
  return new Promise((resolve, reject) => {
    function popStateListener() {
      clearTimeout(timeout)
    }
    window.addEventListener('popstate', popStateListener)

    function clearHooks() {
      removeAfterEach()
      removeOnError()
      window.removeEventListener('popstate', popStateListener)
    }

    // if the popstate event is not called, consider this a failure
    const timeout = setTimeout(() => {
      clearHooks()
      reject(new Error('Failed to use router.go()'))
      // It's unclear of what value would always work here
    }, 10)

    setImmediate

    const removeAfterEach = router.afterEach((_to, _from, failure) => {
      clearHooks()
      resolve(failure)
    })
    const removeOnError = router.onError(err => {
      clearHooks()
      reject(err)
    })

    router.go(delta)
  })
}

types: there is already an existing type named ScrollBehavior, so we are renaming our type to avoid any confusions and allow the user to use both types at the same type (which given what the existing ScrollBehavior type is designed for, will likely happen).

4.0.0-beta.9 (2020-09-01)

Build related fixes

4.0.0-beta.8 (2020-09-01)

Bug Fixes

router-view: reuse saved instances in different records (#446) (6554171)
types: add HTML attributes for JSX (06f3f8f), closes #435
types: allow components defined via defineComponent (#421) (e47c84c)

BREAKING CHANGES

router-view: onBeforeRouteLeave and onBeforeRouteUpdate used to have access to the component instance through instance.proxy but given that:
1. It has been marked as internal (vuejs/core#1849)
2. When using setup, all variables are accessible on the scope (and should be accessed that way because the code minimizes better) It has been removed to prevent wrong usage and lighten Vue Router

4.0.0-beta.7 (2020-08-19)

Bug Fixes

encoding: encode partial params (eb04117)
matcher: avoid trailing slash with optional params (faf0aab)
types: append declare module (50ad404), closes #419
vetur: update tags/attributes definition (#408) (df8b2b1)

Features

warn: warn against infinite redirections (e3dcc8d)

4.0.0-beta.6 (2020-08-05)

Bug Fixes

router: stack overflow with redirect (3594011), closes #404

Features

router-link: add ariaCurrentValue prop (23e6e9c)
add Vetur support (1f1189f), closes #381

4.0.0-beta.5 (2020-08-03)

Features

resolve simple relative links (af1deaa)
url: simple resolve relative location (69c44db)
warn: warn if guard returns without calling next (6e16bdd)

4.0.0-beta.4 (2020-07-25)

Bug Fixes

router-view: render the slot when there is no match (bae42d4), closes #385
work on Edge by adding an argument to catch (#383) (9580bea)

4.0.0-beta.3 (2020-07-21)

Bug Fixes

guards: call beforeRouteEnter once per named view (f2846ff)
guards: remove registered update guards after leaving (41bffda)
guards: skip update and leave guards of unmounted views (f22e70a)
hash: allow url to contain search params before hash (ae8b289), closes #378

Features

errors: export isNavigationFailure (28a9b25)
guards: allow guards to return a value instead of calling next (#343) (5cb209f)
guards: wip context support in multi apps (34d7390)

4.0.0-beta.2 (2020-07-07)

Fix build cache issues

4.0.0-beta.1 (2020-07-03)

Bug Fixes

hash: manual changes should trigger a navigation (93891ab), closes #346
router-link: add missing prop custom in jsx (c6274ae)
router-view: preserve keep-alive route guard this context (#344) (994c073)
warn: warn when RouterView is wrapped with transition (e4b3fbe)

Code Refactoring

history: simplify location as a string (10a071c)
router: remove history property (aba3a3f)

Features

guards: next callback beforeRouteEnter (d9dad0b)

BREAKING CHANGES

router: the history property was marked as internal already. Since we need to pass the history instance to the router, we always have access to it, differently from Vue Router 3 where the history was instantiated internally. The history API was also internal (it wasn't documented), so this change shouldn't be a problem as people shouldn't be relying on router.history in their apps. If you think this property is needed, please open an issue to discuss the use case. Note it's already accessible as you have to create it:

export const history = createWebHistory()
export const router = createRouter({ history, routes: [] })

history: HistoryLocation is just a string now. It was pretty much an internal property but it could be used inside history.state. It used to be an object { fullPath: '/the-url' }. And it's now just the fullPath property.

4.0.0-alpha.14 (2020-07-01)

Bug Fixes

hash: use relative links in hash mode (32c9590), closes #342
query: do not normalize query with custom stringifyQuery (ea65066), closes #328
query: isSameRouteLocation compares queries by string (6e1f0ea), closes #328

Features

redirect: allow redirect on routes witch children (e57b875)
router: support multiple apps at the same time (565ec9d)

4.0.0-alpha.13 (2020-06-18)

Bug Fixes

allow arbitrary selectors starting with # (14b859d)
use assign to align with Vue browser support (#311) (f80b670), closes #304
hash: use location.pathname (0078147), closes #261
matcher: correct check when removing existing records on add (2c267f5)
matcher: override records by name when adding (07100fc)
scroll: avoid reusing scroll position (dfc1fb3)

Features

scroll: allow passing behavior option (12e9209)
scroll: replace selector with el (ab8a01c)
warn: warn if component is a promise (4b2bfa8)
warn: warn when routes are not found (#279) (d125356)
allow props for named views (dbe2344)
warn: warn multiple params with same name (5c8cd6e)

BREAKING CHANGES

scroll: this change follows the RFC at vuejs/rfcs#176:

selector is renamed into el
el also accepts an Element
left and top are passed along el instead of inside an object passed as offset

scroll: scrollBehavior doesn't accept an object with x and y coordinates anymore. Instead it accepts an object like ScrollToOptions with left and top properties. You can now also pass the behavior property to enable smooth scrolling in most browsers.
It is now necessary to escape id selectors like explained at https://mathiasbynens.be/notes/css-escapes. This was necessary to allow selectors like #container > child.

4.0.0-alpha.12 (2020-05-19)

Bug Fixes

hash: allow base with non trailing slash (f5cc050), closes #247
prevent error on initial navigation to //invalid (e72e4ba)

Features

warn: warn multiple leading slashes (87c5e53)

BREAKING CHANGES

hash: When providing a base for hash histories, it is now necessary to include a trailing slash to create a url that starts with /#/, otherwise it will result in a url starting with #/. This allows users to use the routing system directly in simple files without needing to configure a server at all:
- https://example.com/file.html + base: 'file.html will produce a final url of https://example.com/file.html#/
- https://example.com/folder + base: 'folder will produce a final url of https://example.com/folder#/
- https://example.com/folder + base: 'folder/ will produce a final url of https://example.com/folder/#/

4.0.0-alpha.11 (2020-05-12)

Bug Fixes

scroll: change scrollRestoration if scrollBehavior is provided (5cf2e61)
match base in a non-sensitive way (7087bbc)
router: allow multiple router instance (24d3d49)
router: unique first navigation with multi app (33172af)

Features

types: export NavigationGuardNext (#229) (888bf4d)
explicit injection symbols in dev mode (#228) (fab88ee)
support jsx and tsx for RouterLink and RouterView (1d3dce3), closes #226
router: allow functional components for routes (096d864)
scroll: scroll to the same location like regular links (5f22d4f)
warn: warn if next was called multiple times (dce2612)

4.0.0-alpha.10 (2020-05-05)

Bug Fixes

scroll: do not restore on push (3f79195)

Features

warn: warn invalid hash (fcf2365)
allow numbers as params (ef0920a), closes #206
router: allow global router classes (388735b)
router: go, back and forward can be awaited (eb87757)
warn: detect missing param in nested absolute paths (f5b5949)
warn: warn for invalid path+params and redirect (91f4de9)
warn: warn missing params in alias (186e275)
warn: warn when params are provided alongside path (8a8ddf1)

4.0.0-alpha.9 (2020-04-29)

Removed sourcemaps from build

4.0.0-alpha.8 (2020-04-29)

Bug Fixes

default matcher options (cea397b)
guards: preserve navigation options when redirecting (9effd81)
html5: correctly preserve current history.state (0586394), closes #180
link: make alias of empty child active (cfe5993)
encode hash (85bb7e1)
link: preserve the alias path (fffa585)
matcher: merge params (d8a6b25), closes #189
router: make redirect relative to target location (e878e91)
router: preserve navigation options with redirects (9732758)
view: render slot with no match (5873296)

Code Refactoring

Link and View renamed to RouterLink and RouterView (030bbc4)

Features

link: make empty child active with adjacent children (4b813b1)
router: add global pathOptions (7383564)
add navigation duplicated failure (9570416)
add onBeforeRouteUpdate (96c9503)
resolve relative paths (eae833e)
router: add back,forward,go (5e927b5)
router: add beforeResolve (9697134)
scroll: handle scroll on reload (617f131)

Performance Improvements

use index access for strings (971fea4)

BREAKING CHANGES

exported components Link and View have been renamed to be include the Router prefix and to have the same export name as their component name

4.0.0-alpha.7 (2020-04-17)

Features

add $route and $router types (a4f80aa)
add guards types (c7ccd5a)
refactor navigation to comply with vuejs/rfcs#150 (290c3be)

BREAKING CHANGES

This follows the RFC at vuejs/rfcs#150 Summary: router.afterEach and router.onError are now the global equivalent of router.push/router.replace as well as navigation through the interface (history.go()). A navigation only rejects if there was an unexpected error. A navigation failure will still resolve the promise returned by router.push and be exposed as the resolved value.

4.0.0-alpha.6 (2020-04-17)

Bug Fixes

history: allow base with / and base tag (d7c71b5), closes #164
history: allow hash history with no origin (760d216), closes #163
scroll: only apply on browser (cf53192)
revert history navigation if navigation is cancelled (d8a0d11)

Code Refactoring

router: merge createHref into resolve (66b2db9)

Features

add this.$route (92dc18d)
add this.$router (1807f30)
scroll: handle scroll on popstate (181efe9)
merge meta fields (72a052f)
guards: support errors in navigation guards (23ed08d)
router: hasRoute (ca02444)

Reverts

Revert "test: only call browser.end on the last test" (d3221f1)

BREAKING CHANGES

router: createHref is removed from the router. Instead, resolve returns a location object with the corresponding href property

4.0.0-alpha.5 (2020-04-08)

Bug Fixes

link: not active when matched is empty (acd644d)
check query and hash when navigating (3862ad9)
ignore order of keys in query and params (643bd15)
skip initial guards with static redirect (c76bb93)
types: add missing exported types (ec241f7), closes #147

Features

allow symbols as route record name (f42ab3f)
link: activeClass and exactActiveClass props (d53b383)
link: allow custom prop (874510b)

BREAKING CHANGES

Renamed types by removing suffix Normalized and using Raw instead
- RouteLocation -> RouteLocationRaw
- RouteLocationNormalized -> RouteLocation
- RouteLocationNormalized is now a location that can be displayed (not a static redirect)
- RouteLocationNormalizedResolved -> RouteLocationNormalizedLoaded
- RouteRecord -> RouteRecordRaw
- RouteRecordNormalized -> RouteRecord
- RouteRecordNormalized is now a record that is not a static redirect

4.0.0-alpha.4 (2020-03-28)

Bug Fixes

history: use current history state when replacing (5d80209)
export more types (1583d48), closes #137
guards: free instances only if navigation is confirmed (d0514e1)
hash: fix base position for hash routing (ba40b8f)
initial location with base (d05208b)
router: prevent duplicated navigation on aliases (e825586)

Features

allow passing state to history (ac1c96f)
improve route access (baf266c)
history: expose state on html5 (3f83607)
matcher: remove aliases alongside the original record (26b71b2)
router: support custom parseQuery and stringifyQuery (#136) (5dce7bc)
view: add props option as boolean (7fe1e7d)
view: allow passing props as a function (494fc5e)
view: useView to customize router-view (06b0c34)
allow true in next (d76c6aa)
invoke guards with the right context (7053413)
lazy loading (6ecdc70)
view: allow props as object in record (fd4dc06)

BREAKING CHANGES

useRoute now retrieves a reactive RouteLocationNormalized instead of a Ref. This means there is no need to use .value when accessing the route. You still need to wrap it with toRefs if you want to expose parts of the route:
```
setup () {
  return { params: toRefs(useRoute()).params }
}
```

4.0.0-alpha.3 (2020-03-14)

Bug Fixes

add missing type definitions

4.0.0-alpha.2 (2020-03-14)

Bug Fixes

history: correct url when replacing current location (704b45e)
link: allow attrs to override behavior (4cae9db)
link: allow custom classes (#134) (392c295), closes #133
link: navigate to the alias path (3284110)
link: non active repeatable params (0ccbc1e)

Features

add aliasOf to normalized records (d9f3174)
handle active/exact in Link (6f49dce)
matcher: link aliases to their original record (e9eb648)

4.0.0-alpha.1 (2020-02-26)

Code Refactoring

rename createHistory and createHashHistory (7dbebb6)

Features

add dynamic routing at router level (a7943c6)

BREAKING CHANGES

createHistory is now named createWebHistory. createHashHistory is now named createWebHashHistory.

Both createHistory and createHashHistory are renamed to better reflect that they must be used in a browser environment while createMemoryHistory doesn't.

4.0.0-alpha.0 (2020-02-26)

Known issues

Breaking changes compared to vue-router@3.x

mode: 'history' -> history: createHistory()
Catch all routes (/*) must now be defined using a parameter with a custom regex: /:catchAll(.*)

Missing features

keep-alive is not yet supported
Partial support of per-component navigation guards. No beforeRouteEnter yet

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

4.0.2 (2020-12-27)

Bug Fixes

4.0.1 (2020-12-07)

Bug Fixes

4.0.0 (2020-12-07)

Bug Fixes

Features

4.0.0-rc.6 (2020-11-30)

Bug Fixes

Features

4.0.0-rc.5 (2020-11-21)

Features

4.0.0-rc.4 (2020-11-20)

Features

4.0.0-rc.3 (2020-11-14)

Bug Fixes

4.0.0-rc.2 (2020-11-05)

Features

4.0.0-rc.1 (2020-10-23)

Features

4.0.0-beta.13 (2020-10-02)

Bug Fixes

Features

4.0.0-beta.12 (2020-09-25)

Bug Fixes

4.0.0-beta.11 (2020-09-20)

Bug Fixes

4.0.0-beta.10 (2020-09-18)

Bug Fixes

Code Refactoring

Features

BREAKING CHANGES

4.0.0-beta.9 (2020-09-01)

4.0.0-beta.8 (2020-09-01)

Bug Fixes

BREAKING CHANGES

4.0.0-beta.7 (2020-08-19)

Bug Fixes

Features

4.0.0-beta.6 (2020-08-05)

Bug Fixes

Features

4.0.0-beta.5 (2020-08-03)

Features

4.0.0-beta.4 (2020-07-25)

Bug Fixes

4.0.0-beta.3 (2020-07-21)

Bug Fixes

Features

4.0.0-beta.2 (2020-07-07)

4.0.0-beta.1 (2020-07-03)

Bug Fixes

Code Refactoring

Features

BREAKING CHANGES

4.0.0-alpha.14 (2020-07-01)

Bug Fixes

Features

4.0.0-alpha.13 (2020-06-18)

Bug Fixes

Features

BREAKING CHANGES

4.0.0-alpha.12 (2020-05-19)

Bug Fixes

Features

BREAKING CHANGES

4.0.0-alpha.11 (2020-05-12)

Bug Fixes

Features

4.0.0-alpha.10 (2020-05-05)

Bug Fixes

Features

4.0.0-alpha.9 (2020-04-29)

4.0.0-alpha.8 (2020-04-29)