README.md
1
2<!---
3
4This README is automatically generated from the comments in these files:
5iron-location.html iron-query-params.html
6
7Edit those files, and our readme bot will duplicate them over here!
8Edit this file, and the bot will squash your changes :)
9
10The bot does some handling of markdown. Please file a bug if it does the wrong
11thing! https://github.com/PolymerLabs/tedium/issues
12
13-->
14
15[](https://travis-ci.org/PolymerElements/iron-location)
16
17_[Demo and API docs](https://elements.polymer-project.org/elements/iron-location)_
18
19
20##<iron-location>
21
22The `iron-location` element manages binding to and from the current URL.
23
24iron-location is the first, and lowest level element in the Polymer team's
25routing system. This is a beta release of iron-location as we continue work
26on higher level elements, and as such iron-location may undergo breaking
27changes.
28
29#### Properties
30
31When the URL is: `/search?query=583#details` iron-location's properties will be:
32
33* path: `'/search'`
34* query: `'query=583'`
35* hash: `'details'`
36
37These bindings are bidirectional. Modifying them will in turn modify the URL.
38
39iron-location is only active while it is attached to the document.
40
41#### Links
42
43While iron-location is active in the document it will intercept clicks on links
44within your site, updating the URL pushing the updated URL out through the
45databinding system. iron-location only intercepts clicks with the intent to
46open in the same window, so middle mouse clicks and ctrl/cmd clicks work fine.
47
48You can customize this behavior with the `urlSpaceRegex`.
49
50#### Dwell Time
51
52iron-location protects against accidental history spamming by only adding
53entries to the user's history if the URL stays unchanged for `dwellTime`
54milliseconds.
55
56
57
58<!-- No docs for <iron-query-params> found. -->
59
){kind=link}