`js
import fauxanchor from 'faux-anchor';
const anchorElement = document.querySelector('.jackie');
const tagElement = document.querySelector('.lexie');
const statsLogger = () => Promise.resolve();

const anchorInstance = fauxanchor(anchorElement, {
onPrimaryAction: ( e ) => {
// Called on primary action (e.g. left mouse button click)

// Example: Log some stats;
// Return Promise to proceed with native/simulated behavior if it resolves
return statsLogger();

},
onSecondaryAction: ( e ) => {
// Called on secondary action (e.g. middle mouse button click)

// Return Promise to proceed with native/simulated behavior if it resolves
return Promise.resolve();
}
});

const tagInstance = fauxanchor(tagElement);
`

API

$3

Returns: Object

When run on anchor elements, href and target attributes are used. When run on non-anchor elements, data-href and data-target attributes are used.

There is also support for rel/data-rel attribute, particularly [noopener value due to security issues][noopener-security].

#### element

Type: Element

Element on which to apply changes.

#### options

Type: Object

##### onPrimaryAction

Type: Function
Default: ( e ) => Promise.resolve()

Callback for primary action (e.g. left mouse button click). This is usually action triggered in the same window.

Return Promise to proceed with native/simulated behavior.

Function arguments:

* e Event Event which triggered callback

##### onSecondaryAction

Type: Function
Default: ( e ) => Promise.resolve()

Callback for secondary action (e.g. middle mouse button click). For anchor elements this is usually new window opened via browser native heuristics, and for non-anchor elements window.open is used where possible.

Return Promise to proceed with native/simulated behavior.

Function arguments:

* e Event Event which triggered callback

##### focusUnfocusable

Type: Boolean
Default: true

Should the unfocusable element (e.g. generic tag) be focusable.

##### primaryActionHandler

Type: Function
Default: ( href ) => window.location.assign(href)

Set primary action handler. Useful if you want to handle primary actions with client-side router.

$3

Destroy instance.

Test

For automated tests, run npm run test:automated.

For manual tests, run npm run test:manual and open in your browser.

Browser support

Tested in IE9+ and all modern browsers. Promise` should be available globally.

License