Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.68 KB

README.md

File metadata and controls

81 lines (54 loc) · 2.68 KB
Raw

jquery-rails

jQuery! For Rails! So great.

This gem provides:

  • jQuery 1, 2 and 3
  • the jQuery UJS adapter
  • assert_select_jquery to test jQuery responses in Ruby tests

Versions

Starting with v2.1, the jquery-rails gem follows these version guidelines to provide more control over your app's jQuery version from your Gemfile:

patch version bump = updates to jquery-ujs, jquery-rails, and patch-level updates to jQuery
minor version bump = minor-level updates to jQuery
major version bump = major-level updates to jQuery and updates to Rails which may be backwards-incompatible

See VERSIONS.md to see which versions of jquery-rails bundle which versions of jQuery.

Installation

Add

gem 'jquery-rails'

to your Gemfile.

The jquery and jquery-ujs files will be added to the asset pipeline and available for you to use. If they're not already in app/assets/javascripts/application.js by default, add these lines:

//= require jquery
//= require jquery_ujs

If you are running Rails 5.1 and up, and if you have included //= require rails-ujs, then jquery_ujs is not needed anymore. You can just add:

//= require jquery

If you want to use jQuery 2, you can require jquery2 instead:

//= require jquery2
//= require jquery_ujs

And if you want to use jQuery 3, you can require jquery3:

//= require jquery3
//= require jquery_ujs

For jQuery UI, we recommend the jquery-ui-rails gem, as it includes the jquery-ui css and allows easier customization.

As of v3.0, jquery-rails no longer includes jQuery UI. Use the jquery-ui-rails gem above.

Contributing to jquery-rails

jquery-rails is work of many contributors. You're encouraged to submit pull requests, propose features and discuss issues.

  • If it's an issue pertaining to the jquery-ujs javascript, please report it to the jquery-ujs project.

  • If the jQuery scripts are outdated (i.e. maybe a new version of jquery was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated jQuery scripts.

See CONTRIBUTING.

License

jquery-rails is released under the MIT License.

Acknowledgements

Many thanks are due to all of the jquery-rails contributors. Special thanks to JangoSteve for tirelessly answering questions and accepting patches, and the Rails Core Team for making jquery-rails an official part of Rails 3.1.