jqr-helpers 1.0.1 → 1.0.3

data/Readme.md

@@ -44,6 +44,7 @@ the dialog content from a remote route)
 * `button_to_ajax` - send an Ajax request when a button is clicked
 * `form_tag_ajax` - send an Ajax request when a form is submitted
 * `form_for_ajax` - ditto but using Rails's `form_for` helper
+* `tab_container` - create a tab container.
 
 There are two sets of options that recur throughout the methods here:
 
@@ -113,6 +114,18 @@ this indicates that the dialog should be closed when the request completes
 successfully. This is true by default for forms and false for
 other elements.
 
+## Panel Renderers ##
+
+Tabs (and eventually accordion panes and menus) are rendered using a "panel renderer".
+This allows you to loop through the tabs in an intuitive and concise way.
+
+       <%= tab_container {:collapsible => true}, {:class => 'my-tabs}' do |r| %>
+         <%= r.panel 'Tab 1',  do %>
+           My tab content here
+         <% end %>
+         <%= r.panel 'Tab 2', 'http://www.foobar.com/' %>
+       <% end %>
+
 ## jQuery Events ##
 
 There are two special events triggered by jqr-helpers:

data/app/assets/javascripts/jqr-helpers.js

@@ -18,7 +18,8 @@
 
   // called from dialog button value
   function ujsDialogClose() {
-    $('.ui-dialog-content:visible').dialog('destroy');
+    $('.ui-dialog-content:visible').dialog('destroy')
+        .addClass('ujs-dialog-hidden');
   }
 
   function ujsDialogOpen() {
@@ -50,7 +51,7 @@
     var open = dialogOptions['open'];
     dialogOptions = $.extend(dialogOptions, {
       'close': function() {
-        $(this).dialog('destroy');
+        $(this).dialog('destroy').addClass('ujs-dialog-hidden');
       },
       'open': function() {
         ujsDialogOpen.call(this);
@@ -190,7 +191,9 @@
   }
 
   $(function() {
-    $('.ujs-tab-container', this).tabs({
+    $('.ujs-tab-container', this).each(function() {
+      var options = $(this).data('tab-options');
+      options = $.extend(options, {
       beforeLoad: function(event, ui) {
         if (ui.tab.data('loaded')) {
           event.preventDefault();
@@ -205,6 +208,8 @@
         });
       }
     });
+      $(this).tabs(options);
+    });
 
     if ($().on) { // newer jQueries
       $(document).on('click', '.ujs-dialog', ujsDialogClick);

data/app/assets/stylesheets/jqr-helpers.css

@@ -19,3 +19,7 @@ form.ujs-ajax, form.ujs-ajax div {
 .ui-dialog.no-title .ui-dialog-titlebar {
     display: none;
 }
+
+.ujs-dialog-hidden {
+    display: none;
+}

data/jqr-helpers.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name         = 'jqr-helpers'
   s.require_paths = %w(. lib lib/jqr-helpers)
-  s.version      = '1.0.1'
+  s.version      = '1.0.3'
   s.date         = '2013-11-19'
   s.summary      = 'Helpers to print unobtrusive jQuery-UI tags.'
   s.description  = <<-EOF

data/lib/jqr-helpers/helpers.rb

@@ -1,6 +1,47 @@
 module JqrHelpers
   module Helpers
 
+    # A renderer used for tabs, accordions, etc.
+    class PanelRenderer
+
+      # @return [Array<Hash>]
+      attr_accessor :panels
+
+      def initialize
+        self.panels = []
+      end
+
+      # Render a panel in the parent container. The panel must have either
+      # a URL or a block containing content.
+      # @param title [String]
+      # @param url_or_options [String|Hash] If a URL is given, it will be here
+      #  and the options will be the next parameter. If a block is given,
+      #  this will be the option hash. Options will be passed as is into the
+      #  HTML <li> tag.
+      # @param options [Hash] the options if a URL is given.
+      def panel(title, url_or_options={}, options={}, &block)
+        if url_or_options.is_a?(String)
+          url = url_or_options
+          content = ''
+          id = nil
+        else
+          options = url_or_options
+          content = yield
+          id = (0...8).map { (65 + rand(26)).chr }.join # random string
+          url = '#' + id
+        end
+        options.merge!(:id => id)
+        panels << {
+          :title => title,
+          :url => url,
+          :options => options,
+          :content => content
+        }
+        nil # suppress output
+      end
+
+    end
+
     # Add a link to create a jQuery dialog.
     # If a block is given, dialog_options and html_options are shifted left by
     # 1 and the block is used as the html_content.
@@ -186,6 +227,45 @@ module JqrHelpers
 
     end
 
+    # Print a tab container. This expects a block, which will be passed a
+    # PanelRenderer object. Panels can be local (with content) or remote
+    # (with a URL).
+    # @example
+    #   <%= tab_container {:collapsible => true}, {:class => 'my-tabs}' do |r| %>
+    #     <%= r.panel 'Tab 1',  do %>
+    #       My tab content here
+    #     <% end %>
+    #     <%= r.panel 'Tab 2', 'http://www.foobar.com/' %>
+    #   <% end %>
+    # @param options [Hash] options to pass to the jQuery tabs() method.
+    # @param html_options [Hash] options to pass to the tab container element
+    #   itself.
+    def tab_container(options={}, html_options={}, &block)
+      renderer = PanelRenderer.new
+      capture(renderer, &block)
+      html_options[:class] ||= ''
+      html_options[:class] << ' ujs-tab-container'
+      html_options[:'data-tab-options'] = options.to_json
+      content_tag(:div, html_options) do
+        s = content_tag :ul do
+          s2 = ''
+          renderer.panels.each do |panel|
+            s2 << content_tag(:li) do
+              link_to panel[:title], panel[:url]
+            end
+          end
+          raw s2
+        end
+        s3 = renderer.panels.inject('') do |sum, panel|
+          if panel[:options][:id]
+            sum = sum + content_tag(:div, panel[:content], panel[:options])
+          end
+          sum
+        end
+        s + raw(s3)
+      end
+    end
+
     private
 
     # Process options related to Ajax requests (e.g. button_to_ajax).

data/lib/jqr-helpers/version.rb

@@ -1,5 +1,5 @@
 module JqrHelpers
   module Rails
-    VERSION = '1.0.1'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: jqr-helpers
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Daniel Orner