{"id":16667142,"url":"https://github.com/fiberjw/react-native-app-link","last_synced_at":"2025-04-05T04:14:31.509Z","repository":{"id":37631710,"uuid":"80363865","full_name":"FiberJW/react-native-app-link","owner":"FiberJW","description":"Easily link to other apps with React Native.","archived":false,"fork":false,"pushed_at":"2021-09-27T14:24:06.000Z","size":61,"stargazers_count":570,"open_issues_count":10,"forks_count":34,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-29T21:21:17.811Z","etag":null,"topics":["android","ios","javascript","linking","mobile","react","react-native"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FiberJW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-29T18:34:09.000Z","updated_at":"2024-10-23T15:33:02.000Z","dependencies_parsed_at":"2022-07-20T00:16:52.182Z","dependency_job_id":null,"html_url":"https://github.com/FiberJW/react-native-app-link","commit_stats":null,"previous_names":["datwheat/react-native-app-link"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FiberJW%2Freact-native-app-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FiberJW%2Freact-native-app-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FiberJW%2Freact-native-app-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FiberJW%2Freact-native-app-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FiberJW","download_url":"https://codeload.github.com/FiberJW/react-native-app-link/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284953,"owners_count":20913704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","ios","javascript","linking","mobile","react","react-native"],"created_at":"2024-10-12T11:13:15.185Z","updated_at":"2025-04-05T04:14:31.484Z","avatar_url":"https://github.com/FiberJW.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Logo\" src=\"./react-native-app-link.png\" width=\"256\"\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\" style=\"font-weight:600\"\u003e\n  react-native-app-link\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\nEasily \u003ca href=\"https://en.wikipedia.org/wiki/Mobile_deep_linking\"\u003edeep link\u003c/a\u003e to other apps in React Native. If the app isn't installed on the user's phone, open the App Store or Play Store link instead.\n\u003c/p\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n[![NPM version badge](https://img.shields.io/npm/v/react-native-app-link.svg)](https://www.npmjs.com/package/react-native-app-link)\n\n\u003c/div\u003e\n\n\n\u003cdiv align=\"center\"\u003e\n\n![Example GIF](https://media.giphy.com/media/BZGQdKBEeHqs8/giphy.gif)\n\n\u003c/div\u003e\n\n\n## Installation:\n\n`npm i -S react-native-app-link`\n\n## Usage:\n\n```javascript\nimport AppLink from 'react-native-app-link';\n\nAppLink.maybeOpenURL(url, { appName, appStoreId, appStoreLocale, playStoreId }).then(() =\u003e {\n  // do stuff\n})\n.catch((err) =\u003e {\n  // handle error\n});\n\nAppLink.openInStore({ appName, appStoreId, appStoreLocale, playStoreId }).then(() =\u003e {\n  // do stuff\n})\n.catch((err) =\u003e {\n  // handle error\n});\n```\n\n## API:\n\n### `maybeOpenURL(url, config) -\u003e Promise` Opens link if app is present. If not, it opens an app store to prompt the user to download it. \n\n`url`: (String) a url in the specified app's [deep linking](https://en.wikipedia.org/wiki/Mobile_deep_linking) format that points to the content you want to open.\n\n`config`: (Object) a set of fallback urls if the app requested does not exist locally.\n\n`config.appName`: (String) the app's name you're linking into.\n\n`config.appStoreId`: (String) the app's ID on the App Store (iOS). Example: `{ appStoreId: '529379082' }`\n\n`config.appStoreLocale`: (String) the App Store's locale (iOS). Defaults to the USA App Store. Example: `{ appStoreId: 'us' }`\n\n`config.playStoreId`: (String) the app's package identifier on the Play Store (Android). Example: `{ playStoreId: 'me.lyft.android' }`\n\n---\n\n### `openInStore(config) -\u003e Promise` Opens an app store to the listing requested. \n\n`config`: (Object) a config for generate store urls.\n\n`config.appName`: (String) the app's name you're linking into.\n\n`config.appStoreId`: (String) the app's ID on the App Store (iOS). Example: `{ appStoreId: '529379082' }`\n\n`config.appStoreLocale`: (String) the App Store's locale (iOS). Defaults to the USA App Store. Example: `{ appStoreLocale: 'us' }`\n\n`config.playStoreId`: (String) the app's package identifier on the Play Store (Android). Example: `{ playStoreId: 'me.lyft.android' }`\n\n\u003e If there are any issues file an issue above and don't hesitate to spin up a PR and contribute!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiberjw%2Freact-native-app-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffiberjw%2Freact-native-app-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiberjw%2Freact-native-app-link/lists"}