dependent-fields-rails 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Lion Vollnhals
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+Dependent Fields for Rails
+===========
+
+DependentFields makes it easy to hide or show dependent fields in forms based on select or checkbox values.
+
+
+Installation
+------------
+
+1. Add `gem 'dependent-fields-rails'` to your Gemfile.
+1. Run `bundle install`.
+1. Add `//= require dependent-fields` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
+1. Bind events, for example with jquery:
+
+    $ ->
+        DependentFields.bind()
+
+1. Restart your server and everything should be set up. See Usage below on how to declare your dependent fields in views.
+
+
+Usage
+-------
+
+Dependent Fields may depend on select or checkbox input elements. You have to surround your dependent fields with
+a `div` with class `js-dependent-fields`.
+
+The examples below are written in the slim template language with simple_form. But you can use dependent-fields with every other template language out there.
+
+
+### Depending on a select element
+
+Note the data attributes on the js-dependent-fields div.
+
+    = simple_form_for(@filing) do
+        = f.input :registration_office, collection: ['habm', 'dpma']
+
+        .js-dependent-fields[data-select-id='filing_registration_office' data-option-value='habm']
+            = f.input :language, collection: ['english', 'german']
+
+The language selector will only be shown if the user selects 'habm' in the registration office.
+
+You can also specify multiple option values by seperating them with `|`. For example: `data-option-value='habm|dpma'`
+
+
+### Depending on a checkbox input element
+
+Note the data attributes on the js-dependent-fields div.
+
+    = simple_form_for(@filing) do
+        = f.input :priority_enabled
+
+        .js-dependent-fields[data-checkbox-id='filing_priority_enabled' data-checkbox-value='true']
+          = f.input :priority_date
+          = f.input :priority_filing_nr
+
+The date and filing_nr fields will only be shown if the user checks the priority_enabled field.
+
+
+### Disabling instead of hiding fields
+
+Add `data-method='disable'` to the js-dependent-fields div.
+
+
+

data/lib/assets/javascripts/dependent-fields.js.coffee

@@ -0,0 +1,48 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
+
+
+toggle = ($parent, showOrHide, method, duration) ->
+  if showOrHide
+    if method == 'disable'
+      # use attr instead of prop, because prop does not work with twitter bootstrap button
+      $parent.find('input,textarea,select,button,.btn').removeAttr('disabled')
+      $parent.find('.select2').select2('enable')
+    else
+      $parent.show(duration)
+  else
+    if method == 'disable'
+      # use attr instead of prop, because prop does not work with twitter bootstrap button
+      $parent.find('input,textarea,select,button,.btn').attr('disabled', 'disabled')
+      $parent.find('.select2').select2('disable')
+    else
+      $parent.hide(duration)
+
+showOrHideDependentFields = (duration = 'fast') ->
+  $select = $(this)
+
+  # fields that depend on a select option
+  $(".js-dependent-fields[data-select-id=#{$select.attr('id')}]").each ->
+    $this = $(this)
+    # use attr here instead of data because we do not want jquery to cast the string into js types
+    showOrHide = _.contains($this.attr('data-option-value').split('|'), $select.val())
+    toggle($this, showOrHide, $this.data('method'), duration)
+
+  # fields that depend on a checkbox
+  $(".js-dependent-fields[data-checkbox-id=#{$select.attr('id')}]").each ->
+    $this = $(this)
+    showOrHide = $this.data('checkbox-value') == $select.is(':checked')
+    toggle($this, showOrHide, $this.data('method'), duration)
+
+bind = ->
+  $('select').each _.partial(showOrHideDependentFields, 0)
+  $('select').change showOrHideDependentFields
+
+  $('input[type=checkbox]').each _.partial(showOrHideDependentFields, 0)
+  $('input[type=checkbox]').change showOrHideDependentFields
+
+
+@DependentFields = {
+  bind
+}

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: dependent-fields-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Lion Vollnhals
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: lion@giantmonkey.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/assets/javascripts/dependent-fields.js.coffee
+- README.md
+- MIT-LICENSE
+homepage: https://github.com/vollnhals/dependent-fields-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: DependentFields makes it easy to hide or show dependent fields in forms based
+  on select or checkbox values
+test_files: []