Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 4.38 KB

getqrcoderequest.md

File metadata and controls

25 lines (20 loc) · 4.38 KB

GetQRCodeRequest

Example Usage

import { GetQRCodeRequest } from "dub/models/operations";

let value: GetQRCodeRequest = {
  url: "https://damaged-scrap.org",
};

Fields

Field Type Required Description
url string ✔️ The URL to generate a QR code for.
logo string ➖ The logo to include in the QR code. Can only be used with a paid plan on Dub.co.
size number ➖ The size of the QR code in pixels. Defaults to 600 if not provided.
level operations.Level ➖ The level of error correction to use for the QR code. Defaults to L if not provided.
fgColor string ➖ The foreground color of the QR code in hex format. Defaults to #000000 if not provided.
bgColor string ➖ The background color of the QR code in hex format. Defaults to #ffffff if not provided.
hideLogo boolean ➖ Whether to hide the logo in the QR code. Can only be used with a paid plan on Dub.co.
margin number ➖ The size of the margin around the QR code. Defaults to 2 if not provided.
includeMargin boolean ➖ DEPRECATED: Margin is included by default. Use the margin prop to customize the margin size.