rails_toastify 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e701bb2d6bfd26a8e51e688c051448bb68f6b09d5b0edd60e047e1c3609000f
-  data.tar.gz: f43ef70a87f3b816c5deeab1e9ad8969d800c3ea429c9aea797539c71bfaa788
+  metadata.gz: 0fca6e66a1b85a3f5cd57d51355f21342bca3f64b2ddc265c5e6231992c6aaa7
+  data.tar.gz: a789a98299bce7cd3cc6ae983f1589dc3e0e0f983c7e7d500a191f088f82770a
 SHA512:
-  metadata.gz: 6237ad77aea9dc367aa4a21590cbcd95b01680cef1370d6db7914d9f257499c2d13cc299f958a2f722a5db9d71969d321799a680b3530f63b686c9828d779399
-  data.tar.gz: 2c05603ad580b88f8be579fa649a8f1a1d67c8090291a7cf5e9496844fc7b2690e94447da39e535d57cdcf7eb972304547ef40e3992cea54009cf3e08dbeaae3
+  metadata.gz: 91597bde294f1bd803f3aa6c4f989cb639564cb15d3835d25f70a2fbc4d4af5645c5c5c6f029331588f6c0a205c974fdf84fc69093dc22b7a1ec34ab9bb21c8d
+  data.tar.gz: 9b6610626c2baef2458f2153a4fb33c37e402b8cbbc380e8cef37793adf1463699b55a99412b367cd32084cb9cc0ec31d7a33cc0dfd244b95c5d0af15fe8112b

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.2.1
+
+- Version stable tested and approved
+- Change Changelog
+- Change Readme
+
+## 1.2.0
+
+- Add configuration to notice type and alert type
+- Fix helper and methods
+
+## 1.1.1
+
+- Create helper and methods
+- Fix javascript
+
 ## 1.1.0
 
 - Add others configurations (position, animation, duration, theme and type)

data/README.md

@@ -2,7 +2,9 @@
 
 **Rails Toastify** allows you to easily add notifications to your app. Please CONTRIBUTE.
 
-The **Rails Toastify** gem is completely inspired by the [React Toastify](https://fkhadra.github.io/react-toastify/introduction/) lib and is specially made for those React developers who are migrating to Rails thanks to Hotwire or for any other reason, and who love using Toasts and wanted a gem that makes it as easy as it is in React. 🎉 
+The **Rails Toastify** gem is completely inspired by the [React Toastify](https://fkhadra.github.io/react-toastify/introduction/) lib and is specially made for those React developers who are migrating to Rails thanks to Hotwire or for any other reason, and who love using Toasts and wanted a gem that makes it as easy as it is in React. 🎉
+
+To see the pure html, css and javascript that originated this gem, just access this **[codepen](https://codepen.io/eltin182/pen/QWXLaWj)** link.
 
 ## Installation
 
@@ -19,11 +21,19 @@ After run:
 rails generate rails_toastify:install
 ```
 
-This will create a file *config/initializers/rails_toastify.rb* where you can define the framework you want to use:
+This will create a file *config/initializers/rails_toastify.rb* where you can define what configuration you want to use:
 
 ```ruby
-RailsToastify.configure do |config|
-  config.framework = :tailwind # or :bootstrap
+RailsToastify.setup do |configuration|
+  configuration.position = 'toast-container-top-right'
+  configuration.notice_animation = 'bounce' # bounce, slide, flip, zoom 
+  configuration.alert_animation = 'slide' # bounce, slide, flip, zoom
+  configuration.notice_duration = 3000
+  configuration.alert_duration = 3000
+  configuration.notice_theme = 'light' # light, dark
+  configuration.alert_theme = 'light' # light, dark
+  configuration.notice_type = 'default' # default, success, warning, error, info
+  configuration.alert_type = 'error' # default, success, warning, error, info
 end
 ```
 
@@ -32,39 +42,54 @@ end
 In your *application.html.erb* add in your header:
 
 ```ruby
-<%= stylesheet_link_tag 'rails_toastify', media: 'all' %>
-<%= javascript_include_tag 'rails_toastify' %>
+<%= stylesheet_link_tag 'rails_toastify', media: 'all', 'data-turbolinks-track': 'reload' %>
+<%= javascript_include_tag 'rails_toastify', 'data-turbo-track': 'reload' %>
 ```
 And in your body:
 
 ```html
-<div id="toast-container" class="toast-container"></div>
-```
-*
-
-In your *config/manifest.js* add:
-
-```js
-//= link rails_toastify.css
-//= link rails_toastify.js
+<%= rails_toastify_container %>
+<%= rails_toastify_script %>
 ```
-
-And call function `RailsToastify.showToast` any javascript or console:
+And call function `RailsToastify.show` any javascript or console:
 
 ```ruby
-RailsToastify.showToast('This is a success message!', 'success');
-RailsToastify.showToast('This is an error message!', 'error');
-RailsToastify.showToast('This is an info message!', 'info');
-RailsToastify.showToast('This is a warning message!', 'warning');
+RailsToastify.show('This is a message!', { theme: 'light', type: 'default', animation: 'bounce', duration: 3000 });
 ```
 
-To see notice in a toast add:
+To see notice or alert in a toast add this in application.html.erb:
+
+```html 
+<% if notice %>
+  <script>
+    RailsToastify.show('<%= notice %>',
+      { theme: '<%= RailsToastify.configuration.notice_theme %>',
+        type: '<%= RailsToastify.configuration.notice_type %>',
+        animation: '<%= RailsToastify.configuration.notice_animation %>',
+        duration: <%= RailsToastify.configuration.notice_duration %>
+      })
+  </script>
+<% end %>
 
-```ruby 
-<%= javascript_tag do %>
-  RailsToastify.showToast('<%= notice %>', 'success')
+<% if alert %>
+  <script>
+    RailsToastify.show('<%= alert %>',
+      { theme: '<%= RailsToastify.configuration.alert_theme %>',
+        type: '<%= RailsToastify.configuration.alert_type %>',
+        animation: '<%= RailsToastify.configuration.alert_animation %>',
+        duration: <%= RailsToastify.configuration.alert_duration %>
+      })
+  </script>
 <% end %>
 ```
+** Note that toast can be configured for either notice type or alert type. Both types or just one of the types can be used.
+
+## Next steps
+
+- Add tests
+- Add others positions (left, center, bottom)
+- Add fade in and fade out animation
+- In addition to the colors, allow the user to choose any color for the progress bar
 
 ## Requirements
 
@@ -79,4 +104,4 @@ Fork, fix, then send a pull request. Bug reports and pull requests are welcome o
 
 This gem is available as open-source under the terms of The MIT License (MIT).
 
-Copyright (c) 2024 **Elton Santos**. See **MIT-LICENSE** for further details.
+Copyright (c) 2024 **[Elton Santos](https://eltonmelosantos.com.br)**. See **MIT-LICENSE** for further details and see **CHANGELOG** to see what was changed.

data/app/helpers/rails_toastify_helper.rb

@@ -19,11 +19,36 @@ module RailsToastifyHelper
     end
   end
 
-  def show_toast(message, options = {})
-    javascript_tag do
-      <<-JS.html_safe
-        RailsToastify.show(#{message.to_json}, #{options.to_json});
-      JS
+  def rails_toastify_messages
+    output = []
+    if flash[:notice]
+      output << javascript_tag do
+        <<-JS.html_safe
+          document.addEventListener('DOMContentLoaded', function() {
+            RailsToastify.show(#{flash[:notice].to_json}, {
+              animation: '#{RailsToastify.configuration.notice_animation}',
+              duration: #{RailsToastify.configuration.notice_duration},
+              theme: '#{RailsToastify.configuration.notice_theme}',
+              type: '#{RailsToastify.configuration.notice_type}'
+            });
+          });
+        JS
+      end
+    end
+    if flash[:alert]
+      output << javascript_tag do
+        <<-JS.html_safe
+          document.addEventListener('DOMContentLoaded', function() {
+            RailsToastify.show(#{flash[:alert].to_json}, {
+              animation: '#{RailsToastify.configuration.alert_animation}',
+              duration: #{RailsToastify.configuration.alert_duration},
+              theme: '#{RailsToastify.configuration.alert_theme}',
+              type: '#{RailsToastify.configuration.alert_type}'
+            });
+          });
+        JS
+      end
     end
+    safe_join(output)
   end
 end

data/lib/generators/rails_toastify/install/templates/rails_toastify.rb

@@ -1,7 +1,11 @@
 RailsToastify.setup do |configuration|
   configuration.position = 'toast-container-top-right'
-  configuration.animation = 'bounce'
-  configuration.duration = 5000
-  configuration.theme = 'light'
-  configuration.type = 'default'
+  configuration.notice_animation = 'bounce' # bounce, slide, flip, zoom 
+  configuration.alert_animation = 'slide' # bounce, slide, flip, zoom
+  configuration.notice_duration = 3000
+  configuration.alert_duration = 3000
+  configuration.notice_theme = 'light' # light, dark
+  configuration.alert_theme = 'light' # light, dark
+  configuration.notice_type = 'default' # default, success, warning, error, info
+  configuration.alert_type = 'error' # default, success, warning, error, info
 end

data/lib/rails_toastify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsToastify
-  VERSION = "1.1.1"
+  VERSION = "1.2.1"
 end

data/lib/rails_toastify.rb

@@ -14,24 +14,33 @@ module RailsToastify
   end
 
   class Configuration
-    attr_accessor :position, :animation, :duration, :theme, :type
+    attr_accessor :position, :notice_animation, :alert_animation, :notice_duration, :alert_duration,
+    :notice_theme, :alert_theme, :notice_type, :alert_type
 
     def initialize
       @position = 'toast-container-top-right'
-      @animation = 'bounce'
-      @duration = 5000
-      @theme = 'light'
-      @type = 'default'
+      @notice_animation = 'bounce'
+      @alert_animation = 'zoom'
+      @notice_duration = 3000
+      @alert_duration = 3000
+      @notice_theme = 'light'
+      @alert_theme = 'light'
+      @notice_type = 'default'
+      @alert_type = 'error'
     end
 
     def to_h
       {
         position: @position,
-        animation: @animation,
-        duration: @duration,
-        theme: @theme,
-        type: @type
-      }.to_json
+        notice_animation: @notice_animation,
+        alert_animation: @alert_animation,
+        notice_duration: @notice_duration,
+        alert_duration: @alert_duration,
+        notice_theme: @notice_theme,
+        alert_theme: @alert_theme,
+        notice_type: @notice_type,
+        alert_type: @alert_type
+      }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_toastify
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Elton Santos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies: []
 description: "\U0001F389 Rails Toastify allows you to add notifications to your app
   with ease. Pay Attention: this gem still is in development. Please CONTRIBUTE"