window_rails 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f331da79c09a9e873bd6ea2c1eb4846c093122b
-  data.tar.gz: ed0172253b5f8a9a862d1d45ac58cf56602dfa36
+  metadata.gz: 3c6f0d1045b9c538f13cfd7e7f08f0aa78bff4ef
+  data.tar.gz: 97849f2e5f5509de2c266485d6d5e58eb2d97139
 SHA512:
-  metadata.gz: d08753fe8c4eb51ca41e491a53f94bbc04d7569558ae2a4e7b6241758b4fd77ef27360166cd97efb31745f41aa56bc9882f0f99fde835709de7831c8c53c33b0
-  data.tar.gz: ba14800eb47c170edee74a0610fa6724e182b8d8779e27ae2db1c969ab66f55cf2da8e12abe9288db56bf6527605d60db37d60fab342adb3fe1928e182ce8136
+  metadata.gz: 8573ad195c66b5772126615002e0e26b7e761a380f3559a512155373cb91f29c756d06b3789fa36e3a75659dd9cc8663b11c05055c6a8009cbd66a5938badcec
+  data.tar.gz: 00205fa5c3b818d6cd926bc7a85ae32580ab9320cb79c5e28a7fdee150ca44cf3cf618802e72dae26f606d7b7b43ca68274cab3d35eef6f1d734d5f436a69e89

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.0.4
+* Update loader content
+* Re-hook after AJAX requests to auto-enable additions
+* Provide local context to callback on confirmation
+
 # v1.0.2
 * Support custom callback on confirmation accept
 

data/README.md

@@ -2,11 +2,6 @@
 
 Rails helper for easy to use modals via bootstrap.
 
-## Important note
-
-As of the 1.0 release, window_rails has been re-implemented
-using bootstrap as the core.
-
 ## Requirements
 
 * jQuery
@@ -36,28 +31,305 @@ and then update your application manifests:
 
 ## Basic usage
 
-### Show an alert
+The WindowRails library provides a simple interface to Bootstrap
+based modals from Rails views removing the need for writing JavaScript
+for integration. For simplicity of examples, lets assume the views
+defined below are for JS formatted requests:
+
+### Creating a new window
+
+Create a new window:
+
+```erb
+<%=
+  create_window(
+    :name => 'my_window',
+    :title => 'My window!',
+    :content => 'Important things.'
+  )
+%>
+```
+
+Create a small window:
+
+```erb
+<%=
+  create_window(
+    :name => 'my_window',
+    :title => 'My window!',
+    :size => 'small',
+    :content => 'Important things.'
+  )
+%>
+```
+
+Or create a large window:
+
+```erb
+<%=
+  create_window(
+    :name => 'my_window',
+    :title => 'My window!',
+    :size => 'large',
+    :content => 'Important things.'
+  )
+%>
+```
+
+Perhaps the content is located in a partial:
+
+```erb
+<%=
+  create_window(
+    :name => 'my_window',
+    :title => 'My window!',
+    :size => 'large',
+    :content => render(
+      :partial => 'my_partial',
+      :locals => {
+        :thing1 => @thing1,
+        :thing2 => @thing2
+      }
+    )
+  )
+%>
+```
+
+Include a footer on the window:
+
+```erb
+<%=
+  create_window(
+    :name => 'my_window',
+    :title => 'My window!',
+    :size => 'large',
+    :content => render(
+      :partial => 'my_partial',
+      :locals => {
+        :thing1 => @thing1,
+        :thing2 => @thing2
+      }
+    ),
+    :footer => render(
+      :partial => 'my_footer_partial'
+    )
+  )
+%>
+```
+
+### Close the window
+
+Windows are referenced by name. We can close the
+previously defined `my_window`:
+
+```erb
+<%= close_window('my_window') %>
+```
+
+### Open a closed window
+
+Lets open that window back up:
+
+```erb
+<%= open_window('my_window') %>
+```
+
+Or lets open it and change the title and content:
 
 ```erb
-<%= open_alert_window('This is an alert!') %>
+<%=
+  open_window(
+    'my_window',
+    :title => 'My Updated Window!',
+    :content => 'New content.'
+  )
+%>
 ```
 
-### Close alert
+There's also options we can set:
+
+```erb
+<%=
+  open_window(
+    'my_window',
+    :title => 'My Updated Window!',
+    :content => 'New content.',
+    :esc_close => true,
+    :backdrop => true,
+    :static_backdrop => true
+  )
+%>
+```
+
+### Alert window
+
+#### Open alert window
+
+Need to show an alert? Use the alert window:
+
+```erb
+<%= open_alert_window('This is an important alert!') %>
+```
+
+#### Close alert window
+
+And to close the important alert:
 
 ```erb
 <%= close_alert_window %>
 ```
 
-### Create a new window
+### Information window
+
+#### Open information window
+
+Need to show some information:
+
+```erb
+<%= open_info_window('This is some information') %>
+```
+
+Want to provide a title for the informational window:
+
+```erb
+<%=
+  open_info_window(
+    'This is some information',
+    :title => 'Information!'
+  )
+%>
+```
+
+Or automatically close the window after a set number of seconds:
+
+```erb
+<%=
+  open_info_window(
+    'This is some information',
+    :title => 'Information!',
+    :auto_close => 4
+  )
+%>
+```
+
+#### Close information window
+
+```erb
+<%= close_info_window %>
+```
+
+### Confirmation window
+
+WindowRails provides a confirmation window to allow user
+acceptance prior to running a task. The task can be provided
+as a remote URL that is requested via AJAX, or a local callback
+function. Upon user confirmation, WindowRails will display a
+loading window while the action is processing and a completion
+window once completed.
+
+#### Open a confirmation window
+
+Open a confirmation window before making a remote request:
+
+```erb
+<%=
+  open_confirm_window(
+    'Do this thing?',
+    :url => '/do/thing'
+  )
+%>
+```
+
+Specify the HTTP method for the remote call when doing something
+like a deletion:
+
+```erb
+<%=
+  open_confirm_window(
+    'Delete this thing?',
+    :url => '/delete/thing',
+    :ajax => 'delete'
+  )
+%>
+```
+
+Set title for the loading window:
+
+```erb
+<%=
+  open_confirm_window(
+    'Delete this thing?',
+    :url => '/delete/thing',
+    :ajax => 'delete',
+    :progress => 'Deleting thing'
+  )
+%>
+```
+
+Set content for the completion window:
+
+```erb
+<%=
+  open_confirm_window(
+    'Delete this thing?',
+    :url => '/delete/thing',
+    :ajax => 'delete',
+    :progress => 'Deleting thing',
+    :complete => 'Thing has been deleted!'
+  )
+%>
+```
+
+Use a callback instead of making a remote request:
+
+```erb
+<%=
+  open_confirm_window(
+    'Delete this thing?',
+    :callback => 'my_javascript_callback',
+    :progress => 'Deleting thing',
+    :complete => 'Thing has been deleted!'
+  )
+%>
+```
+
+And the javascript function `my_javascript_callback` will
+be executed.
+
+#### Close the confirmation window
+
+```erb
+<%= close_confirm_window %>
+```
+
+#### Confirmation window via link
+
+The confirmation window can be generated using information defined within
+a link. Using the rails link helper:
 
 ```erb
-<%= create_window(:name => 'my-window', :title => 'My Window!', :content => 'Some Content') %>
+<%=
+  link_to('Thing', do_thing_path,
+    'class' => 'window-rails',
+    'window-rails-url' => do_thing_path,
+    'window-rails-confirm' => 'Do the thing?',
+    'window-rails-title' => 'Thing Doer',
+    'window-rails-ajax' => 'post'
+  )
+%>
 ```
 
-### Close window
+Or use a callback:
 
 ```erb
-<%= close_window('my-window') %>
+<%=
+  link_to('Thing', do_thing_path,
+    'class' => 'window-rails',
+    'window-rails-callback' => 'my_javascript_function',
+    'window-rails-confirm' => 'Do the thing?',
+    'window-rails-title' => 'Thing Doer',
+  )
+%>
 ```
 
 ## Infos

data/app/assets/javascripts/window_rails/base.js

@@ -207,7 +207,7 @@ window_rails.confirm.execute = function(){
   } else if(args.url) {
     document.location = args.url;
   } else if(args.callback) {
-    window[args.callback]();
+    window[args.callback](args.element);
   }
 }
 
@@ -233,7 +233,7 @@ window_rails.loading.open = function(style, title){
   if(style == 'progress'){
     content = '<div class="progress progress-striped active look-busy"><div class="progress-bar progress-bar-info" aria-valuemax="100" aria-valuemin="0" aria-valuenow="5" role="progressbar" style="width: 5%"></div></div>';
   } else {
-    content = '<div style="height: 50px" class="' + style + ' csspinner no-overlay standard" />';
+    content = '<center><i class="fa fa-spinner fa-4x fa-pulse" /></center>';
   }
   window_rails.open_window('loading', {
     esc_close: false,
@@ -307,9 +307,11 @@ window_rails.initialize_window = function(args){
   }
   name = window_rails.namer(args.name);
   if(args.size == 'large'){
-    size = 'lg';
+    size = 'modal-lg';
+  } else if(args.size == 'small'){
+    size = 'modal-sm';
   } else {
-    size = window_rails.config('default_size', 'sm');
+    size = window_rails.config('default_size', '');
   }
   if(args.footer){
     footer = '\
@@ -322,7 +324,7 @@ window_rails.initialize_window = function(args){
   }
   $('#window-rails-container').append('\
     <div id="' + name + '" class="modal fade" role="modal" aria-labelledby="' + name + '" aria-hidden="true">\
-      <div class="modal-dialog modal-' + size + '">\
+      <div class="modal-dialog ' + size + '">\
         <div class="modal-content">\
           <div class="modal-header">\
             <button class="close" type="button" data-dismiss="modal" aria-hidden="true">\
@@ -400,7 +402,7 @@ window_rails.init = function(){
                 <b class="modal-title">Loading...</b>\
               </div>\
               <div class="modal-body">\
-                <div style="height: 50px" class="csspinner no-overlay standard" />\
+                <center><i class="fa fa-spinner fa-4x fa-pulse" /></center>\
               </div>\
             </div>\
           </div>\
@@ -424,8 +426,10 @@ window_rails.hooks.open_window = function(){
     progress: $(this).attr('window-rails-progress'),
     complete: $(this).attr('window-rails-complete'),
     error: $(this).attr('window-rails-error'),
-    callback: $(this).attr('window-rails-callback')
+    callback: $(this).attr('window-rails-callback'),
+    element: $(this)
   });
+  return false;
 }
 
 /**
@@ -458,4 +462,6 @@ window_rails.hooks.init_links = function(dom_filter){
 }
 
 // Initialize once page has loaded
-$(document).ready(window_rails.init);
+$(document).ready(window_rails.init);
+$(document).on('page:load', window_rails.init);
+$(document).ajaxComplete(window_rails.hooks.init);

data/lib/window_rails/version.rb

@@ -1,4 +1,4 @@
 module WindowRails
   # Current library version
-  VERSION = Gem::Version.new('1.0.2')
+  VERSION = Gem::Version.new('1.0.4')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: window_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails