Skip to content

Latest commit

 

History

History
877 lines (530 loc) · 30.2 KB

CHANGELOG.md

File metadata and controls

877 lines (530 loc) · 30.2 KB
Raw

router5@8.0.0

Unreleased (2020-03-01)

Feature

  • router5: add new urlParamsEncoding option to control how URL params are encoded and decoded when building and matching paths.
  • router5: add generic to createRouter to infer dependencies type

House keeping

  • react-router5-hocs, react-router5, redux-router5-immutable, redux-router5, router5-helpers, router5-plugin-browser, router5-plugin-listeners, router5-plugin-logger, router5-plugin-persistent-params, router5-transition-path, router5, rxjs-router5, xstream-router5
  • Other
    • #455 docs: update examples (only keep React one) (@troch)

Enhancement

Committers: 3

react-router5@7.1.0, router5-plugin-browser@7.0.2 (2019-02-21)

Bug fix

  • react-router5
  • router5-plugin-browser
    • #384 Fix issue with browsers that don't URL encode characters (MS Edge, IE11) (@todorpr)

Enhancement

  • react-router5
    • #393 Export BaseLink in react-router5 (link without router) (@Morcatko)

Committers: 3

router5@7.0.1 (2018-12-21)

Bug fix

  • router5
    • #389 Add createRouter argument defaults (@troch)

Committers: 1

router5@7.0.0 (2018-12-18)

See migration guide: https://router5.js.org/migration/migrating-from-6.x-to-7.x

router5@6.6.3 (2018-12-15)

Bug fix

Committers: 1

router5@6.6.2 (2018-10-23)

Bug fix

  • router5
    • #379 Properly handle default params when building paths and states. (@troch)

Committers: 1

router5@6.6.1 (2018-10-16)

Bug fix

  • router5
    • #375 Upgrade to latest patch of route-node (3.4.2). (@troch)

Committers: 1

router5@6.5.3 (2018-10-06)

Bug fix

  • react-router5

Committers: 1

router5@6.5.2 (2018-10-05)

Enhancement

  • react-router5
    • #367 Add typings for Route and RouteNode component. (@vire)

Committers: 1

  • Viliam Elischer (vire)

router5@6.6.0 (2018-10-04)

Enhancement

  • react-router5, redux-router5, rxjs-router5, xstream-router5
    • #371 Lock router5-transition-path versions. (@troch)
  • react-router5, router5
    • #370 Update route-node and lock router5-transition-path version. (@troch)

Committers: 1

router5@6.5.1, react-router@6.5.0 (2018-09-26)

Feature

Enhancement

  • react-router5
  • router5
    • #363 Add title as 3rd parameter of router.replaceHistoryState. (@rlebosse)

Committers: 2

router5@6.5.0 (2018-09-11)

Enhancement

  • react-router5
    • #361 Support target="_blank" in BaseLink. (@Panya)
  • router5
  • router5-transition-path
    • #352 Check if state has meta params before extracting segment params. (@rlebosse)

Committers: 5

react-router5@6.3.0 (2018-08-22)

Bug fix

  • react-router5
    • #346 fix listeners not registering. (troch)

Committers: 1

react-router5@6.2.0 (2018-08-21)

Enhancement

  • react-router5
    • #344 Move route change subscription to constructor (new context). (troch)
    • #345 Move route change subscription to constructor (old context). (troch)

Committers: 1

router5@6.4.2 (2018-08-19)

  • router5, react-router5, redux-router5, router5-transition-path, rxjs-router5, xstream-router5:
    • #343 Force all nodes to update if reload transition option is true (@troch)

Committers: 1

router5@6.4.1 (2018-08-07)

Enhancement

  • router5
    • #336 Improve performance of adding a large number of routes when using .add (@troch)

Committers: 1

router5@6.4.0 (2018-08-06)

Enhancement

  • router5
    • #331 Improve performance of adding routes (@troch)

Committers: 1

react-router5@6.1.0 (2018-07-23)

Enhancement

  • react-router5
    • #323 Add ignoreQueryParams prop in link component. (@azangru)

Committers: 1

router5@6.3.0 (2018-07-11)

Bug fix

  • router5

Committers: 1

react-router5@6.0.4 (2018-06-06)

Enhancement

  • react-router5
    • #308 Ensure activeClassName has higher specificity. (@roryf)

Committers: 1

  • Rory Fitzpatrick (roryf)

router5@6.2.4 (2018-06-05)

Bug fix

  • router5
    • #306 Update route-node to correctly account for query params options. (@troch)

Committers: 1

router5@6.2.3 (2018-06-02)

Enhancement

  • router5
  • react-router5
  • redux-router5

Committers: 5

redux-router5@6.0.0 (2018-05-22)

BREAKING CHANGES

  • redux-router5
    • #292 Rename routeNodeSelector to createRouteNodeSelector. (@troch)

Committers: 1

router5@6.2.1 (2018-05-16)

Bug fix

  • router5

Committers: 1

router5@6.2.0 (2018-05-14)

Bug fix

  • router5
    • #285 Make sure pipe characters are encoded (Firefox issue). (@troch)

Enhancement

  • router5
    • #286 Update route-node to latest patch (support = and + sign in path parameters). (@troch)

Committers: 1

router5@6.1.5 (2018-05-12)

Enhancement

  • router5
    • #284 Enhance stream libraries compatibility. (@troch)

Committers: 1

router5@6.1.4 (2018-05-12)

Enhancement

  • router5
    • #283 Improve observable interoperability. (@troch)

Committers: 1

router5@6.1.3 (2018-05-01)

Bug fix

  • react-router5
    • #280 Upgrade router5-transition-path in yarn lock file. (@troch)
  • router5
    • #279 Properly apply query parameters options when building and matching. (@troch)

Enhancement

Committers: 2

router5@6.1.2 (2018-04-20)

Bug fix

  • router5
    • #275 Replace addEventListeners calls with addEventListener. (@kelkes)

Committers: 1

router5@6.1.1 (2018-04-20)

Bug fix

  • router5
    • fix observable plugin listener registration
  • react-router5
    • fix RouteProvider (new context API)

router5@6.1.0 (2018-04-20)

Bug fix

  • router5
    • #271 Don't remove trailing slash from pathname when using hash (browser plugin). (@troch)

Feature

  • react-router5
    • #270 Remove need to use listeners plugin with React + smarter route node updates. (@troch)
  • router5
    • #269 Add subscribe function and observable compatibility. (@troch)

Enhancement

  • redux-router5
    • #272 Smarter route node selector updates. (@troch)
  • router5-transition-path

Breaking Changes

  • react-router5@6.0.0 needs router5@6.1.0 and above

Committers: 1

router5@6.0.0 (2018-04-19)

Feature

  • router5
    • Navigation options are now added to state objects (in meta)
    • You can now specify your custom navigation options: they will be added to state objects and are usable by your custom plugins and middlewares
    • New queryParams option to configure how query parameters are built, and how they are parsed
    • New caseSensitive option (default to false)
  • react-router5
    • Alternative components using a render function have been added in addition to the higher-order components. Those components require a new provider, because they leverage React new context API (React >= 16.3, see https://github.com/router5/router5/tree/master/packages/react-router5). Higher-order components won't be deprecated, and will evolve to use React new context API once deprecated.

Bug fix

  • router5
    • Navigation with browser plugin and useHash on IE11 fixed when manually changing the URL
    • Transition phase was reowrked to support correctly state mutations in middlewares using the done callback or promises

Breaking changes

  • Path matching used to be case sensitive and it is now case insensitive by default (new caseSensitive option)
  • Query parameters in paths can no longer be defined with [] (brackets should be removed)
  • Option trailingSlash has been renamed to strictTrailingSlash: by default it is false
  • Option useTrailingSlash has been renamed to trailingSlashMode with value being 'default', 'never' or 'always'
  • Option strictQueryParams has been renamed to queryParamsMode with value being 'default', 'strict' or 'loose'
  • Query parameters: by default boolean values are now stringified to 'true' and 'false', null values are stringified without = sign ({ param: null } will be stringified to '?param'). To keep your current behaviour intact, set queryParams.nullFormat to 'hidden' and queryParams.booleanFormat to 'empty-true' (see options below)
  • Private method router.makeState signature has changed (you shouldn't be impacted)

As described above, options have been revamped to make it easier and more intuitive to configure:

  • trailingSlashMode:
    • 'default': building follows path definitions
    • 'none': when building, trailing slash is removed
    • 'always': when building, trailing slash is added
  • queryParamsMode:
    • 'default': a path will match with any query parameters added, but when building, extra parameters won't appear in the returned path.
    • 'strict': a path with query parameters which were not listed in node definition will cause a match to be unsuccessful. When building, extra parameters won't appear in the returned path.
    • 'loose': a path will match with any query parameters added, and when building, extra parameters will appear in the returned path.
  • queryParams:
    • arrayFormat: Specifies how arrays should be stringified
      • 'none' (default): no brackets or indexes are added to query parameter names ('role=member&role=admin')
      • 'brackets: brackets are added to query parameter names ('role[]=member&role[]=admin')
      • 'index': brackets and indexes are added to query parameter names ('role[0]=member&role[1]=admin')
    • booleanFormat: specifies how boolean values are stringified and parsed
      • 'none' (default): booleans are stringified to strings ('istrue=true&isfalse=false')
      • 'empty-true': same as 'none' except true values are stringified without value ('istrue&isfalse=false'). If you choose this boolean format, make sure to change the value of 'nullFormat'.
      • 'string': same as 'none' but 'true' and 'false' are parsed as booleans
      • 'unicode': true and false are displayed with unicode characters, and parsed as booleans ('istrue=✓&isfalse=✗')
    • nullFormat: specifies how null values are stringified and parsed
      • 'default' (default): null values are stringified without equal sign and value ('isnull')
      • 'string': null values are stringified to 'null' ('isnull=null') and parsed as null values
      • 'hidden': null values are not stringified

Committers: 1

react-router5@5.5.2 (2018-03-07)

Enhancement

  • react-router5
    • #260 feat(react-router5): Update type definitions. (@zaeleus)

Committers: 1

react-router5@5.5.1 (2018-03-06)

Bug fix

  • react-router5
    • Don't pass new callback prorps to underlying hyperlink

Committers: 1

react-router5@5.5.0 (2018-03-06)

Feature

  • react-router5
    • #258 Add successCallback and errorCallback props to React links. (@troch)

Committers: 1

router5@5.8.3 (2018-03-05)

Bug fix

  • router5
    • #256 Update route-node to latest version (5.0.3). (@troch)

Committers: 1

router5@5.8.2 (2018-02-13)

Bug fix

  • router5
    • #253 When forwarding, apply default params from initial and final routes. (@troch)

Committers: 1

router5@5.8.1 (2018-02-08)

Bug fix

  • router5
    • #251 Fix state ID generation to not duplicate on hydration. (@whs)

Committers: 1

  • Manatsawin Hanmongkolchai (whs)

react-router5@5.4.2 (2018-01-26)

Bug fix

  • react-router5
    • #245 Fix route node listeners not being unregistered in routeNode HoC. (@whs)

Committers: 1

  • Manatsawin Hanmongkolchai (whs)

router5@5.8.0 (2018-01-25)

Feature

  • router5
    • #244 Add optional params encoders, params decoders and default params to routes. (@troch)

Fix

  • router5
    • Fix clone function to include route specific config like forwardTo

Committers: 1

2018-01-09

Enhancement

  • router5-helpers

Committers: 2

react-router@5.4.1 (2017-12-07)

Bug fix

  • react-router5
    • #231 Typescript typings specify routerNode instead of routeNode #230. (@texttechne)

Committers: 1

router5@5.7.1 (2017-12-07)

Bug fix

  • router5
    • #232 Fix reloading of routes on transition. (@troch)

Committers: 1

router5@5.7.0 (2017-11-17)

Feature

  • router5-transition-path, router5
    • #226 Add type definitions for router5-transition-path. (@zaeleus)

Enhancement

  • react-router5, redux-router5, router5-helpers, router5-transition-path, router5, rxjs-router5, xstream-router5
    • #225 Configure all packages with jnext:main and module. (@troch)

Committers: 2

2017-11-15

Enhancement

  • react-router5
  • deku-router5, examples, react-router5, redux-router5, router5-helpers, router5-transition-path, router5, rxjs-router5, xstream-router5

Committers: 1

router5@5.6.0 (2017-11-09)

Bug fix

  • redux-router5
    • #219 Fix return type of reduxPlugin (TypeScript). (@zaeleus)

Enhancement

  • router5
    • #218 router5: Update type definitions. (@zaeleus)
    • #220 Improve path building and parsing error messages. (@troch)

Committers: 3

router5@5.5.0 (2017-11-01)

Feature

  • react-router5
  • redux-router5

Enhancement

  • redux-router5
  • router5
    • #212 Remove ? from middleware done arg to avoid checking it's presence. (@faergeek)

Committers: 2

router5@5.4.0 (2017-10-15)

Enhancement

  • router5
    • #207 Update route-node package to latest version. (@troch)

Committers: 1

router5@5.3.0 (2017-10-05)

Feature

  • router5

Committers: 1

react-router5@5.2.0 (2017-10-04)

Feature

  • react-router5
    • #201 Pass link props to its hyperlink element. (@troch)

Committers: 1

router5@5.2.2 (2017-09-29)

Enhancement

  • router5
    • #196 Add type definition for persistentParamsPlugin. (@acchou)

Committers: 1

rxjs-router5@5.1.0 (2017-09-29)

Feature

  • rxjs-router5

Committers: 1

router5@5.2.1 (2017-09-27)

Bug fix

  • router5
    • #193 Fix TypeScript definition of router.usePlugin. (@Keats)

Committers: 1

  • Vincent Prouillet (Keats)

router5@5.2.0 (2017-09-26)

Bug fix

  • router5
    • #192 Router plugin buildUrl should return null for undefined routes. (@ezzatron)
    • #188 Force redirections on error. (@troch)

Feature

  • router5
    • #162 Add navigation option to skip transition. (@troch)

Enhancement

  • router5
    • #181 Update typescript definition to latest docs. (@Sebazzz)
    • #190 Use console.groupCollapsed() in the logger plugin, where available. (@ezzatron)

Committers: 3

router5@5.1.7 (2017-09-04)

Bug fix

  • router5
    • #187 Preserve state IDs on popstate. (@troch)
    • #186 Only use console groups in logger if available. (@troch)

Committers: 1

router5@5.1.6 (2017-08-10)

Bug fix

  • router5
    • #172 Prevent empty arrays to be serialised in search part. (@troch)

Committers: 1

router5@5.1.4 (2017-08-04)

Bug fix

  • router5
    • #167 Update route-node to latest version. (@troch)

Committers: 1

router5@5.1.3 (2017-07-27)

Bug fix

  • router5
    • #166 Set source to 'popstate' in meta of state changes caused by history popstate events. (@troch)

Committers: 1

router5@5.1.2 (2017-07-03)

Bug fix

  • router5
    • #160 Fix cannot deactivate condition in browser plugin popstate handler. (@troch)
    • #159 Correct state comparison (areStatesEqual) with non-strict query parameters. (@troch)

Committers: 1

router5@5.1.1 (2017-06-30)

Bug fix

  • router5
    • #158 Allow route forwarding on router start. (@troch)

Committers: 1

router5@5.1.0

Also released

  • react-router5@5.0.2
  • rxjs-router5@5.0.2
  • xstream-router5@5.0.2

Feature

House keeping

  • react-router5, rxjs-router5, xstream-router5
    • #156 Remove package internal dev dependencies. (@troch)

Committers: 1

5.0.0

Bug Fixes

  • only preserve hash when useHash is false (e8bb4df)
  • pass not found state to middleware functions on start (0d0bf75)

Breaking changes

  • Not found state is now passed to middleware functions on start
  • router strictQueryParams option is now false by default
  • browser plugin option preserveHash is now true by default
  • router5.helpers package has been renamed to router5-helpers
  • router5.transition-path package has been renamed to router5-transition-path
  • router5 won't be released with bower beyond version 4

For previous versions (4 and below), see: