Skip to content
This repository was archived by the owner on Jan 9, 2026. It is now read-only.

Commit e5d0025

Browse files
authored
Update README.md
1 parent 940467b commit e5d0025

1 file changed

Lines changed: 43 additions & 29 deletions

File tree

README.md

Lines changed: 43 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![passage-flex-react-native](https://storage.googleapis.com/passage-docs/github-md-assets/passage-flex-react-native.png)
22

3-
![NPM Version](https://img.shields.io/npm/v/%40passageidentity%2Fpassage-flex-react-native?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40passageidentity%2Fpassage-flex-react-native) [![React Native](https://img.shields.io/badge/React_Native-%2320232a.svg?logo=react&logoColor=%2361DAFB)](#) ![NPM Type Definitions](https://img.shields.io/npm/types/%40passageidentity%2Fpassage-flex-react-native) ![GitHub License](https://img.shields.io/github/license/passageidentity/passage-flex-react-native)
3+
![NPM Version](https://img.shields.io/npm/v/%40passageidentity%2Fpassage-flex-react-native?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40passageidentity%2Fpassage-flex-react-native) [![React Native](https://img.shields.io/badge/React_Native-%2320232a.svg?logo=react&logoColor=%2361DAFB)](#) [![Expo](https://img.shields.io/badge/Expo-000020?logo=expo&logoColor=fff)](#) ![NPM Type Definitions](https://img.shields.io/npm/types/%40passageidentity%2Fpassage-flex-react-native) ![GitHub License](https://img.shields.io/github/license/passageidentity/passage-flex-react-native)
44
![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password)
55

66

@@ -31,53 +31,67 @@ Use passage-flex-react-native to implement Passkey Flex in your Swift applicatio
3131

3232
### Check Prerequisites
3333

34+
3435
<p>
35-
You'll need a free Passage account and a Passkey Flex app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
36-
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
36+
You'll need a free Passage account and a Passkey Flex app set up in <a href="https://console.passage.id/">Passage Console</a> to get started.<br />
37+
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
3738
</p>
3839

39-
Add an Android and/or iOS app in the Native Apps section.
40+
<p>
41+
Add an Android and/or iOS app in the Native Apps section for your Passkey Flex app.
42+
</p>
43+
44+
<p>
45+
<i>Note: When you add your Native App info, you can generate the associated domain file for that app if you haven’t already created it yourself, as shown:</i> <br /><img width="600" src="https://docs.passage.id/_next/image?url=%2Fimages%2Fv1-doc-images%2Fios-download-config-file.png&w=3840&q=75" />
46+
</p>
4047

41-
When you add your Native App info, you can generate the associated domain file for that app if you haven’t already created it yourself, as shown below:
42-
![Passage Native Apps screenshot](https://docs.passage.id/_next/image?url=%2Fimages%2Fv1-doc-images%2Fios-download-config-file.png&w=3840&q=75)
4348

4449
### Install
4550
```shell
4651
npm i --save @passageidentity/passage-flex-react-native
4752
```
4853

49-
#### Expo
54+
### Configure
5055

51-
Add plugin in app.json:
52-
53-
```json
54-
"plugins": [
55-
"@passageidentity/passage-flex-react-native"
56-
]
57-
```
58-
59-
Add `ASSOCIATED_DOMAIN` value to your app's `.env` file:
56+
> [!IMPORTANT]
57+
> In order for passkeys to work, you’ll need to associate your native app(s) with the public web domain you assigned to your Passkey Flex app.
58+
>
59+
> Android requires an `assetlinks.json` file configured and hosted <br /><sub>Learn more about <a href="https://developer.android.com/identity/sign-in/credential-manager#add-support-dal">Adding support for Digital Asset Links →</a></sub>
60+
>
61+
> Apple requires an `apple-app-site-association` file configured and hosted <br /><sub>Learn more about <a href="https://developer.apple.com/documentation/Xcode/supporting-associated-domains">Supporting associated domains →</a></sub>
62+
63+
64+
<details>
65+
<summary><b>Expo Configuration</b></summary>
66+
67+
<br />
68+
69+
Add the `passage-flex-react-native` expo plugin in `app.json`:
70+
71+
```json
72+
"plugins": [
73+
"@passageidentity/passage-flex-react-native"
74+
]
75+
```
6076

77+
Add `ASSOCIATED_DOMAIN` value to your app's `.env` file:
78+
6179
```
62-
ASSOCIATED_DOMAIN=example.com
80+
ASSOCIATED_DOMAIN=example.com
6381
```
64-
82+
6583
Run the following:
6684
```
6785
npx expo prebuild
6886
```
6987

70-
#### Bare React Native
71-
72-
See our [Passkey Complete documentation](https://docs.passage.id/complete/cross-platform-passkey-configuration/cross-platform-ios-configuration) for setting up a React Native app for passkeys and Passage.
73-
74-
#### Hosted associated domains files
75-
76-
In order for passkeys to work, you’ll need to associate your native app(s) with the public web domain you assigned to your Passkey Flex app.
77-
78-
Android requires an `assetlinks.json` file configured and hosted (learn more [here](https://developer.android.com/identity/sign-in/credential-manager#add-support-dal)).
88+
</details>
7989

80-
Apple requires an `apple-app-site-association` file configured and hosted (learn more [here](https://developer.apple.com/documentation/Xcode/supporting-associated-domains)).
90+
<details>
91+
<summary><b>Bare React Native Configuration</b></summary>
92+
<br />
93+
See our <a href="https://docs.passage.id/complete/cross-platform-passkey-configuration/cross-platform-ios-configuration">Passkey Complete documentation</a> for setting up a React Native app for passkeys and Passkey Flex.
94+
</details>
8195

8296

8397
### Import
@@ -92,7 +106,7 @@ const passageFlex = new PassageFlex('YOUR_PASSAGE_APP_ID');
92106

93107
### Go Passwordless
94108

95-
Find more details about Passkey Flex on our [Passkey Flex Documentation](https://docs.passage.id/flex) page.
109+
Check out the [API Reference](#api-reference) below, along with more details about Passkey Flex on our [Passkey Flex Documentation](https://docs.passage.id/flex) page.
96110

97111
# API Reference
98112

0 commit comments

Comments
 (0)