Skip to content

[PR-26010] Update qr_code filter doc #423

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[PR-26010] Update qr_code filter doc #423

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67a7cd3
[PR-26010] Update qr_code filter doc
Doimhneacht Dec 2, 2025
cbaf47d
Update docs
Doimhneacht Dec 2, 2025
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
12 changes: 10 additions & 2 deletions source/campaigns/editor/filters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -996,7 +996,8 @@ This example can be used in ``Email sending condition`` of Advocate Offer Email
qr\_code
........

Converts a string into a QR code image in SVG format.
Converts a string into a QR code. By default, produces an image in SVG format. If ``png_base64`` format is specified,
returns a source for an HTML element, containing a base64-encoded PNG image.

.. code-block:: liquid

Expand All @@ -1006,7 +1007,8 @@ Converts a string into a QR code image in SVG format.

It may take the following arguments:

* ``xdim`` - the width of the narrowest bar in a barcode. Thicker bars are multiples of the xdim. Default value is ``4``.
* ``xdim`` - the width of the cell in a QR code. Default value is ``4``.
* ``format`` - custom format for the result. Only ``png_base64`` is supported.

This filter generates a QR code that can be used to encode URLs, text, or coupon codes. The QR code is returned as an SVG image that can be directly embedded in HTML.

Expand All @@ -1018,6 +1020,12 @@ This filter generates a QR code that can be used to encode URLs, text, or coupon
{{ coupon.code | qr_code: xdim: 6 }}
</div>

To return a QR code as a base64-encoded PNG that can be embedded in email body, use the custom format:

.. code-block:: liquid

<img src="{{ coupon.code | qr_code: format: 'png_base64' }}" />

|hr|

rand\_by
Expand Down