@aleph/react-router-hijack-a
v1.2.0
Published
Watches HTML <a>-tag clicks and passes them to React Router if needed
Downloads
21
Readme
React Router Hijack
This React component allows React Router to handle raw HTML. It handles clicks
on its children, checks if an <a>
tag was clicked, and determines whether to
process it as an internal react-router link or an external link.
Usage
import Hijack from '@aleph/react-router-hijack-a'
<Hijack>
<div dangerouslySetInnerHTML={{ __html: `
<a href='https://www.test.com'>internal link</a>
<a href='https://www.google.com'>external link</a>
` }} />
</Hijack>
Props
The component accepts a protocols
prop, which is a list of protocols that
should be handled natively by the browser. By default, the component only
expects 'mailto'
and 'tel'
protocols, so less common protocols such as
'ftp'
will be handled incorrectly. Simply add any necessary protocols like so:
import Hijack from '@aleph/react-router-hijack-a'
<Hijack protocols={[ 'other' ]}>
<div dangerouslySetInnerHTML={{ __html: `
<a href='mailto:[email protected]'>email</a>
<a href='other://example'>other protocol</a>
` }} />
</Hijack>
The component accepts a hostnames
prop, which is a list of hostnames that
should be interchangeable when referring to your app. If your site is available
at a single hostname, there is no need to use this prop. Most often, it should
be used to account for the www
subdomain and bare domain being interchangeable:
import Hijack from '@aleph/react-router-hijack-a'
<Hijack hostnames={[ 'test.com', 'www.test.com' ]}>
<div dangerouslySetInnerHTML={{ __html: `
<a href='https://test.com/home'>homepage</a>
<a href='https://www.test.com/home'>homepage</a>
` }} />
</Hijack>