|
1 |
| -<img src="https://storage.googleapis.com/passage-docs/Lockup%20Vertical%20color.png" alt="Passage logo" style="width:250px;"/> |
| 1 | + |
2 | 2 |
|
3 |
| -[](https://pub.dartlang.org/packages/passage_flutter) |
| 3 | +[](https://pub.dartlang.org/packages/passage_flutter)  [](#) [](#)  |
4 | 4 |
|
5 |
| -### Native passkey authentication for your Flutter app |
6 |
| -## Welcome! |
7 |
| -Integrating passkey technology can be really hard. That's why we built the Passage Flutter SDK - to make passkey authentication easy for you and your users - across native iOS, native Android, and web. |
| 5 | +## About |
8 | 6 |
|
9 |
| -<img width="1069" alt="Passage Flutter" src="https://storage.googleapis.com/passage-docs/passage-flutter.png"> |
| 7 | +[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. |
10 | 8 |
|
11 |
| -<br> |
| 9 | +Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience. |
12 | 10 |
|
13 |
| -## Installation |
| 11 | +Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution. |
14 | 12 |
|
15 |
| -```sh |
| 13 | +Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys. |
| 14 | + |
| 15 | +### In passage-flutter |
| 16 | + |
| 17 | +Use passage-flutter to implement Passkey Complete in your Flutter application to authenticate requests and manage users. |
| 18 | + |
| 19 | +| Product | Compatible | |
| 20 | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 21 | +|  Passkey **Flex** | ✖️ For Passkey Flex, check out the [Passkey Flex for Android](https://github.com/passageidentity/passage-android/tree/main/passageflex) and [Passkey Flex for iOS](https://github.com/passageidentity/passage-flex-ios) | |
| 22 | +|  Passkey **Complete** | ✅ | |
| 23 | +|  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) | |
| 24 | + |
| 25 | +<br /> |
| 26 | + |
| 27 | +## Getting Started |
| 28 | + |
| 29 | +### Check Prerequisites |
| 30 | + |
| 31 | +<p> |
| 32 | + 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 /> |
| 33 | + <sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub> |
| 34 | +</p> |
| 35 | + |
| 36 | +### Install |
| 37 | + |
| 38 | +```shell |
16 | 39 | flutter pub add passage_flutter
|
17 | 40 | ```
|
18 |
| -<br> |
19 | 41 |
|
20 |
| -## Example Usage |
| 42 | +### Import |
21 | 43 |
|
22 | 44 | ```dart
|
23 | 45 | import 'package:passage_flutter/passage_flutter.dart';
|
| 46 | +``` |
| 47 | + |
| 48 | +### Initialize |
24 | 49 |
|
| 50 | +```dart |
25 | 51 | final passage = PassageFlutter('YOUR_PASSAGE_APP_ID');
|
| 52 | +``` |
26 | 53 |
|
27 |
| -// Register a new user with a passkey |
28 |
| -await passage.passkey.register('[email protected]'); |
| 54 | +### Go Passwordless |
29 | 55 |
|
30 |
| -// Get authenticated user info |
31 |
| -final user = await passage.currentUser.userInfo(); |
32 |
| -``` |
| 56 | +Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Flutter Documentation](https://docs.passage.id/complete/flutter/add-passage) page. |
| 57 | + |
| 58 | +## Support & Feedback |
| 59 | + |
| 60 | +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). |
| 61 | + |
| 62 | +<br /> |
| 63 | + |
| 64 | +--- |
33 | 65 |
|
34 |
| -To see a full example, check out our [Flutter Example App](https://github.com/passageidentity/example-flutter). |
35 |
| -<br> |
| 66 | +<p align="center"> |
| 67 | + <picture> |
| 68 | + <source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png"> |
| 69 | + <source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png"> |
| 70 | + <img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png"> |
| 71 | + </picture> |
| 72 | +</p> |
36 | 73 |
|
37 |
| -## Documentation |
38 |
| -To get started using Passage in your Flutter app, please visit our [Passage Docs](https://docs.passage.id/mobile/cross-platform/flutter). |
| 74 | +<p align="center"> |
| 75 | + <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 /> |
| 76 | + <sub>This project is licensed under the MIT license. See the <a href="LICENSE.md">LICENSE</a> file for more info.</sub> |
| 77 | +</p> |
0 commit comments