Skip to content

Update showBorder & showStatustext parameters in qrcode #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kartikmehta8 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update showBorder & showStatustext parameters in qrcode #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 11 additions & 10 deletions frontend-integration/qrcode-sdk-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,17 @@ description: API Reference for @selfxyz/qrcode

## SelfQRCodeWrapper / SelfQRCode

| Input | Type | Default | Description |
| ------------ | --------------------------------------------------------- | --------------- | ---------------------------------------------------- |
| selfApp | [#selfapp](qrcode-sdk-api-reference.md#selfapp "mention") | - | The configured Self app instance. |
| onSuccess | () ⇒ void; | - | Callback triggered when verification succeeds. |
| onError | data: { error\_code?: string; reason?: string }) => void | - | Callback triggered when verification fails. |
| type | 'websocket' \| 'deeplink' | websocket | Determines whether to use WebSocket or deep link QR. |
| websocketUrl | string | WS\_DB\_RELAYER | Custom WebSocket relayer URL. |
| size | number | 300 | Width and height of the QR Code in pixels. |
| darkMode | boolean | false | Toggles light/dark mode for QR code styling. |
| Input | Type | Default | Description |
| -------------- | --------------------------------------------------------- | --------------- | ---------------------------------------------------- |
| selfApp | [#selfapp](qrcode-sdk-api-reference.md#selfapp "mention") | - | The configured Self app instance. |
| onSuccess | () ⇒ void; | - | Callback triggered when verification succeeds. |
| onError | data: { error\_code?: string; reason?: string }) => void | - | Callback triggered when verification fails. |
| type | 'websocket' \| 'deeplink' | websocket | Determines whether to use WebSocket or deep link QR. |
| websocketUrl | string | WS\_DB\_RELAYER | Custom WebSocket relayer URL. |
| size | number | 300 | Width and height of the QR Code in pixels. |
| darkMode | boolean | false | Toggles light/dark mode for QR code styling. |
| showBorder | boolean | true | Show a colored border around the QR code that reflects the current status. |
| showStatusText | boolean | true | Show the status banner below the QR code. |

## SelfApp

Expand Down Expand Up @@ -54,4 +56,3 @@ description: API Reference for @selfxyz/qrcode
| ofac\*\* | boolean | false | Check against OFAC sanction lists. |
| excludedCountries\*\* | Country3LetterCode\[] | \[] | Exclude users from specific ISO 3166-1 alpha-3 countries. |
| minimumAge\*\* | number | 0 | Require a minimum age (e.g., `18` (upto `99`)).\| |