History

Jon Moss 48f2a0c566 Grammar fixes [ci skip]		2017-05-29 19:33:44 -04:00
..
rails-ujs	Merge pull request #29151 from onemanstartup/jquery_slim_fix	2017-05-29 13:37:53 -05:00
MIT-LICENSE	Move rails-ujs README and LICENCE to actionview	2017-02-22 13:49:27 -05:00
README.md	Grammar fixes	2017-05-29 19:33:44 -04:00
rails-ujs.coffee	Reorganize rails-ujs files	2017-03-30 14:41:17 -04:00

README.md

Ruby on Rails unobtrusive scripting adapter.

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.

Requirements

HTML5 doctype (optional).

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

Installation using npm

Run npm install rails-ujs --save to install the rails-ujs package.

Installation using Yarn

Run yarn add rails-ujs to install the rails-ujs package.

Usage

Require rails-ujs in your application.js manifest.

//= require rails-ujs

Usage with yarn

When using with the Webpacker gem or your preferred JavaScript bundler, just add the following to your main JS file and compile.

import Rails from 'rails-ujs';
Rails.start()

How to run tests

Run bundle exec rake ujs:server first, and then run the web tests by visiting http://localhost:4567 in your browser.

License

rails-ujs is released under the MIT License.