README

Features

• Multiple output formats (PNG, SVG, EPS, WebP, PDF)
• Highly customizable (colors, gradients, styles, sizes)
• Specialized data types (WiFi, Email, vCard, Calendar, Phone, SMS, Geo, Bitcoin, Ethereum, Litecoin)
• Logo/image merging support (from a file path or string content)
• Built-in cache-backed generation and batch generation
• Artisan command (qrcode:generate) with CSV batch mode
• Type-safe with PHP 8.4+
• PHPStan Level 9 compliant with 100% type coverage
• Comprehensive test coverage

Requirements

• PHP 8.4+
• GD extension
• Imagick extension for PNG, WebP, and PDF output
• Laravel 12.0+

Installation

Install via Composer:

composer require akira/laravel-qrcode

Optionally, publish the configuration:

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

Quick Start

use Akira\QrCode\Facades\QrCode;

// Simple text
$qrCode = QrCode::text('Hello World');

// With customization
$qrCode = QrCode::size(300)
    ->color(255, 0, 0)
    ->text('https://example.com');

// WiFi network
$qrCode = QrCode::wifi([
    'ssid' => 'MyNetwork',
    'password' => 'secret123'
]);

// Email
$qrCode = QrCode::email('contact@example.com', 'Subject', 'Body');

// Contact card
$qrCode = QrCode::vcard([
    'fullName' => 'Jane Doe',
    'email' => 'jane@example.com'
]);

// Calendar event
$qrCode = QrCode::ical([
    'summary' => 'Release planning',
    'startsAt' => '2026-06-01 10:00:00 UTC',
    'endsAt' => '2026-06-01 11:00:00 UTC'
]);

// Phone
$qrCode = QrCode::phone('+1234567890');

// Ethereum
$qrCode = QrCode::ethereum(
    '0x0000000000000000000000000000000000000001',
    '1000000000000000000'
);

// Litecoin
$qrCode = QrCode::litecoin('ltcaddress', 1.25);

// With styling
$qrCode = QrCode::size(400)
    ->gradient(255, 0, 0, 0, 0, 255, 'diagonal')
    ->style('round', 0.7)
    ->eye('circle')
    ->text('Styled QR Code');

Documentation

Browse the full documentation in docs/, or on the package website: https://packages.akira-io.com/packages/laravel-qrcode

Highlights: Installation - Configuration - Data Types - Customization - API Reference - Command Line

Available Data Types

Customization Options

Usage Examples

In Blade Templates

{!! QrCode::format('png')->generate('https://example.com') !!}

API Response

return response()->json([
    'qrcode' => base64_encode(QrCode::format('png')->generateRaw($data))
]);

Download Response

$png = QrCode::format('png')->size(500)->generateRaw($data);

return response($png)
    ->header('Content-Type', 'image/png')
    ->header('Content-Disposition', 'attachment; filename="qrcode.png"');

With Logo

$qrCode = QrCode::format('png')
    ->size(400)
    ->errorCorrection('H')
    ->merge(public_path('logo.png'), 0.2)
    ->text('https://example.com');

Testing

# Run code quality checks and tests
composer test

# Run code style fixer
composer lint

Architecture

This package is built with:

• Action Pattern - Single-responsibility business logic
• Value Objects - Immutable, validated data structures
• Dependency Injection - Laravel IoC container
• Type Safety - PHP 8.4+ with readonly classes
• SOLID Principles - Clean, maintainable code

See Architecture Documentation for details.

Contributing

Contributions are welcome! Please see Contributing Guide for details.

Security

If you discover any security issues, please email kidiatoliny@gmail.com instead of using the issue tracker.

Credits

• Kidiatoliny
• Built with BaconQrCode
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Links

• Website
• Changelog
• Issue Tracker
• Packagist