README

The Filament Barcode Scanner Input package offers a user-friendly barcode input field for your Filament applications. This component supports dynamic scanning, enabling users to input barcodes seamlessly. With a modal popup interface and customizable icons, the Filament Barcode Scanner Input package ensures an efficient and aesthetically pleasing user experience for barcode entry in your application.

Features

Modal Popup: The component opens a modal popup for barcode scanning, providing a dedicated interface for users to scan and input barcodes without cluttering the main form.
Customizable Icon: Users can customize the input field with their own Heroicons, enhancing the visual appeal and allowing for better integration with existing designs.
Responsive Design: Optimized for use on various devices, ensuring a seamless experience across desktop and mobile.
Easy Integration: Simple to integrate into your existing Filament forms with minimal configuration.

You can install the package via composer:

composer require marcelorodrigo/filament-barcode-scanner-field

You can publish the config file with:

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

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-barcode-scanner-field-views"

This is the contents of the published config file:

return [
];

Usage

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

use Marcelorodrigo\FilamentBarcodeScannerField\Forms\Components\BarcodeInput;

// In your form definition
BarcodeInput::make('barcode')
    ->icon('heroicon-o-arrow-right') // Specify your Heroicon name here
    ->required(),

Available Options

icon() - Set a custom Heroicon for the input field (e.g., 'heroicon-o-arrow-right', 'heroicon-o-qrcode')
required() - Make the barcode input required
All standard Filament field methods are supported

Testing

composer test

Versioning

This project follows Semantic Versioning (SemVer) 2.0.0 and adheres to Conventional Commits.

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

License

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

marcelorodrigo / filament-barcode-scanner-field

Maintainers

Details