Customisation Options

Configuration options available when generating QR codes

Available Options

The table below documents the available customisation options for QR codes generated using our app and APIs. It also outlines whether a configuration option requires a premium license key to work, or if it's available on the free tier.

Parameter	Description	Premium Feature?
PixelsPerModule Required	Default value: 20 Number of pixels per module. For example, 20 pixels per module will result in an image approximately 400x400px.	No
Content Required	The URL encoded content to be embedded within the generated QR code, such as a URL or text. This is what is displayed/used by QR code readers.	No
PrimaryColor	Default value: #000 The colour of the code pattern. Must be a valid HEX code.	No
SecondaryColor	Default value: #FFF The colour of the code background. Must be a valid HEX code.	No
EnableMargin	Default value: true Adds a margin around the outside of the QR code. Otherwise known as the quiet zone.	No
ErrorCorrectionLevel	Default value: M Accepted values: Q, H, L, M Uses the Reed-Solomon Code to correct the QR code content if the code is partially unreadable (eg. through damage or dust). The higher the level, the more data is stored making the image larger.	No
Size	Default value: 150 Size of QR code, specified in pixels	No
Heading	Optional heading string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in PixelsPerModule and Size.	Yes
Subtitle	Optional subtitle string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in PixelsPerModule and Size.	Yes
FileType	Default value: Svg Accepted values: Svg, Jpg, Png, Gif, Ascii File format that the QR code is returned in. Note that some formats require a paid license, or may not support all functionality listed above.	No
License	License key, required to avoid watermark and use paid license features.	Yes

Automation Script Support

If you're using our Airtable automation script, you can use all of the above customisations. Simply append any of the above values to the URL specified within the script. For example, the snippet below adds support for the Heading and Subtitle fields:

// Fetch the field and value for the heading field
let headingContentField = table.getField(“Your Heading Field");
var headingContent = record.getCellValueAsString(headingContentField);

// Fetch the field and value for the subtitle field
let subtitleContentField = table.getField(“Your Subtitle Field");
var subtitleContent = record.getCellValueAsString(headingContentField);

// Update the 'url' below to include support for the heading and subtitle fields
// Note the addition of '&heading=' + encodeURIComponent(headingContent) + '&subtitle=' + encodeURIComponent(subtitleContent)
updatedRecord.fields[imageAttachmentField.name] = [
    {
        url: 'https://qrcodegenerator.api.littleappy.co/api/qrcode/basic?Content=' + encodeURIComponent(content) + '&heading=' + encodeURIComponent(headingContent) + '&subtitle=' + encodeURIComponent(subtitleContent) + '&FileType=Png&ErrorCorrectionLevel=' + errorCorrectionLevel + '&PixelsPerModule=20&License=' + encodeURIComponent(licenseKey),
        filename: record.id + ".png"
    }
];