@passageidentity/passage-react-native
Version:
Passkey Complete for React Native - Go completely passwordless with a standalone auth solution in your React Native app with Passage by 1Password
99 lines (70 loc) • 4.5 kB
Markdown
[](https://badge.fury.io/js/@passageidentity%2Fpassage-react-native) [](#) [](#) [](#) 
## About
[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease.
Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.
Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.
Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.
### In passage-react-native
Use passage-react-native to implement Passkey Complete into your React Native application to authenticate requests and manage users.
| Product | Compatible |
| --- | --- |
|  Passkey **Flex** | ✖️ For Passkey Flex, check out [passage-flex-react-native](https://github.com/passageidentity/passage-flex-react-native)
|  Passkey **Complete** | ✅
|  Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit for Android](https://github.com/passageidentity/passage-android/tree/main/authentikit) and [Authentikit for iOS](https://github.com/passageidentity/passage-authentikit-ios) |
<br />
## Getting Started
### Check Prerequisites
<p>
You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
</p>
### Install
```shell
npm i @passageidentity/passage-react-native
```
**Expo Installation**
Add your associated domain to your `.env`:
```shell
ASSOCIATED_DOMAIN=example.com
```
Add the plugin in your app.json:
```json
{
"expo": {
"plugins": [
"@passageidentity/passage-react-native"
]
}
}
```
Run expo prebuild:
```shell
npx expo prebuild
```
### Import
```js
import Passage from '@passageidentity/passage-react-native';
```
### Initialize
```js
const passage = new Passage('YOUR_PASSAGE_APP_ID');
```
### Go Passwordless
Find all core functions, user management details, and more implementation guidance on our [Passkey Complete React Native Documentation](https://docs.passage.id/complete/react-native/add-passage) page.
## Support & Feedback
We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md).
<br />
---
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
<img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
</picture>
</p>
<p align="center">
<sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br />
<sub>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</sub>
</p>