opal-bootbox 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49a5f706d7b1498f3f402603b2fc28cc38640032
-  data.tar.gz: 5ec45755993176d6e3429991400309aca9003c4a
+  metadata.gz: e03c9979426124d97ba07e3a8b82903a5ad69663
+  data.tar.gz: 61ee41675725fa420a64c941ec858089353fbede
 SHA512:
-  metadata.gz: fa05abc60e1ca252f3332af4ec573c684ea9e55c3d0eeb0463e7dd1eec91450b585f08f973fe0355d61c96f7251c79089a821a23e8c4b24ce7d3a72a8ee86e1e
-  data.tar.gz: 607575582805561cd6e3f7d15e4e3c642ad28eb7bc32cdf52ea228acb41921ac36b0ba0a90a02d50aa350d79f0a5b28af48760138fe9b635272de678c98e1dfa
+  metadata.gz: a730c039e1d02632a913d5bca56df884c6d77f9683b763fc4907a199271bb1972a78e3b68b5af37f594c77b41afb2c45e82b33c28d6a17433a28a187b38e1afe
+  data.tar.gz: 0a8c01ffc9b5e71e2271a0cf515572332b1020c2ba2412d1f53690f4a69f70bc819aba298273d0db6a0a9827384713bd6c132e443efee784640345958ed89a03

data/README.md

@@ -42,10 +42,22 @@ require 'opal'
 require 'opal-bootbox'
 ```
 
-> You need to bring your own `bootbox.js` or `bootbox.min.js` and bootstrap files.
->> http://bootboxjs.com/download/
->> http://getbootstrap.com/getting-started/#download
-> and put the files in `app/` or whichever directory you are compiling assets from.
+You need to bring your own `bootbox.js` or `bootbox.min.js` and bootstrap files
+
+* http://bootboxjs.com/download/
+* http://getbootstrap.com/getting-started/#download
+
+and put the files in `app/` or whichever directory you are compiling assets from.
+
+The Opal/Ruby interface is largely consistent with the Javascript interface.
+ 
+See http://bootboxjs.com/documentation.html for Javascript library documentation.
+
+Where a method expects a single callback substitute a block for the JS function.
+  
+The value for a `callback:` keyword argument should be a Ruby proc.
+
+Keyword arguments should preserve the JS camelcase (e.g. className:).
 
 ### Examples
 
@@ -53,19 +65,35 @@ require 'opal-bootbox'
 $bootbox.alert('Hello world!') do
   puts 'hello world acknowledged'
 end
+```
 
-$bootbox.alert(title: 'Alert dialog', message: 'Hello world!') do
-  puts 'hello world acknowledged'
-end
+```
+$bootbox.alert(
+  size: 'small', 
+  title: 'Alert', 
+  message: 'Hello world!', 
+  callback: -> {puts 'hello world acknowledged'}
+)
+```
 
+```
 $bootbox.confirm('Are you sure?') do |result|
   puts "user is #{result ? 'sure' : 'unsure'}"
 end
+```
 
-$bootbox.confirm(title: 'Confirmation dialog', message: Are you sure?') do |result|
-  puts "user is #{result ? 'sure' : 'unsure'}"
+```
+$bootbox.confirm(
+  size: 'small', 
+  title: 'Confirmation', 
+  message: 'Are you sure?'
+  callback: ->(result) {
+    puts "user is #{result ? 'sure' : 'unsure'}"
+  }
 end
+```
 
+```
 $bootbox.prompt('What is your name?') do |result|
   if result 
     puts "user's name is '#{result}'"
@@ -73,26 +101,94 @@ $bootbox.prompt('What is your name?') do |result|
     puts "prompt dismissed"
   end  
 end
+```
 
-$bootbox.prompt(title: 'Prompt dialog', message: 'What is your name?', value: 'default name') do |result|
-  if result 
-    puts "user's name is '#{result}'"
-  else
-    puts "prompt dismissed"
-  end  
-end
+```
+$bootbox.prompt(
+  size: 'small', 
+  title: 'Prompt', 
+  message: 'What is your name?', 
+  value: 'default name'),
+  callback: ->(result) {
+    if result 
+      puts "user's name is '#{result}'"
+    else
+      puts "prompt dismissed"
+  } 
+)
+```
 
 ```
+$bootbox.dialog(
+  # required
+  message: "I am a custom dialog",
+  
+  # optional - adds a header to the dialog and places this text in an h4 
+  title: "Custom title",
+
+  # optional - allows the user to dismiss the dialog by hitting ESC
+  # which will call this proc 
+  onEscape: -> { puts 'user press escape' },
+  
+  # optional - whether the dialog should be shown immediately
+  show: true,
+  
+  # optional - whether the dialog should be have a backdrop or not
+  backdrop: true,
+
+  # optional - whether to show a close button (default true)
+  closeButton: true,
+  
+  # optional - whether to animate (default true)
+  animate: true,
+  
+  # optional - an additional CSS class to apply to the Bootstrap dialog wrapper
+  className: "my-modal",
+  
+  # optional - a hash of buttons to be shown in the dialog's footer
+  buttons: {
+    
+    success: {
+      # optional - the button label    
+      label: "Success!",
+
+      # optional - an additional CSS class to apply to the button
+      className: "btn-success",
+      
+      # optional - call proc when button is clicked
+      callback: -> { puts 'success!' }
+    },
+    
+    "Danger!": {
+      # no label is provided so the key is used as the button label
+
+      # optional - an additional CSS class to apply to the button
+      className: "btn-danger",
+      
+      callback: -> { puts 'danger!' }
+    },
+
+    # if the only value supplied is a callback proc, 
+    # the key is used as the button label and all
+    # other options are defaulted
+
+    "Warning!": -> { puts 'warning!}
+  }
+)
+```
+
 
 `$bootbox` is a global variable. `Opal::Bootbox` may be substituted. 
 
 Strings (text) provided as arguments to bootbox methods may be HTML format.
 
+All methods are executed asynchronously, hence the use of callback blocks and procs. 
+
 ## To do
 
-* Implement Bootbox custom dialog options. 
 * Documentation
 * Testing
+* snake case keywords ?
 
 ## Getting involved
 

data/lib/opal/bootbox/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Bootbox
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/opal/bootbox.rb

@@ -7,12 +7,20 @@ if RUBY_ENGINE == 'opal'
 
 require 'native'
 
+# see http://bootboxjs.com/documentation.html
+
 module Opal
   module Bootbox
     module_function
 
     def bootbox_call(method, *args, &block)
-      Native.call(`bootbox`, method, *args, &block)
+      arg = args.first
+      if arg.is_a?(Hash) && arg[:callback].nil?
+        arg[:callback] = block
+        Native.call(`bootbox`, method, arg.to_n)
+      else
+        Native.call(`bootbox`, method, arg.to_n, &block)
+      end
     end
 
     # Creates an alert window.
@@ -37,6 +45,14 @@ module Opal
       bootbox_call(__method__, *args, &block)
     end
 
+    # Creates a custom dialog window.
+    # Method executes asynchronously.
+    # The result passed to given block is a String or nil.
+    # see http://bootboxjs.com/examples.html
+    def dialog(*args, &block)
+      bootbox_call(__method__, *args, &block)
+    end
+
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-bootbox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Colin Gunn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal