QR shortcode

{{< new-in 0.141.0 />}}

[!note] To override Hugo's embedded qr shortcode, copy the source code to a file with the same name in the layouts/_shortcodes directory.

The qr shortcode encodes the given text into a QR code using the specified options and renders the resulting image.

Internally this shortcode calls the images.QR function. Please read the related documentation for implementation details and guidance.

Examples

Use the self-closing syntax to pass the text as an argument:

{{</* qr text="https://gohugo.io" /*/>}}

Or insert the text between the opening and closing tags:

{{</* qr */>}}
https://gohugo.io
{{</* /qr */>}}

Both of the above produce this image:

{{< qr text="https://gohugo.io" class="qrcode" targetDir="images/qr" />}}

To create a QR code for a phone number:

{{</* qr text="tel:+12065550101" /*/>}}

{{< qr text="tel:+12065550101" class="qrcode" targetDir="images/qr" />}}

To create a QR code containing contact information in the vCard format:

{{</* qr level="low" scale=2 alt="QR code of vCard for John Smith" */>}}
BEGIN:VCARD
VERSION:2.1
N;CHARSET=UTF-8:Smith;John;R.;Dr.;PhD
FN;CHARSET=UTF-8:Dr. John R. Smith, PhD.
ORG;CHARSET=UTF-8:ABC Widgets
TITLE;CHARSET=UTF-8:Vice President Engineering
TEL;TYPE=WORK:+12065550101
EMAIL;TYPE=WORK:[email protected]
END:VCARD
{{</* /qr */>}}

{{< qr level="low" scale=2 alt="QR code of vCard for John Smith" class="qrcode" targetDir="images/qr" >}} BEGIN:VCARD VERSION:2.1 N;CHARSET=UTF-8:Smith;John;R.;Dr.;PhD FN;CHARSET=UTF-8:Dr. John R. Smith, PhD. ORG;CHARSET=UTF-8:ABC Widgets TITLE;CHARSET=UTF-8:Vice President Engineering TEL;TYPE=WORK:+12065550101 EMAIL;TYPE=WORK:[email protected] END:VCARD {{< /qr >}}

Arguments

text : (string) The text to encode, falling back to the text between the opening and closing shortcode tags.

level : (string) The error correction level to use when encoding the text, one of low, medium, quartile, or high. Default is medium.

scale : (int) The number of image pixels per QR code module. Must be greater than or equal to 2. Default is 4.

targetDir : (string) The subdirectory within the publishDir where Hugo will place the generated image.

alt : (string) The alt attribute of the img element.

class : (string) The class attribute of the img element.

id : (string) The id attribute of the img element.

loading : (string) The loading attribute of the img element, either eager or lazy.

title : (string) The title attribute of the img element.