README

Filament QrCode Field

A Laravel Filament package that provides QR Code field functionality for your web applications. This package extends Filament v4 with a simple QR code input component.

Compatibility

Requirements

• PHP 8.2 or higher
• Filament 5.0

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-qrcode-field:^3.0

You can publish the config file with:

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

This is the contents of the published config file:

use Filament\Support\Enums\Width;

return [
    'asset_js' => 'https://unpkg.com/html5-qrcode@2.3.8/html5-qrcode.min.js',
    'modal' => [
        'width' => Width::Large,
    ],
    'reader' => [
        'width' => '600px',
        'height' => '600px',
    ],
    'scanner' => [
        'fps' => 10,
        'width' => 250,
        'height' => 250,
    ],
];

Translations

This package supports multiple languages. The following languages are currently available:

• Arabic (ar)
• Czech (cs)
• German (de)
• English (en)
• Spanish (es)
• Persian (fa)
• French (fr)
• Hebrew (he)
• Indonesian (id)
• Italian (it)
• Japanese (ja)
• Dutch (nl)
• Polish (pl)
• Portuguese (pt)
• Portuguese (Brazil) (pt_BR)
• Portuguese (Portugal) (pt_PT)
• Slovak (sk)
• Turkish (tr)

If you want to customize the translations, you can publish the language files:

php artisan vendor:publish --tag=filament-qrcode-field-translations

Usage

Once installed, you can use the QrCodeInput component in your Filament forms:

use JeffersonGoncalves\Filament\QrCodeField\Forms\Components\QrCodeInput;

// In your form definition
QrCodeInput::make('qrcode')
    ->required(),

Development

You can run code analysis and formatting using the following commands:

# Run static analysis
composer analyse

# Format code
composer format

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Jèfferson Gonçalves
• All Contributors

License

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