From 2092b0bcf9fed0ed877d307df2768655f9d491a5 Mon Sep 17 00:00:00 2001 From: Kartik Mehta Date: Thu, 15 Jan 2026 13:42:57 +0530 Subject: [PATCH] Update showBorder & showStatustext parameters in qrcode --- .../qrcode-sdk-api-reference.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/frontend-integration/qrcode-sdk-api-reference.md b/frontend-integration/qrcode-sdk-api-reference.md index 421b77a..c8b2a5f 100644 --- a/frontend-integration/qrcode-sdk-api-reference.md +++ b/frontend-integration/qrcode-sdk-api-reference.md @@ -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 @@ -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`)).\| | -