README

FilamentSound is a Laravel package that enhances the Filament CRUD framework by adding sound-playing functionality. It allows developers to integrate audio notifications or feedback into their applications following CRUD operations. With FilamentSound, you can configure the package to play custom sound effects, such as success chimes or error alerts, after data creation, update, or deletion.

The package provides a simple and convenient way to incorporate auditory cues into your application's user experience. By utilizing the Web Audio API and event listeners, FilamentSound detects successful CRUD operations and triggers the corresponding sound effect in response. This helps users receive immediate feedback and acknowledgment when performing actions like creating new records, updating existing data, or deleting entries.

FilamentSound includes a configuration file that allows developers to specify the path to their sound files or customize other settings. The package's assets, including the provided sound files, can be easily published and integrated into the Laravel application using Laravel's asset publishing feature.

With FilamentSound, you can enhance the interactivity and user engagement of your Filament-powered applications by incorporating audio notifications, providing a more immersive and dynamic user experience.

Installation

You can install the package via composer:

composer require ibrahimbougaoua/filament-sound

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-sound-migrations"
php artisan migrate

You can install filament sound with:

php artisan filament-sound:install

You can restore filament sound settings with:

php artisan filament-sound:restore-settings

You can publish the config file with:

php artisan vendor:publish --tag="filament-sound-config"

This is the contents of the published config file:

return [
    'navigation' => true,
    'user_menu_item' => true,
    'restore_settings' => false,
    'audio' => true,
    'browse_audio' => true
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-sound-views"

Testing

composer test

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.

ibrahimbougaoua / filament-sound

Maintainers

Details