No release in over 3 years
Low commit activity in last 3 years
Show or hide dependent fields in forms based on checkboxes, radios and selects.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Project Readme

Simple Form Dependent Fields

Build Status Gem Version Coverage Status

Dependent fields helper for simple_form.

Show or hide dependent fields in forms based on checkboxes, radios and selects.

Installation

Add this line to your application's Gemfile:

gem 'simple_form_dependent_fields'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_form_dependent_fields

Then require the javascript in your application.js (if using Sprockets):

//= require simple_form_dependent_fields

and initialise the plugin like this:

$(document).ready(
  function() {
    $(".simple_form_dependent_fields").SimpleFormDependentFields()
  }
)

Usage

<%= simple_form_for @my_doc do |f| %>
  <%= f.input :doc_type, as: :select, collection: %w[text image video], include_blank: false %>

  <%= f.dependent_fields depends_on_any: { doc_type: 'text' } do %>
    <%= f.input :text %>
    <%= f.input :has_title, as: :boolean %>
  <% end %>

  <%= f.dependent_fields depends_on_all: { doc_type: 'text', has_title: true } do %>
    <%= f.input :title %>
  <% end %>

  <%= f.dependent_fields depends_on_none: { doc_type: 'text' } do %>
    <%= f.input :caption %>
  <% end %>
<% end %>

The dependent_fields helper accepts either of the following options:

depends_on_any: { field: value, other_field: value }
depends_on_all: { field: value, other_field: value }
depends_on_none: { field: value, other_field: value }

Todo

  • Multiple select field

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tomasc/simple_form_dependent_fields. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.