Generate QR Codes with the Laravel QrCode Facade API

Use the QrCode facade’s fluent, immutable builder API to generate, style, and export QR codes anywhere in your Laravel application.

The QrCode facade is the primary way to generate QR codes in PHP code — controllers, jobs, service classes, and Artisan commands. It exposes a fluent builder so you can chain options before calling generate(), and every call inherits the global defaults you set in config/qrcode.php.

Import the facade

Add the facade import at the top of any file that generates QR codes:

use Linkxtr\QrCode\Facades\QrCode;

Basic generation

generate() accepts a string payload and returns a QrCodeResult object. QrCodeResult implements Stringable, so you can cast it directly to a string to get the raw SVG markup (or binary data for PNG/WebP).

// Returns a QrCodeResult (Stringable)
$result = QrCode::generate('https://example.com');

// Cast to string to get the SVG markup
$svg = (string) $result;

Save to a file

Pass a second argument — an absolute file path — to write the output directly to disk. The directory must already exist and be writable.

QrCode::generate(
    'https://example.com',
    storage_path('app/qrcodes/example.svg')
);

generate() throws CannotWriteFileException if the target directory does not exist or the process lacks write permission. Create the directory first or catch the exception explicitly.

Fluent builder chaining

Every method on the QrCode facade returns a new immutable instance, so you can chain calls freely without mutating global state.

$qrCode = QrCode::size(300)
    ->format('png')
    ->color(255, 0, 0)          // red foreground
    ->backgroundColor(255, 255, 255)
    ->margin(2)
    ->errorCorrection('H')
    ->generate('https://example.com');

Because the builder is immutable, you can create a “base” generator once and reuse it for different payloads without side effects:

$base = QrCode::size(400)->format('png')->color(0, 102, 204);

$qr1 = $base->generate('https://example.com');
$qr2 = $base->generate('https://laravel.com');

Builder method reference

size · int

Width and height of the QR code in pixels. The config default is 400.

format · string

Output format: svg, png, webp, or eps. The config default is svg. PNG and WebP require ext-imagick or ext-gd. EPS requires no extensions.

color · int, int, int, int|null

Foreground color. In RGB mode (default): color(red, green, blue, alpha?) where each channel is 0–255 and alpha is 0–100. In CMYK mode: color(cyan, magenta, yellow, black) on a 0–100 scale.

backgroundColor · int, int, int, int|null

Background color. Accepts the same arguments as color().

margin · int

Quiet-zone margin around the QR code. The config default is 4.

errorCorrection · string

Error correction level: L (7 %), M (15 %), Q (25 %), or H (30 %). The config default is M.

encoding · string

Character encoding for the payload, e.g. UTF-8. The config default is UTF-8.

style · string

Module (dot) shape: square, dot, or round.

eye · string

Finder-pattern eye style: square, circle, or pointy.

internalEye · string

Inner eye style for composite eye patterns: square, circle, or pointy.

gradient · array, array, string

Gradient fill across the QR code modules. Pass start and end colors as RGB arrays and a direction: vertical or horizontal.

merge · string, float

Overlay an image (e.g. a logo) at the center. Pass a file path and an optional size percentage (default 0.2 = 20 %). Supported for SVG, PNG, and WebP — not EPS.

mergeString · string, float

Overlay an image passed as raw binary string content instead of a file path. Accepts the image content and an optional size percentage (default 0.2 = 20 %). Use this when the image is already loaded into memory rather than stored on disk.

cmyk · void

Switch the color model to CMYK. Use 0–100 integer values for each channel.

rgb · void

Switch the color model back to RGB (the default). Use 0–255 integer values per channel.

gray · int, int|null

Set a grayscale palette. 0 is black, 100 is white. Optionally pass a second value for the background gray level.

Output formats

SVG (default)

$svg = (string) QrCode::generate('https://example.com');
// $svg contains raw <svg>…</svg> markup

Using the facade in Blade templates

QrCodeResult is Stringable and its string value contains raw SVG markup (or binary data). Use the unescaped output directive {!! !!} so Laravel does not HTML-encode the angle brackets:

{{-- ✅ Correct — renders the SVG inline --}}
{!! QrCode::generate('https://example.com') !!}

{{-- ❌ Wrong — HTML-encodes < and > so the browser shows raw text --}}
{{ QrCode::generate('https://example.com') }}

For Blade templates, prefer the <x-qr-code> component instead — it handles escaping, accessibility attributes, and PNG/WebP base64 embedding automatically. See Blade Component.

Returning a QR code from a controller

SVG response

use Illuminate\Http\Response;
use Linkxtr\QrCode\Facades\QrCode;

public function show(): Response
{
    $svg = (string) QrCode::size(300)->generate('https://example.com');

    return response($svg, 200)
        ->header('Content-Type', 'image/svg+xml');
}

PNG response

use Illuminate\Http\Response;
use Linkxtr\QrCode\Facades\QrCode;

public function show(): Response
{
    $png = (string) QrCode::size(300)->format('png')->generate('https://example.com');

    return response($png, 200)
        ->header('Content-Type', 'image/png');
}

File download

use Illuminate\Http\Response;
use Linkxtr\QrCode\Facades\QrCode;

public function download(): Response
{
    $path = storage_path('app/qrcodes/qr.png');

    QrCode::size(400)
        ->format('png')
        ->generate('https://example.com', $path);

    return response()->download($path, 'qrcode.png');
}

Styled QR code examples

Brand colors

QrCode::size(300)
    ->color(58, 94, 255)           // blue modules
    ->backgroundColor(255, 255, 255)
    ->style('dot')
    ->eye('circle')
    ->generate('https://example.com');

Config-driven defaults

When you resolve the QrCode facade, the package automatically reads config/qrcode.php and uses those values as defaults. Any method you chain overrides only that specific option for the current chain.

// config/qrcode.php sets size=400, format=svg, margin=4, error_correction=M
// The chain below only overrides color — everything else comes from config
QrCode::color(0, 102, 204)->generate('https://example.com');

Publish the config file to customise the global defaults:

php artisan vendor:publish --tag=qrcode-config

Config defaults apply when you use the facade, the Blade component, or resolve Linkxtr\QrCode\Generator from the service container. If you instantiate new Generator() directly, you get hardcoded package defaults unless you pass the config array yourself.

Built-in data-type helpers

The facade includes helpers for common structured payloads. Each returns a QrCodeResult just like generate().

BTC

QrCode::BTC(
    'bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq',
    0.001
);

Email

QrCode::Email(
    '[e-mail]',
    'Subject',
    'Body text'
);

WiFi

QrCode::WiFi([
    'ssid'       => 'MyNetwork',
    'encryption' => 'WPA2',
    'password'   => 's3cr3t',
]);

vCard

QrCode::VCard([
    'name'  => 'Jane Doe',
    'email' => '[e-mail]',
    'phone' => '[phone]',
    'url'   => 'https://example.com',
]);

Geo

QrCode::Geo(37.7749, -122.4194);

SMS

QrCode::SMS('[phone]', 'Hello!');

WhatsApp

QrCode::WhatsApp([
    'number'  => '[phone]',
    'message' => 'Hi there!',
]);