@codexteam/deeplinker
Advanced tools
Tiny script that helps you to use one link to open web pages or installed apps
This module helps you to create links to open pages in apps directly if it is possible. Otherwise web page will be opened.
You can install script via package managers or download it to your server.
Install package
npm install @codexteam/deeplinker --save
yarn add @codexteam/deeplinker
Then require deeplinker module
const deeplinker = require('@codexteam/deeplinker');
Download dist/deeplinker.js file to your server and add it to your webpage.
<script src="dist/deeplinker.js" async></script>
Let's imagine that you want to create a link that opens some page in application, if it is installed. If target application is missing then link should open a web page as a normal link.
Check out example schemes below.
Call deeplinker.click(element) function. Element should contain the following params:
data-link or href with a usual linkdata-app-link with a deep link (with custom protocol) to an applicationUpgrade your link element by adding a listener with preventing default action. Set up data-app-link param.
<a href="https://www.instagram.com/codex_team/"
onclick="event.preventDefault(); deeplinker.click(this)"
data-app-link="instagram://user?username=codex_team">Follow us on Instagram</a>
Or add listener to any element. Set up data-link and data-app-link params.
<div onclick="deeplinker.click(this)"
data-link="https://t.me/codex_team"
data-app-link="tg://resolve?domain=codex_team">Join our Telegram-channel</div>
If you want to try to open app silently then call deeplinker.tryToOpenApp(deepLink).
Could be useful for redirection or invitation pages.
Doesn't works on mobile devices.
<body onload="deeplinker.tryToOpenApp('tg://user?username=codex_team')">
tg://resolve?domain=[username]
twitter://user?screen_name=[username]
instagram://user?username=[username]
fb://profile/[id]
vk://vk.com/[id]
Feel free to ask a question or improve this project.
MIT
FAQs
Tiny script that helps you to use one link to open web pages or installed apps
We found that @codexteam/deeplinker demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers discovered nine malicious NuGet packages that use time-delayed payloads to crash applications and corrupt industrial control systems.
Security News
Socket CTO Ahmad Nassri discusses why supply chain attacks now target developer machines and what AI means for the future of enterprise security.
Security News
Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.