Generate QRCodes. The included Panel-Field will show the QRCode and trigger download on click.

2.1.1 2023-03-07 20:20 UTC


Release Downloads Build Status Coverage Status Maintainability Twitter

Generate QRCodes easily. The included Panel-Field will show the QRCode and trigger download on click.

Commerical Usage

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno
Github sponsor Patreon Buy Me a Coffee Paypal dontation Hire me


  • unzip as folder site/plugins/kirby3-qrcode or
  • git submodule add site/plugins/kirby3-qrcode or
  • composer require bnomei/kirby3-qrcode



$qrcodeObject = new \Bnomei\QRCode([
    'Text' => '',
echo $qrcodeObject->html();

Page Method


// base64 encoded png image tag
// with $page->url() as Text
echo $page->qrcode()->html(
    $page->slug() . '.png' // image format detected from extension

Save as File in Page Object

When saving you can in addtion to the filename provide additional content data for the file or force an overwrite (which will change UUID and media hash) with additional function params. The logic will use the currently logged-in user or impersonate as kirby to create the file.


$qrcodeFilename = $page->slug() . '.png';
$file = $page->file($qrcodeFilename);

if (!$file) {
    // short version
    $file = $page->qrcode()->save(
    // with all params
    $file = $page->qrcode()->save(
        'myfiletemplate', // or null
        [/* my content data array */],
        true // force overwrite

echo $file; // outputs a img tag

Why not overwrite file by default? Let's assume you want to send the qrcode by email. Then you do not want to overwrite later because that would change the media hash and break the URL to the image send within the email.

Could I not embed the qrcode inline using base-64 encoding? Technically yes, but almost no email clients would render it.

Trigger download


    $page->slug() . '.png'

Further customization of the generated image

Advanced options can be set.

echo $page->qrcode([
    'margin' => 10,
    'encoding' => 'UTF-8',
    'foregroundColor' => new \Endroid\QrCode\Color\Color(0, 0, 0),
    'backgroundColor' => new \Endroid\QrCode\Color\Color(255, 255, 255),
    'labelText' => 'Scan the code',
    'logoPath' => __DIR__.'/../assets/images/getkirby.png',
    'size' => 200,
    $page->slug() . '.png'

TIP: You could move that options array for frontend rendering into a config value or reuse the option('bnomei.qrcode.field') which defines the look inside the panel.

Panel Field: Url of Page/File as QRCode

Add the field to a blueprint. This will show the QRCode as PNG image and will trigger the download of the file on click.


  # current page
  qrcode: qrcode

    type: qrcode
    title: Text below image

  # title with query
    type: qrcode
    title: "{{ page.title }}"

  # custom url
    type: qrcode
    title: Panel Url of {{ page.title }}
    url: "{{ page.panel.url }}"

  # custom url and custom filename with |
    type: qrcode
    title: Issue 7
    url: "|Issue 7"

You can define the options how the qrcode field shows the image inside the panel in your config file. Example:



return [
    // other options...
    // set values for qrcode inside the panel
    'bnomei.qrcode.field' => [
        'foregroundColor' => new \Endroid\QrCode\Color\Color(126, 154, 191),
        'backgroundColor' => new \Endroid\QrCode\Color\Color(239, 239, 239),
        'size' => 128,
        'margin' => 0,

You can also reuse this in your frontend code like so:

$page->qrcode(option('bnomei.qrcode.field', []))->download(
    $page->slug() . '.png'



This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.



It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.


based on V2 versions of