faw_toast 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388801daee3762cfcdb98f9cc86bbd9bd4b643b44be12fb1a7e7b3735bd8b2e3
-  data.tar.gz: 48da98ea26d645b0da0d43d01e85fc4e517a277d2211cefa723437a71e52a93e
+  metadata.gz: b381797da514941ee2394cd7bcc634016d1af89942057800a7aab6c7a0c02435
+  data.tar.gz: 8d6e392357aea77ba878035fd476efc8f2d0f0db944abeccecc13e7dd2e738a4
 SHA512:
-  metadata.gz: 191847095c4655292ed92a25cca273feadfca6028e5fc787418952d5f1d211067dc1bbdc223715290f5a49122713045b2aa88b6ce5b05e64efe5aa11493de5e7
-  data.tar.gz: 1a1d6ab0d7247a8473a3c850742399826ab4e5b1570b482ff898741f2e3caca2129548241998361006e4ce430ab41fc2794520c3f7b20392d63da0331b707f6a
+  metadata.gz: 2ad38aa056e63c5c9cc82f13f8958c68cc3afe233793589d324f833124427fb21843ee486d987c72ce9675fc0661c3342b8600123ab3d49d90942b253bc3c9a3
+  data.tar.gz: 340e8bd832e3b8280c2137be0be7def84f918e825e4476e9e3ed4e854a4d735e8c7b62e4e37835ab257fee1c4de388cd2f1c9de030c6474e4a3fd995d05af31c

data/README.md

@@ -1,7 +1,8 @@
 # FawToast
-
 A simple, configurable toast notification system for Rails applications. FawToast provides an easy way to display flash messages as toast notifications with minimal setup.
 
+[![Gem Version](https://badge.fury.io/rb/faw_toast.svg)](https://badge.fury.io/rb/faw_toast)
+
 ## Features
 
 - Easy integration with Rails 7+ applications
@@ -40,11 +41,23 @@ rails generate faw_toast:install
 This will:
 1. Create a configuration initializer at `config/initializers/faw_toast.rb`
 2. Add the toast container to your application layout
-3. Import the required stylesheet and JavaScript controller
+
+Include the css and javascript files in your `application.html.erb` layout file.
+
+For `propshaft`
+```erb
+  <%= stylesheet_link_tag "faw_toast", "data-turbo-track": "reload" %>
+  <%= javascript_include_tag "faw_toast", "data-turbo-track": "reload", type: "module" %>
+```
+and if you are using `sprockets` include the following lines in your `config/manifest.js`
+```javascript
+//= link faw_toast.js
+//= link faw_toast.css
+```
 
 ## Usage
 
-FawToast works with Rails flash messages. You can use it like this:
+FawToast works with Rails flash messages. You can use it like this
 
 ```ruby
 # In your controller
@@ -55,6 +68,18 @@ def create
 end
 ```
 
+```ruby
+# In your background job or service object
+flash = {}
+flash[type] = message
+Turbo::StreamsChannel.broadcast_append_to(
+  channel,
+  target: "faw-toast-container",
+  partial: "faw_toast/toast",
+  locals: { flash: flash }
+)
+```
+
 FawToast supports the following flash types out of the box:
 - `:success` - Green border
 - `:alert` - Red border
@@ -94,7 +119,7 @@ FawToast uses CSS animations to show and hide toast notifications automatically.
 2. The flash message content
 3. A progress bar that indicates how much time is left before the toast disappears
 
-The toast appears with a slide-in animation, stays visible for the configured duration, and then slides out automatically. No JavaScript interaction is required for the basic functionality.
+The toast appears with a slide-in animation, stays visible for the configured duration, and then slides out automatically
 
 ## Development
 

data/app/assets/javascripts/faw_toast.js

@@ -1,4 +1,7 @@
-document.addEventListener('DOMContentLoaded', function() {
+document.addEventListener('DOMContentLoaded', faw_init);
+document.addEventListener('turbo:load', faw_init);
+
+function faw_init() {
   function setupToastListeners() {
     const toasts = document.querySelectorAll('.faw-toast');
 
@@ -26,4 +29,4 @@ document.addEventListener('DOMContentLoaded', function() {
     childList: true,
     subtree: true
   });
-});
+}

data/lib/faw_toast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FawToast
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/generators/faw_toast/install/install_generator.rb

@@ -37,20 +37,6 @@ module FawToast
           say "Please manually import the FawToast stylesheet in your application", :red
         end
       end
-
-      # def add_javascript_import
-      #   if File.exist?("app/javascript/application.js")
-      #     append_to_file "app/javascript/application.js" do
-      #       "import \"faw_toast\"\n"
-      #     end
-      #   elsif File.exist?("app/assets/javascripts/application.js")
-      #     append_to_file "app/assets/javascripts/application.js" do
-      #       "//= require faw_toast\n"
-      #     end
-      #   else
-      #     say "Please manually import the FawToast JavaScript in your application", :red
-      #   end
-      # end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faw_toast
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - alexwebgr