bind-url

Bind url changes to a callback

Usage no npm install needed!

<script type="module">
  import bindUrl from 'https://cdn.skypack.dev/bind-url';
</script>

README

bind-url

js-standard-style

Bind url changes to a callback

Installation

$ npm install bind-url

Usage

bindUrl({wnd: window, root: document.body}, function (url) {
  // Do something with the new url
})

The first parameter is an object with two values, wnd expects a window object (or some mock thereof if you're on the server), and root expects the root element upon which you wish to capture link clicks - if not specified, defaults to window. The second argument is a callback that should receive all changes to the url, provided you don't do something like manually calling pushState.

License

The MIT License

Copyright © 2015, Weo.io <info@weo.io>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.