Merge pull request #41 from mikebarlow/develop

V2.1.0
mikebarlow · Sep 11, 2024 · 9d15c55 · 9d15c55
2 parents d612386 + 14398cb
commit 9d15c55
Show file tree

Hide file tree

Showing 28 changed files with 5,205 additions and 3,888 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-20.04]
-        php: ['8.1', '8.2']
+        php: ['8.1', '8.2', '8.3']
 
     name: P${{ matrix.php }}
     steps:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2024-09-11
+
+* Moved SVG icons into anonymous components for easier reuse / overwriting.[PR#35](https://github.com/mikebarlow/megaphone/pull/35)
+* Reworked notification type templates into components. [PR#35](https://github.com/mikebarlow/megaphone/pull/35)
+* Added "mark all as read" feature for unread notifications. [PR#37](https://github.com/mikebarlow/megaphone/pull/37)
+* Added support for `wire:poll` to give the impression of a live component. [PR#38](https://github.com/mikebarlow/megaphone/pull/38)
+* Added `@megaphoneStyles` blade directive + improved default styles. [PR#39](https://github.com/mikebarlow/megaphone/pull/39)
+
 ## [2.0.0] - 2023-09-11
 
 * Updated PHP requirement to 8.1 and above (7.4 and 8.0 dropped) [PR#28](https://github.com/mikebarlow/megaphone/pull/28)

diff --git a/README.md b/README.md
@@ -93,19 +93,23 @@ If you are not using the default user model found at `App\Models\User`, you will
 To get started using megaphone, drop in the Megaphone Livewire component into your template.
 
 ```html
-<livewire:megaphone></livewire:megaphone>
+<livewire:megaphone />
 ```
 
 This will render a Bell Icon where the component has been placed. When clicked a static sidebar will appear on the right of the screen which will show all the existing and any new notifications to the user.
 
 ### Styling
 
-As default, Megaphone uses TailwindCSS to style the Bell Icon and the notification sidebar. If you are not using Tailwind you may want to include the Megaphone CSS into your template.
+As default, Megaphone uses TailwindCSS to style the Bell Icon and the notification sidebar. If you are not using Tailwind you may want to include the Megaphone CSS into your template. Add the following blade directive to your sites `<head></head>`.
 
 ```html
-<link rel="stylesheet" href="{{ asset('vendor/megaphone/css/megaphone.css') }}">
+@megaphoneStyles
 ```
 
+If you are using TailwindCSS, make sure the Megaphone views are added to any Tailwind config to ensure the correct classes are compiled.
+
+If you wish to recompile Megaphone stylesheet, ensure you have node and npm installed and run `npm install`. To compile the styles then run `npx mix` as per the [Larave Mix Documentation](https://laravel-mix.com/docs/6.0/installation)
+
 ## Sending Notifications
 
 As default, Megaphone will only load notifications that have been registered within the Megaphone config file. Notifications shipped with Megaphone will be within `config('megaphone.types')`. This will be merged with the key values of `config('megaphone.customTypes')` to create the list of supported notifications.

diff --git a/config/megaphone.php b/config/megaphone.php
@@ -46,4 +46,19 @@
      * show a dot instead
      */
     'showCount' => true,
+
+    /*
+     * Enable Livewire Poll feature for auto updating.
+     * See livewire docs for poll option descriptions
+     * @link https://livewire.laravel.com/docs/wire-poll
+     */
+    'poll' => [
+        'enabled' => false,
+
+        'options' => [
+            'time' => '15s',
+            'keepAlive' => false,
+            'viewportVisible' => false,
+        ],
+    ],
 ];