Skip to content

Latest commit

 

History

History
253 lines (148 loc) · 8.42 KB

CHANGELOG.md

File metadata and controls

253 lines (148 loc) · 8.42 KB

8.0.0

This is a complete re-write of the router. I decided to be a bad guy and kill/change some features. This is in favor of having cleaner code and I hope more stable implementation. The library was also doing bunch of assumptions for the root of your application which proved to be buggy and non-deterministic. So I'm removing this logic and asking you to set the root of your application.

Deprecations

  • Hash-based support for older browsers
  • pause and resume. There is shouldResolve in the navigate method instead.
  • historyAPIUpdateMethod method. It's now an option of the navigate method.
  • helpers method
  • disableIfAPINotAvailable method

New features

  • The navigate method now accepts options as a second argument which are there to cover more use cases.
  • There is data-navigo-options HTML attributes for your links so you can pass options to the navigate method.

Migration guide

  • Change the initialization of the router to accept a single argument - the root of your application.
  • Checkout your handlers if they read data from a parameterized URL or a GET param. If so make sure that they get the data from the single object passed to the function (an object of type Match) 
    type Match = {
  url: string;
  queryString: string;
  route: Route;
  data: Object | null; // data coming in the URL
  params: Object | null; // data coming in the query string
};
    where Route is 
    type Route = {
  path: string;
  handler: Function;
  hooks: RouteHooks;
};
  • If you are using historyAPIUpdateMethod you'll need to pass a historyAPIMethod field to the options of navigate. For example: 
    router.navigate('/foo/bar', { historyAPIMethod: 'replaceState' })
  • I hope you didn't use router.helpers but if you do explore the alternatives: 
    router.match -> router._matchRoute
router.root -> router.root
router.clean -> router._clean
router.getOnlyURL -> router.extractGETParameters
  • If you used the pause and resume methods you have to migrate your app to use shouldResolve param of the navigate method. Or in other words when navigating to define whether you want to have route handling or not. Example: 
    router.navigate('/foo/bar', { shouldResolve: false });
  • lastRouteResolved becomes lastResolved and it returns an object of type Match. Checkout above. (or null if there is no resolved URL so far)

7.1.2

Open in new tab when Ctrl-key is pressed (#199)

7.0.0

Fixing the behavior of the hooks #182 #174

6.0.2

Make sure that the leave hook receives the URL params.

6.0.1

unpkg as CDN.

6.0.0

When using a data-navigo links we now read from the href attribute only. The router is not using pathname anymore. I again got the pros and cons of both approaches and I see that using pathname actually does not make a lot of sense now.

5.3.3

Resolving the route when we use hash based URL and have no dynamic route #162

5.3.2

Fixing the behavior of getOnlyURL function.

5.3.1

The lastRouteResolved now returns a name property for the named routes.

5.3.0

Adding a new API method historyAPIUpdateMethod.

5.2.0

Sending matched route parameters to the general hooks. #137

5.1.0

Adding already hook. #136

5.0.2

Good call by Daniel Bernhard that my updates on the clear method actually breaks the links with data-navigo. This release fixes that.

5.0.1

It looks like calling History push or replace state doesn't trigger a popstate event. So we indeed have to call resolve. This version fixes that and navigate works again.

5.0.0

Issue #128 made me rethink how Navigo handles routes. The route matching is based on regular expressions and one of them was not quite ok. That's now fixed as part of this latest release. However, these updates change how Navigo uses the registered routes so it may break your app.

4.8.0

  • Adding generic hooks + leave hook #107.

4.7.4

  • Clear the navigate method. It is not calling resolve automatically. Related to #115.

4.7.3

  • Making sure that generate doesn't fail if there's a regex as a route #125

4.7.2

  • Proper handling of the encoded URL parameter #116

4.7.1

  • Fixing the bug described in #122

4.7.0

  • Adding getLinkPath function to cover #120

4.6.2

  • Fixing a bug in IE9 #110

4.6.1

  • Using relative URLs in navigation #109

4.6.0

  • Parameters from the parameterized routes are sent to hooks' handlers #108

4.5.2

  • Fixing a bug under IE9 #104

4.5.1

  • A bug fix for #96 which was about a proper extracting of the GET parameters

4.5.0

  • Adding lastRouteResolved public API (#101)

4.4.0

  • Providing an API for case insensitive route handling (#100)

4.3.7

  • #97 - similar to #95 we are now using addEventListener when listening for browser API events.

4.3.6

  • #95 - keeping the already defined handler of onhashchange

4.3.4

  • A path because of the latest release. It covers the case where we are using a custom hash. #92

origin/master

4.3.2, 4.3.3

4.3.1

  • Make sure we have a function when using named routes #86 (by Tobias Nyholm (@Nyholm))

4.3.0

  • Support of custom hash string like #! for example. Read the docs for more information.

4.2.0

4.1.1/2

  • Adding off API method #72.

4.0.1

4.0.0

That's a minor but a breaking change. The generate method now outputs proper strings base on the useHash parameter. Or in other words if the router is using hash based routing the generated URLs contain # in the beginning.

3.5.1

  • Proper initialization of the root when using useHash = true
  • Minor fix while resolving hash based URLs (for Firefox)

3.5.0

  • Adding a resume method which is same as .pause(false). .pause now acts as .pause(true) by default.

3.4.2

3.4.1

  • Support of hooks in named routes. (#60)

3.4.0

  • Merging #58 where we can prevent the handler calling from a before hook.

3.3.3

  • Another try fixing #57 - now if we have noHash=false the hash part of the URL is removed and we are no longer considering it while comparing the last resolved URL.

3.3.2

  • Fixing #57 - making sure that we keep the last resolved url when we have the notFound handler resolves.

3.3.1

  • Fixing #56 - When a / is given as a path it is considered as a default route handler.

3.3.0

  • Start using onhaschange API as a default for hash based routing.
  • Using karma as a test runner.

3.2.1

  • Fixing the case where route handlers are not fired when only the query string part of the URL is changed (#53)

3.2.0

3.1.0