mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
60 lines
2 KiB
Markdown
60 lines
2 KiB
Markdown
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][data] 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][validator]. 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.
|
|
|
|
```javascript
|
|
//= 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.
|
|
|
|
```javascript
|
|
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](MIT-LICENSE).
|
|
|
|
[data]: http://www.w3.org/TR/html5/dom.html#embedding-custom-non-visible-data-with-the-data-*-attributes "Embedding custom non-visible data with the data-* attributes"
|
|
[validator]: http://validator.w3.org/
|
|
[csrf]: http://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html
|