Repository files navigation

This unobtrusive scripting support file is developed for the Ruby on Rails framework, but is not strictly tied to any specific backend. You can drop this into any application to:

• force confirmation dialogs for various actions;
• make non-GET requests from hyperlinks;
• make forms or hyperlinks submit data asynchronously with Ajax;
• have submit buttons become automatically disabled on form submit to prevent double-clicking.

These features are achieved by adding certain"data" attributes to your HTML markup. In Rails, they are added by the framework's template helpers.

Fulldocumentation is on the wiki, including thelist of published Ajax events.

• jQuery 1.8.x or higher;
• HTML5 doctype (optional).

If you don't use HTML5, adding "data" attributes to your HTML4 or XHTML pages might make them failW3C markup validation. However, this shouldn't create any issues for web browsers or other user agents.

For automated installation in Rails, use the "jquery-rails" gem. Place this in your Gemfile:

gem'jquery-rails'

And run:

$ bundle install

Require bothjquery andjquery_ujs into your application.js manifest.

//= require jquery//= require jquery_ujs

Runnpm install --save jquery-ujs to install the jquery-ujs package.

If you're usingwebpacker (introduced inRails 5.1) to manage JavaScript assets, then you can add the jquery-ujs npm package to your project using theyarn CLI.

$ yarn add jquery-ujs

Then, from any of your included files (e.g.app/javascript/packs/application.js, or from a JavaScript file imported by such a pack), you need only import the package for jquery-ujs to be initialized:

import{}from'jquery-ujs'

Runbower install jquery-ujs --save to install the jquery-ujs package.

Require bothjquery andjquery-ujs into your application.js manifest.

//= require jquery//= require jquery-ujs

Followthis wiki to run tests.

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

SeeCONTRIBUTING.

jquery-ujs is released under theMIT License.