local-links - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "local-links",
   "description": "Determine cross-browser if an event or anchor element should be handled locally.",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Luke Karrys <[e-mail]>",
@@ -6,0 +6,0 @@ "bugs": {

README.md

@@ -10,1 +10,88 @@ local-links
 ](https://ci.testling.com/lukekarrys/local-links)
+
+## Install
+
+`npm install local-links --save`
+
+## Why?
+
+Browsers have quirks. Knowing if a link is local should be easy, since we
+just want to know if the hosts are the same. But this can be difficult because
+of the aforementioned browser quirks. A few of them:
+
+- IE9 will add `:80` to the host of an anchor, but not the window
+- IE9 wont put a leading slash on the pathname of an anchor, but will on the window
+- Chrome 36 will report anchor.hash as '' if it has `href="#"`
+- More? Please report test cases!
+
+Because of that and a few other things I was doing all the time, such as
+finding the closest anchor to an element based on an event object, I decided
+it would be a good module (that at least I would use all the time).
+
+## Usage
+
+```html
+<a href='/page2' id="local">Local</a>
+<a href='#hash' id="hash">Local</a>
+<a href='http://google.com' id="google">Google</a>
+```
+
+```js
+var local = require('local-links');
+
+// The method pathname will return the pathname as a string
+// if the link is local, otherwise it will return null
+
+local.pathname(document.getElementById('local')) // '/page2'
+local.pathname(document.getElementById('hash')) // null
+local.pathname(document.getElementById('googe')) // null
+```
+
+## API
+
+
+### Methods
+
+- `pathname(Event or HTMLElement [, HTMLElement])`
+
+Returns the pathname if it is a non-hash local link, or null if it is not.
+Always includes the leading `/`.
+
+- `hash(Event or HTMLElement, [, HTMLElement])`
+
+Returns the hash if it is an in-page hash link, or null if it is not. Always
+includes the leading `#`.
+
+
+#### Supply either Event or HTMLElement (or both!)
+
+Both the above methods will accept an `Event` object, like the one you get from
+event handlers, or any `HTMLElement`. You can also supply an `Event` object
+and your own `HTMLElement` as the second parameter and it will take precedence.
+
+If only an `Event` object is supplied, the `HTMLElement` will be found from
+`Event.target`.
+
+
+#### Nested HTML Elements
+
+In the case that any `HTMLElement` your provide is not an anchor
+element, the module will look up `parentNodes` until an anchor is found.
+
+
+#### Events
+
+If an `Event` object is supplied, all methods will return `null` if any of the following
+are true `altKey`, `ctrlKey`, `metaKey`, `shiftKey. This is because you almost always
+want to treat modified click events as external page clicks.
+
+
+#### Hash links
+
+Using the `pathname` method will return null for hash links that do not point
+to a different page. To get the hash for one of these links use the `hash()` method.
+
+
+### License
+
+MIT

test/index.js

@@ -126,4 +126,2 @@ var test = require('tape');
 
-
-
     test('Active returns boolean based on current page', function (t) {
@@ -130,0 +128,0 @@ t.plan(5);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14588

increased by21.19%

Number of lines in readme file

97

increased by870%

No dependency changes