Livewire UI for Laravel based user notifications
Massive thanks to @gregorysouzasilva for the initial work to kick start this but Megaphone 2.0.0 is now available and supports Livewire 3.
This new release drops support for Livewire 2 and PHP 7.4 and 8.0. The PHP versions have been dropped to match the supported PHP versions of Livewire 3.
The upgrade process is relatively painless and most of the upgrade work will be upgrading your installation of Livewire itself. See the new section of the readme for the upgrade process
Massive thank you to @pjkellar for the majority of the changes in this.
This release addresses the issue with Issue #20 where the User model data was visible in the Livewire requests. The way notifications are loaded has been reworked to prevent this. The change also allows Megaphone to be used properly with something other than Users models if required.
A massive thank you to @pjkellar for all the work with this release.
A new bell icon SVG has been added which looks a lot nicer! Also improved is the styling for the unread notification badge. There was a bug with the styling when a large number of unread notifications were present, this PR will fix this issue. Also included is a new config option that toggles the unread notification count on or off (the default value is on). If set to false, a simple red dot is shown. Thank you also to @hpacleb for the readme fix PR!
This has been tagged a minor release due to no breaking changes occurring by performing a simple composer update. However, to make full use of the update a php artisan vendor:publish --force --tag=megaphone will be required.
NOTE Please ensure you backup or make a note of any changes you have made to the following folders/files before performing the vendor publish as they will be overwritten.
Once vendor publish has run, remember to merge back in any changes you have made that are required.
Thanks again to @pjkellar and @hpacleb 🙏
Previously the mark as read feature for announcements was done on "mouseenter", depending on location on the page, when clicking the Bell Icon to open the popout it could sometimes result in the notification becoming instantly read if your mouse just happened to be over the notification. This has been removed in favour of adding a physical "mark as read" button on each unread notification, this puts the onus on the user to physical click to say they've seen / read the notification.
Due to the template changes, this PR also includes extra vendor:publish groups so you can publish just the megaphone views without it overwriting your config or assets.
If you published the templates from a previous version of Megaphone, updating to 1.0.2 won't automatically update your templates to have the new "mark as read" button. You can continue to use the old "mouseenter" event version of the templates and Megaphone will continue to work. If you would prefer to use the newer templates, simply run the following vendor publish command. Before running the command, if you have made any changes to the templates to match the theme of your application, make sure to back up those changes as this command will overwrite all megaphone templates within resources/views/vendor/megaphone.
php artisan vendor:publish --force --tag=megaphone-views
First release of Megaphone, a Livewire-based component that uses the power of Laravels built-in Notifications system to allow you to add "Bell Icon Notification System" to your app.