Repository navigation
QueryParamsHandling documentation #17778
Description
I'm submitting a
Documentation Issue or request.
Current behavior
There is no useful documentation for queryParamsHandling. There is a single line use case under NavigationExtras but this gives no detail regarding the parameters available to use. As far as I can tell there is no other reference to this in the documentation. A query for "queryParamsHandling" at the top level of the angular documentation yields nil results.
Expected behavior
- This option should be documented.
- I should be able to find references to this option by searching in the documentation.
Reacted by Patrick Graham, Trotyl Yu, Ben Lesh, sasoft, Niklas, Kabby, Dylan Vennix, Ioannis, Martin Parenteau, Soumya and 17 more
Activity
chriscurnow commentedon Jun 27, 2017
There is mention of preserveQueryParameters in the Routing and Navigation but this parameter is deprecated in favour of queryParamsHandling
dgroh commentedon Jul 5, 2017
What are the other options for queryParamsHandling but
merge?sfdeloach commentedon Jul 18, 2017
Another option for queryParamsHandling is
'preserve', which I believe is similar to the deprecated preserveQueryParams being set totrue.niklas-dahl commentedon Nov 10, 2017
fyi https://github.com/angular/angular/blob/5.0.1/packages/router/src/config.ts#L330
brandonroberts commentedon Nov 15, 2018
Fixed via #20023
cWillow commentedon Feb 22, 2019
I don't think this is complete. There is information in the Router Link description but shouldn't this info also be in the queryParamsHandling description, or at least a link to it?
lucashfreitas commentedon Apr 2, 2019
+1. I was just reading the documentation and it does not have enough information about all the available options for queryParamsHandling. The documentation only has one example using
'merge'option but nothing about others options and side effects.Here's the documentation link
lucashfreitas commentedon Apr 2, 2019
@brandonroberts , the official documentation seems to still be incomplete. Can we help with anything to update it? :) https://angular.io/api/router/NavigationExtras#preserveQueryParams
angular-automatic-lock-bot commentedon Sep 14, 2019
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.