I'd like to read the values of URL query parameters using AngularJS. I'm accessing the HTML with the following URL:
http://127.0.0.1:8080/test.html?target=bob
As expected, location.search
is "?target=bob"
.
For accessing the value of target, I've found various examples listed on the web, but none of them work in AngularJS 1.0.0rc10. In particular, the following are all undefined
:
$location.search.target
$location.search['target']
$location.search()['target']
Anyone know what will work? (I'm using $location
as a parameter to my controller)
Update:
I've posted a solution below, but I'm not entirely satisfied with it.
The documentation at Developer Guide: Angular Services: Using $location states the following about $location
:
When should I use $location?
Any time your application needs to react to a change in the current URL or if you want to change the current URL in the browser.
For my scenario, my page will be opened from an external webpage with a query parameter, so I'm not "reacting to a change in the current URL" per se. So maybe $location
isn't the right tool for the job (for the ugly details, see my answer below). I've therefore changed the title of this question from "How to read query parameters in AngularJS using $location?" to "What's the most concise way to read query parameters in AngularJS?". Obviously I could just use javascript and regular expression to parse location.search
, but going that low-level for something so basic really offends my programmer sensibilities.
So: is there a better way to use $location
than I do in my answer, or is there a concise alternate?
To give a partial answer my own question, here is a working sample for HTML5 browsers:
The key was to call
$locationProvider.html5Mode(true);
as done above. It now works when openinghttp://127.0.0.1:8080/test.html?target=bob
. I'm not happy about the fact that it won't work in older browsers, but I might use this approach anyway.An alternative that would work with older browsers would be to drop the
html5mode(true)
call and use the following address with hash+slash instead:http://127.0.0.1:8080/test.html#/?target=bob
The relevant documentation is at Developer Guide: Angular Services: Using $location (strange that my google search didn't find this...).
I found that for an SPA HTML5Mode causes lots of 404 error problems, and it is not necessary to make $location.search work in this case. In my case I want to capture a URL query string parameter when a user comes to my site, regardless of which "page" they initially link to, AND be able to send them to that page once they log in. So I just capture all that stuff in app.run
then later after login I can say $state.go($rootScope.initialPage, $rootScope.initialParams)
you could also use $location.$$search.yourparameter
You can inject $routeParams (requires ngRoute) into your controller. Here's an example from the docs:
EDIT: You can also get and set query parameters with the $location service (available in
ng
), particularly itssearch
method: $location.search().$routeParams are less useful after the controller's initial load;
$location.search()
can be called anytime.this may help uou
What's the most concise way to read query parameters in AngularJS
Good that you've managed to get it working with the html5 mode but it is also possible to make it work in the hashbang mode.
You could simply use:
to get access to the 'target' search param.
For the reference, here is the working jsFiddle: http://web.archive.org/web/20130317065234/http://jsfiddle.net/PHnLb/7/