f01f2e648d
Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn). |
||
|---|---|---|
| .. | ||
| rails-ujs | ||
| MIT-LICENSE | ||
| rails-ujs.coffee | ||
| 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.
Optional prerequisites
Note that the data attributes this library adds are a feature of HTML5. If you're not targeting HTML5, these attributes may make your HTML to fail validation. However, this shouldn't create any issues for web browsers or other user agents.
Installation
NPM
npm install rails-ujs --save
Yarn
yarn add rails-ujs
Usage
Asset pipeline
In a conventional Rails application that uses the asset pipeline, require rails-ujs in your application.js manifest:
//= require rails-ujs
ES2015+
If you're using the Webpacker gem or some other JavaScript bundler, add the following to your main JS file:
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.