Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions sdk/qrcode-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,23 @@ export class DemoComponent {

* Cleans up the WebSocket connection.
---

# Mobile usage
It's scan to use QR codes on mobile. Instead you'll you want to use the **deeplink flow** instead of WebSocket, and you’ll need to import the `getUniversalLink` helper from the library. Pass your configured `selfApp` object into it along with a `deeplinkCallback` URL. The generated link can then be attached to a button or anchor tag, which will open the Self app directly.

Example:

```ts
import { getUniversalLink } from '@selfxyz/qrcode-angular';

const link = getUniversalLink({
...selfApp,
deeplinkCallback: 'https://your-app.com/callback',
});
```

```html
<a [href]="link" target="_blank">Open Self App</a>
```

---
2 changes: 1 addition & 1 deletion sdk/qrcode-angular/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@selfxyz/qrcode-angular",
"version": "1.0.1",
"version": "1.0.2",
"repository": {
"type": "git",
"url": "https://github.com/selfxyz/self"
Expand Down
Loading
Loading